CassandraClusters | @azure/arm-cosmosdb

Interface representing a CassandraClusters.

Hierarchy

CassandraClusters

Implemented by

CassandraClustersImpl

Index

Methods

beginCreateUpdate

beginCreateUpdate(resourceGroupName: string, clusterName: string, body: ClusterResource, options?: CassandraClustersCreateUpdateOptionalParams): Promise<PollerLike<PollOperationState<CassandraClustersCreateUpdateResponse>, CassandraClustersCreateUpdateResponse>>

- Defined in operationsInterfaces/cassandraClusters.ts:106
Create or update a managed Cassandra cluster. When updating, you must specify all writable properties. To update only some properties, use PATCH.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- clusterName: string
  
  Managed Cassandra cluster name.
- body: ClusterResource
  
  The properties specifying the desired state of the managed Cassandra cluster.
- Optional options: CassandraClustersCreateUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<CassandraClustersCreateUpdateResponse>, CassandraClustersCreateUpdateResponse>>

beginCreateUpdateAndWait

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

- Defined in operationsInterfaces/cassandraClusters.ts:125
Create or update a managed Cassandra cluster. When updating, you must specify all writable properties. To update only some properties, use PATCH.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- clusterName: string
  
  Managed Cassandra cluster name.
- body: ClusterResource
  
  The properties specifying the desired state of the managed Cassandra cluster.
- Optional options: CassandraClustersCreateUpdateOptionalParams
  
  The options parameters.
Returns Promise<CassandraClustersCreateUpdateResponse>

beginDeallocate

beginDeallocate(resourceGroupName: string, clusterName: string, options?: CassandraClustersDeallocateOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

- Defined in operationsInterfaces/cassandraClusters.ts:214
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.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- clusterName: string
  
  Managed Cassandra cluster name.
- Optional options: CassandraClustersDeallocateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeallocateAndWait

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

- Defined in operationsInterfaces/cassandraClusters.ts:227
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.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- clusterName: string
  
  Managed Cassandra cluster name.
- Optional options: CassandraClustersDeallocateOptionalParams
  
  The options parameters.
Returns Promise<void>

beginDelete

beginDelete(resourceGroupName: string, clusterName: string, options?: CassandraClustersDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

- Defined in operationsInterfaces/cassandraClusters.ts:82
Deletes a managed Cassandra cluster.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- clusterName: string
  
  Managed Cassandra cluster name.
- Optional options: CassandraClustersDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

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

- Defined in operationsInterfaces/cassandraClusters.ts:93
Deletes a managed Cassandra cluster.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- clusterName: string
  
  Managed Cassandra cluster name.
- Optional options: CassandraClustersDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

beginInvokeCommand

beginInvokeCommand(resourceGroupName: string, clusterName: string, body: CommandPostBody, options?: CassandraClustersInvokeCommandOptionalParams): Promise<PollerLike<PollOperationState<CassandraClustersInvokeCommandResponse>, CassandraClustersInvokeCommandResponse>>

- Defined in operationsInterfaces/cassandraClusters.ts:169
Invoke a command like nodetool for cassandra maintenance

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- clusterName: string
  
  Managed Cassandra cluster name.
- body: CommandPostBody
  
  Specification which command to run where
- Optional options: CassandraClustersInvokeCommandOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<CassandraClustersInvokeCommandResponse>, CassandraClustersInvokeCommandResponse>>

beginInvokeCommandAndWait

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

- Defined in operationsInterfaces/cassandraClusters.ts:187
Invoke a command like nodetool for cassandra maintenance

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- clusterName: string
  
  Managed Cassandra cluster name.
- body: CommandPostBody
  
  Specification which command to run where
- Optional options: CassandraClustersInvokeCommandOptionalParams
  
  The options parameters.
Returns Promise<CassandraClustersInvokeCommandResponse>

beginStart

beginStart(resourceGroupName: string, clusterName: string, options?: CassandraClustersStartOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

- Defined in operationsInterfaces/cassandraClusters.ts:240
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.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- clusterName: string
  
  Managed Cassandra cluster name.
- Optional options: CassandraClustersStartOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginStartAndWait

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

- Defined in operationsInterfaces/cassandraClusters.ts:253
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.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- clusterName: string
  
  Managed Cassandra cluster name.
- Optional options: CassandraClustersStartOptionalParams
  
  The options parameters.
Returns Promise<void>

beginUpdate

beginUpdate(resourceGroupName: string, clusterName: string, body: ClusterResource, options?: CassandraClustersUpdateOptionalParams): Promise<PollerLike<PollOperationState<CassandraClustersUpdateResponse>, CassandraClustersUpdateResponse>>

- Defined in operationsInterfaces/cassandraClusters.ts:138
Updates some of the properties of a managed Cassandra cluster.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- clusterName: string
  
  Managed Cassandra cluster name.
- body: ClusterResource
  
  Parameters to provide for specifying the managed Cassandra cluster.
- Optional options: CassandraClustersUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<CassandraClustersUpdateResponse>, CassandraClustersUpdateResponse>>

beginUpdateAndWait

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

- Defined in operationsInterfaces/cassandraClusters.ts:156
Updates some of the properties of a managed Cassandra cluster.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- clusterName: string
  
  Managed Cassandra cluster name.
- body: ClusterResource
  
  Parameters to provide for specifying the managed Cassandra cluster.
- Optional options: CassandraClustersUpdateOptionalParams
  
  The options parameters.
Returns Promise<CassandraClustersUpdateResponse>

get

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

- Defined in operationsInterfaces/cassandraClusters.ts:71
Get the properties of a managed Cassandra cluster.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- clusterName: string
  
  Managed Cassandra cluster name.
- Optional options: CassandraClustersGetOptionalParams
  
  The options parameters.
Returns Promise<CassandraClustersGetResponse>

getBackup

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

- Defined in operationsInterfaces/cassandraClusters.ts:200
Get the properties of an individual backup of this cluster that is available to restore.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- clusterName: string
  
  Managed Cassandra cluster name.
- backupId: string
  
  Id of a restorable backup of a Cassandra cluster.
- Optional options: CassandraClustersGetBackupOptionalParams
  
  The options parameters.
Returns Promise<CassandraClustersGetBackupResponse>

listBackups

listBackups(resourceGroupName: string, clusterName: string, options?: CassandraClustersListBackupsOptionalParams): PagedAsyncIterableIterator<BackupResource>

- Defined in operationsInterfaces/cassandraClusters.ts:60
List the backups of this cluster that are available to restore.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- clusterName: string
  
  Managed Cassandra cluster name.
- Optional options: CassandraClustersListBackupsOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<BackupResource>

listByResourceGroup

listByResourceGroup(resourceGroupName: string, options?: CassandraClustersListByResourceGroupOptionalParams): PagedAsyncIterableIterator<ClusterResource>

- Defined in operationsInterfaces/cassandraClusters.ts:50
List all managed Cassandra clusters in this resource group.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- Optional options: CassandraClustersListByResourceGroupOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<ClusterResource>

listBySubscription

listBySubscription(options?: CassandraClustersListBySubscriptionOptionalParams): PagedAsyncIterableIterator<ClusterResource>

- Defined in operationsInterfaces/cassandraClusters.ts:42
List all managed Cassandra clusters in this subscription.

Parameters
- Optional options: CassandraClustersListBySubscriptionOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<ClusterResource>

status

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

- Defined in operationsInterfaces/cassandraClusters.ts:264
Gets the CPU, memory, and disk usage statistics for each Cassandra node in a cluster.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- clusterName: string
  
  Managed Cassandra cluster name.
- Optional options: CassandraClustersStatusOptionalParams
  
  The options parameters.
Returns Promise<CassandraClustersStatusResponse>

Hierarchy

Implemented by

Index

Methods

Methods

beginCreateUpdate

Parameters

resourceGroupName: string

clusterName: string

body: ClusterResource

Optional options: CassandraClustersCreateUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<CassandraClustersCreateUpdateResponse>, CassandraClustersCreateUpdateResponse>>

beginCreateUpdateAndWait

Parameters

resourceGroupName: string

clusterName: string

body: ClusterResource

Optional options: CassandraClustersCreateUpdateOptionalParams

Returns Promise<CassandraClustersCreateUpdateResponse>

beginDeallocate

Parameters

resourceGroupName: string

clusterName: string

Optional options: CassandraClustersDeallocateOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeallocateAndWait

Parameters

resourceGroupName: string

clusterName: string

Optional options: CassandraClustersDeallocateOptionalParams

Returns Promise<void>

beginDelete

Parameters

resourceGroupName: string

clusterName: string

Optional options: CassandraClustersDeleteOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

Parameters

resourceGroupName: string

clusterName: string

Optional options: CassandraClustersDeleteOptionalParams

Returns Promise<void>

beginInvokeCommand

Parameters

resourceGroupName: string

clusterName: string

body: CommandPostBody

Optional options: CassandraClustersInvokeCommandOptionalParams

Returns Promise<PollerLike<PollOperationState<CassandraClustersInvokeCommandResponse>, CassandraClustersInvokeCommandResponse>>

beginInvokeCommandAndWait

Parameters

resourceGroupName: string

clusterName: string

body: CommandPostBody

Optional options: CassandraClustersInvokeCommandOptionalParams

Returns Promise<CassandraClustersInvokeCommandResponse>

beginStart

Parameters

resourceGroupName: string

clusterName: string

Optional options: CassandraClustersStartOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginStartAndWait

Parameters

resourceGroupName: string

clusterName: string

Optional options: CassandraClustersStartOptionalParams

Returns Promise<void>

beginUpdate

Parameters

resourceGroupName: string

clusterName: string

body: ClusterResource

Optional options: CassandraClustersUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<CassandraClustersUpdateResponse>, CassandraClustersUpdateResponse>>

beginUpdateAndWait

Parameters

resourceGroupName: string

clusterName: string