CassandraClustersOperations interface

Package:

@azure/arm-cosmosdb

Interface representing a CassandraClusters operations.

Properties

beginCreateUpdate
beginCreateUpdateAndWait
beginDeallocate
beginDeallocateAndWait
beginDelete
beginDeleteAndWait
beginInvokeCommand
beginInvokeCommandAndWait
beginInvokeCommandAsync
beginInvokeCommandAsyncAndWait
beginStart
beginStartAndWait
beginUpdate
beginUpdateAndWait
createUpdate	Create or update a managed Cassandra cluster. When updating, you must specify all writable properties. To update only some properties, use PATCH.
deallocate	Deallocate the Managed Cassandra Cluster and Associated Data Centers. Deallocation will deallocate the host virtual machine of this cluster, and reserved the data disk. This won't do anything on an already deallocated cluster. Use Start to restart the cluster.
delete
get	Get the properties of a managed Cassandra cluster.
getBackup	Get the properties of an individual backup of this cluster that is available to restore.
getCommandAsync	Get details about a specified command that was run asynchronously.
invokeCommand	Invoke a command like nodetool for cassandra maintenance
invokeCommandAsync	Invoke a command like nodetool for cassandra maintenance asynchronously
listBackups	List the backups of this cluster that are available to restore.
listByResourceGroup	List all managed Cassandra clusters in this resource group.
listBySubscription	List all managed Cassandra clusters in this subscription.
listCommand	List all commands currently running on ring info
start	Start the Managed Cassandra Cluster and Associated Data Centers. Start will start the host virtual machine of this cluster with reserved data disk. This won't do anything on an already running cluster. Use Deallocate to deallocate the cluster.
status	Gets the CPU, memory, and disk usage statistics for each Cassandra node in a cluster.
update	Updates some of the properties of a managed Cassandra cluster.

Property Details

beginCreateUpdate

Warning

This API is now deprecated.

use createUpdate instead

beginCreateUpdate: (resourceGroupName: string, clusterName: string, body: ClusterResource, options?: CassandraClustersCreateUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<ClusterResource>, ClusterResource>>

Property Value

(resourceGroupName: string, clusterName: string, body: ClusterResource, options?: CassandraClustersCreateUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<ClusterResource>, ClusterResource>>

beginCreateUpdateAndWait

Warning

This API is now deprecated.

use createUpdate instead

beginCreateUpdateAndWait: (resourceGroupName: string, clusterName: string, body: ClusterResource, options?: CassandraClustersCreateUpdateOptionalParams) => Promise<ClusterResource>

Property Value

(resourceGroupName: string, clusterName: string, body: ClusterResource, options?: CassandraClustersCreateUpdateOptionalParams) => Promise<ClusterResource>

beginDeallocate

Warning

This API is now deprecated.

use deallocate instead

beginDeallocate: (resourceGroupName: string, clusterName: string, options?: CassandraClustersDeallocateOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, clusterName: string, options?: CassandraClustersDeallocateOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeallocateAndWait

Warning

This API is now deprecated.

use deallocate instead

beginDeallocateAndWait: (resourceGroupName: string, clusterName: string, options?: CassandraClustersDeallocateOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, clusterName: string, options?: CassandraClustersDeallocateOptionalParams) => Promise<void>

beginDelete

Warning

This API is now deprecated.

use delete instead

beginDelete: (resourceGroupName: string, clusterName: string, options?: CassandraClustersDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, clusterName: string, options?: CassandraClustersDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

beginDeleteAndWait: (resourceGroupName: string, clusterName: string, options?: CassandraClustersDeleteOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, clusterName: string, options?: CassandraClustersDeleteOptionalParams) => Promise<void>

beginInvokeCommand

Warning

This API is now deprecated.

use invokeCommand instead

beginInvokeCommand: (resourceGroupName: string, clusterName: string, body: CommandPostBody, options?: CassandraClustersInvokeCommandOptionalParams) => Promise<SimplePollerLike<OperationState<CommandOutput>, CommandOutput>>

Property Value

(resourceGroupName: string, clusterName: string, body: CommandPostBody, options?: CassandraClustersInvokeCommandOptionalParams) => Promise<SimplePollerLike<OperationState<CommandOutput>, CommandOutput>>

beginInvokeCommandAndWait

Warning

This API is now deprecated.

use invokeCommand instead

beginInvokeCommandAndWait: (resourceGroupName: string, clusterName: string, body: CommandPostBody, options?: CassandraClustersInvokeCommandOptionalParams) => Promise<CommandOutput>

Property Value

(resourceGroupName: string, clusterName: string, body: CommandPostBody, options?: CassandraClustersInvokeCommandOptionalParams) => Promise<CommandOutput>

beginInvokeCommandAsync

Warning

This API is now deprecated.

use invokeCommandAsync instead

beginInvokeCommandAsync: (resourceGroupName: string, clusterName: string, body: CommandAsyncPostBody, options?: CassandraClustersInvokeCommandAsyncOptionalParams) => Promise<SimplePollerLike<OperationState<CommandPublicResource>, CommandPublicResource>>

Property Value

(resourceGroupName: string, clusterName: string, body: CommandAsyncPostBody, options?: CassandraClustersInvokeCommandAsyncOptionalParams) => Promise<SimplePollerLike<OperationState<CommandPublicResource>, CommandPublicResource>>

beginInvokeCommandAsyncAndWait

Warning

This API is now deprecated.

use invokeCommandAsync instead

beginInvokeCommandAsyncAndWait: (resourceGroupName: string, clusterName: string, body: CommandAsyncPostBody, options?: CassandraClustersInvokeCommandAsyncOptionalParams) => Promise<CommandPublicResource>

Property Value

(resourceGroupName: string, clusterName: string, body: CommandAsyncPostBody, options?: CassandraClustersInvokeCommandAsyncOptionalParams) => Promise<CommandPublicResource>

beginStart

Warning

This API is now deprecated.

use start instead

beginStart: (resourceGroupName: string, clusterName: string, options?: CassandraClustersStartOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, clusterName: string, options?: CassandraClustersStartOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginStartAndWait

Warning

This API is now deprecated.

use start instead

beginStartAndWait: (resourceGroupName: string, clusterName: string, options?: CassandraClustersStartOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, clusterName: string, options?: CassandraClustersStartOptionalParams) => Promise<void>

beginUpdate

Warning

This API is now deprecated.

use update instead

beginUpdate: (resourceGroupName: string, clusterName: string, body: ClusterResource, options?: CassandraClustersUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<ClusterResource>, ClusterResource>>

Property Value

(resourceGroupName: string, clusterName: string, body: ClusterResource, options?: CassandraClustersUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<ClusterResource>, ClusterResource>>

beginUpdateAndWait

Warning

This API is now deprecated.

use update instead

beginUpdateAndWait: (resourceGroupName: string, clusterName: string, body: ClusterResource, options?: CassandraClustersUpdateOptionalParams) => Promise<ClusterResource>

Property Value

(resourceGroupName: string, clusterName: string, body: ClusterResource, options?: CassandraClustersUpdateOptionalParams) => Promise<ClusterResource>

createUpdate

Create or update a managed Cassandra cluster. When updating, you must specify all writable properties. To update only some properties, use PATCH.

createUpdate: (resourceGroupName: string, clusterName: string, body: ClusterResource, options?: CassandraClustersCreateUpdateOptionalParams) => PollerLike<OperationState<ClusterResource>, ClusterResource>

Property Value

(resourceGroupName: string, clusterName: string, body: ClusterResource, options?: CassandraClustersCreateUpdateOptionalParams) => PollerLike<OperationState<ClusterResource>, ClusterResource>

deallocate

Deallocate the Managed Cassandra Cluster and Associated Data Centers. Deallocation will deallocate the host virtual machine of this cluster, and reserved the data disk. This won't do anything on an already deallocated cluster. Use Start to restart the cluster.

deallocate: (resourceGroupName: string, clusterName: string, options?: CassandraClustersDeallocateOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, clusterName: string, options?: CassandraClustersDeallocateOptionalParams) => PollerLike<OperationState<void>, void>

delete

delete: (resourceGroupName: string, clusterName: string, options?: CassandraClustersDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, clusterName: string, options?: CassandraClustersDeleteOptionalParams) => PollerLike<OperationState<void>, void>

get

Get the properties of a managed Cassandra cluster.

get: (resourceGroupName: string, clusterName: string, options?: CassandraClustersGetOptionalParams) => Promise<ClusterResource>

Property Value

(resourceGroupName: string, clusterName: string, options?: CassandraClustersGetOptionalParams) => Promise<ClusterResource>

getBackup

Get the properties of an individual backup of this cluster that is available to restore.

getBackup: (resourceGroupName: string, clusterName: string, backupId: string, options?: CassandraClustersGetBackupOptionalParams) => Promise<BackupResource>

Property Value

(resourceGroupName: string, clusterName: string, backupId: string, options?: CassandraClustersGetBackupOptionalParams) => Promise<BackupResource>

getCommandAsync

Get details about a specified command that was run asynchronously.

getCommandAsync: (resourceGroupName: string, clusterName: string, commandId: string, options?: CassandraClustersGetCommandAsyncOptionalParams) => Promise<CommandPublicResource>

Property Value

(resourceGroupName: string, clusterName: string, commandId: string, options?: CassandraClustersGetCommandAsyncOptionalParams) => Promise<CommandPublicResource>

invokeCommand

Invoke a command like nodetool for cassandra maintenance

invokeCommand: (resourceGroupName: string, clusterName: string, body: CommandPostBody, options?: CassandraClustersInvokeCommandOptionalParams) => PollerLike<OperationState<CommandOutput>, CommandOutput>

Property Value

(resourceGroupName: string, clusterName: string, body: CommandPostBody, options?: CassandraClustersInvokeCommandOptionalParams) => PollerLike<OperationState<CommandOutput>, CommandOutput>

invokeCommandAsync

Invoke a command like nodetool for cassandra maintenance asynchronously

invokeCommandAsync: (resourceGroupName: string, clusterName: string, body: CommandAsyncPostBody, options?: CassandraClustersInvokeCommandAsyncOptionalParams) => PollerLike<OperationState<CommandPublicResource>, CommandPublicResource>

Property Value

(resourceGroupName: string, clusterName: string, body: CommandAsyncPostBody, options?: CassandraClustersInvokeCommandAsyncOptionalParams) => PollerLike<OperationState<CommandPublicResource>, CommandPublicResource>

listBackups

List the backups of this cluster that are available to restore.

listBackups: (resourceGroupName: string, clusterName: string, options?: CassandraClustersListBackupsOptionalParams) => PagedAsyncIterableIterator<BackupResource, BackupResource[], PageSettings>

Property Value

(resourceGroupName: string, clusterName: string, options?: CassandraClustersListBackupsOptionalParams) => PagedAsyncIterableIterator<BackupResource, BackupResource[], PageSettings>

listByResourceGroup

List all managed Cassandra clusters in this resource group.

listByResourceGroup: (resourceGroupName: string, options?: CassandraClustersListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<ClusterResource, ClusterResource[], PageSettings>

Property Value

(resourceGroupName: string, options?: CassandraClustersListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<ClusterResource, ClusterResource[], PageSettings>

listBySubscription

List all managed Cassandra clusters in this subscription.

listBySubscription: (options?: CassandraClustersListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<ClusterResource, ClusterResource[], PageSettings>

Property Value

(options?: CassandraClustersListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<ClusterResource, ClusterResource[], PageSettings>

listCommand

List all commands currently running on ring info

listCommand: (resourceGroupName: string, clusterName: string, options?: CassandraClustersListCommandOptionalParams) => PagedAsyncIterableIterator<CommandPublicResource, CommandPublicResource[], PageSettings>

Property Value

(resourceGroupName: string, clusterName: string, options?: CassandraClustersListCommandOptionalParams) => PagedAsyncIterableIterator<CommandPublicResource, CommandPublicResource[], PageSettings>

start

Start the Managed Cassandra Cluster and Associated Data Centers. Start will start the host virtual machine of this cluster with reserved data disk. This won't do anything on an already running cluster. Use Deallocate to deallocate the cluster.

start: (resourceGroupName: string, clusterName: string, options?: CassandraClustersStartOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, clusterName: string, options?: CassandraClustersStartOptionalParams) => PollerLike<OperationState<void>, void>

status

Gets the CPU, memory, and disk usage statistics for each Cassandra node in a cluster.

status: (resourceGroupName: string, clusterName: string, options?: CassandraClustersStatusOptionalParams) => Promise<CassandraClusterPublicStatus>

Property Value

(resourceGroupName: string, clusterName: string, options?: CassandraClustersStatusOptionalParams) => Promise<CassandraClusterPublicStatus>

update

Updates some of the properties of a managed Cassandra cluster.

update: (resourceGroupName: string, clusterName: string, body: ClusterResource, options?: CassandraClustersUpdateOptionalParams) => PollerLike<OperationState<ClusterResource>, ClusterResource>

Property Value

(resourceGroupName: string, clusterName: string, body: ClusterResource, options?: CassandraClustersUpdateOptionalParams) => PollerLike<OperationState<ClusterResource>, ClusterResource>