CassandraClusters interface
Interface representing a CassandraClusters.
Methods
| begin |
Create or update a managed Cassandra cluster. When updating, you must specify all writable properties. To update only some properties, use PATCH. |
| begin |
Create or update a managed Cassandra cluster. When updating, you must specify all writable properties. To update only some properties, use PATCH. |
| begin |
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. |
| begin |
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. |
| begin |
Deletes a managed Cassandra cluster. |
| begin |
Deletes a managed Cassandra cluster. |
| begin |
Invoke a command like nodetool for cassandra maintenance |
| begin |
Invoke a command like nodetool for cassandra maintenance |
| begin |
Invoke a command like nodetool for cassandra maintenance asynchronously |
| begin |
Invoke a command like nodetool for cassandra maintenance asynchronously |
| begin |
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. |
| begin |
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. |
| begin |
Updates some of the properties of a managed Cassandra cluster. |
| begin |
Updates some of the properties of a managed Cassandra cluster. |
| get(string, string, Cassandra |
Get the properties of a managed Cassandra cluster. |
| get |
Get the properties of an individual backup of this cluster that is available to restore. |
| get |
Get details about a specified command that was run asynchronously. |
| list |
List the backups of this cluster that are available to restore. |
| list |
List all managed Cassandra clusters in this resource group. |
| list |
List all managed Cassandra clusters in this subscription. |
| list |
List all commands currently running on ring info |
| status(string, string, Cassandra |
Gets the CPU, memory, and disk usage statistics for each Cassandra node in a cluster. |
Method Details
beginCreateUpdate(string, string, ClusterResource, CassandraClustersCreateUpdateOptionalParams)
Create or update a managed Cassandra cluster. When updating, you must specify all writable properties. To update only some properties, use PATCH.
function beginCreateUpdate(resourceGroupName: string, clusterName: string, body: ClusterResource, options?: CassandraClustersCreateUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ClusterResource>, ClusterResource>>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.
The options parameters.
Returns
Promise<SimplePollerLike<OperationState<ClusterResource>, ClusterResource>>
beginCreateUpdateAndWait(string, string, ClusterResource, CassandraClustersCreateUpdateOptionalParams)
Create or update a managed Cassandra cluster. When updating, you must specify all writable properties. To update only some properties, use PATCH.
function beginCreateUpdateAndWait(resourceGroupName: string, clusterName: string, body: ClusterResource, options?: CassandraClustersCreateUpdateOptionalParams): Promise<ClusterResource>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.
The options parameters.
Returns
Promise<ClusterResource>
beginDeallocate(string, string, CassandraClustersDeallocateOptionalParams)
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.
function beginDeallocate(resourceGroupName: string, clusterName: string, options?: CassandraClustersDeallocateOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- clusterName
-
string
Managed Cassandra cluster name.
The options parameters.
Returns
Promise<SimplePollerLike<OperationState<void>, void>>
beginDeallocateAndWait(string, string, CassandraClustersDeallocateOptionalParams)
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.
function beginDeallocateAndWait(resourceGroupName: string, clusterName: string, options?: CassandraClustersDeallocateOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- clusterName
-
string
Managed Cassandra cluster name.
The options parameters.
Returns
Promise<void>
beginDelete(string, string, CassandraClustersDeleteOptionalParams)
Deletes a managed Cassandra cluster.
function beginDelete(resourceGroupName: string, clusterName: string, options?: CassandraClustersDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- clusterName
-
string
Managed Cassandra cluster name.
The options parameters.
Returns
Promise<SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, CassandraClustersDeleteOptionalParams)
Deletes a managed Cassandra cluster.
function beginDeleteAndWait(resourceGroupName: string, clusterName: string, options?: CassandraClustersDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- clusterName
-
string
Managed Cassandra cluster name.
The options parameters.
Returns
Promise<void>
beginInvokeCommand(string, string, CommandPostBody, CassandraClustersInvokeCommandOptionalParams)
Invoke a command like nodetool for cassandra maintenance
function beginInvokeCommand(resourceGroupName: string, clusterName: string, body: CommandPostBody, options?: CassandraClustersInvokeCommandOptionalParams): Promise<SimplePollerLike<OperationState<CommandOutput>, CommandOutput>>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
The options parameters.
Returns
Promise<SimplePollerLike<OperationState<CommandOutput>, CommandOutput>>
beginInvokeCommandAndWait(string, string, CommandPostBody, CassandraClustersInvokeCommandOptionalParams)
Invoke a command like nodetool for cassandra maintenance
function beginInvokeCommandAndWait(resourceGroupName: string, clusterName: string, body: CommandPostBody, options?: CassandraClustersInvokeCommandOptionalParams): Promise<CommandOutput>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
The options parameters.
Returns
Promise<CommandOutput>
beginInvokeCommandAsync(string, string, CommandPostBody, CassandraClustersInvokeCommandAsyncOptionalParams)
Invoke a command like nodetool for cassandra maintenance asynchronously
function beginInvokeCommandAsync(resourceGroupName: string, clusterName: string, body: CommandPostBody, options?: CassandraClustersInvokeCommandAsyncOptionalParams): Promise<SimplePollerLike<OperationState<CommandPublicResource>, CommandPublicResource>>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
The options parameters.
Returns
beginInvokeCommandAsyncAndWait(string, string, CommandPostBody, CassandraClustersInvokeCommandAsyncOptionalParams)
Invoke a command like nodetool for cassandra maintenance asynchronously
function beginInvokeCommandAsyncAndWait(resourceGroupName: string, clusterName: string, body: CommandPostBody, options?: CassandraClustersInvokeCommandAsyncOptionalParams): Promise<CommandPublicResource>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
The options parameters.
Returns
Promise<CommandPublicResource>
beginStart(string, string, CassandraClustersStartOptionalParams)
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.
function beginStart(resourceGroupName: string, clusterName: string, options?: CassandraClustersStartOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- clusterName
-
string
Managed Cassandra cluster name.
The options parameters.
Returns
Promise<SimplePollerLike<OperationState<void>, void>>
beginStartAndWait(string, string, CassandraClustersStartOptionalParams)
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.
function beginStartAndWait(resourceGroupName: string, clusterName: string, options?: CassandraClustersStartOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- clusterName
-
string
Managed Cassandra cluster name.
The options parameters.
Returns
Promise<void>
beginUpdate(string, string, ClusterResource, CassandraClustersUpdateOptionalParams)
Updates some of the properties of a managed Cassandra cluster.
function beginUpdate(resourceGroupName: string, clusterName: string, body: ClusterResource, options?: CassandraClustersUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ClusterResource>, ClusterResource>>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.
The options parameters.
Returns
Promise<SimplePollerLike<OperationState<ClusterResource>, ClusterResource>>
beginUpdateAndWait(string, string, ClusterResource, CassandraClustersUpdateOptionalParams)
Updates some of the properties of a managed Cassandra cluster.
function beginUpdateAndWait(resourceGroupName: string, clusterName: string, body: ClusterResource, options?: CassandraClustersUpdateOptionalParams): Promise<ClusterResource>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.
The options parameters.
Returns
Promise<ClusterResource>
get(string, string, CassandraClustersGetOptionalParams)
Get the properties of a managed Cassandra cluster.
function get(resourceGroupName: string, clusterName: string, options?: CassandraClustersGetOptionalParams): Promise<ClusterResource>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- clusterName
-
string
Managed Cassandra cluster name.
The options parameters.
Returns
Promise<ClusterResource>
getBackup(string, string, string, CassandraClustersGetBackupOptionalParams)
Get the properties of an individual backup of this cluster that is available to restore.
function getBackup(resourceGroupName: string, clusterName: string, backupId: string, options?: CassandraClustersGetBackupOptionalParams): Promise<BackupResource>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.
The options parameters.
Returns
Promise<BackupResource>
getCommandAsync(string, string, string, CassandraClustersGetCommandAsyncOptionalParams)
Get details about a specified command that was run asynchronously.
function getCommandAsync(resourceGroupName: string, clusterName: string, commandId: string, options?: CassandraClustersGetCommandAsyncOptionalParams): Promise<ListCommands>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- clusterName
-
string
Managed Cassandra cluster name.
- commandId
-
string
Managed Cassandra cluster command id.
The options parameters.
Returns
Promise<ListCommands>
listBackups(string, string, CassandraClustersListBackupsOptionalParams)
List the backups of this cluster that are available to restore.
function listBackups(resourceGroupName: string, clusterName: string, options?: CassandraClustersListBackupsOptionalParams): PagedAsyncIterableIterator<BackupResource, BackupResource[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- clusterName
-
string
Managed Cassandra cluster name.
The options parameters.
Returns
listByResourceGroup(string, CassandraClustersListByResourceGroupOptionalParams)
List all managed Cassandra clusters in this resource group.
function listByResourceGroup(resourceGroupName: string, options?: CassandraClustersListByResourceGroupOptionalParams): PagedAsyncIterableIterator<ClusterResource, ClusterResource[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
The options parameters.
Returns
listBySubscription(CassandraClustersListBySubscriptionOptionalParams)
List all managed Cassandra clusters in this subscription.
function listBySubscription(options?: CassandraClustersListBySubscriptionOptionalParams): PagedAsyncIterableIterator<ClusterResource, ClusterResource[], PageSettings>Parameters
The options parameters.
Returns
listCommand(string, string, CassandraClustersListCommandOptionalParams)
List all commands currently running on ring info
function listCommand(resourceGroupName: string, clusterName: string, options?: CassandraClustersListCommandOptionalParams): PagedAsyncIterableIterator<CommandPublicResource, CommandPublicResource[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- clusterName
-
string
Managed Cassandra cluster name.
The options parameters.
Returns
status(string, string, CassandraClustersStatusOptionalParams)
Gets the CPU, memory, and disk usage statistics for each Cassandra node in a cluster.
function status(resourceGroupName: string, clusterName: string, options?: CassandraClustersStatusOptionalParams): Promise<CassandraClusterPublicStatus>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- clusterName
-
string
Managed Cassandra cluster name.
The options parameters.
Returns
Promise<CassandraClusterPublicStatus>
Azure SDK for JavaScript
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for