CassandraClusters interface

Package:

@azure/arm-cosmosdb

Interface representing a CassandraClusters.

Methods

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.
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.
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.
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.
beginDelete(string, string, CassandraClustersDeleteOptionalParams)	Deletes a managed Cassandra cluster.
beginDeleteAndWait(string, string, CassandraClustersDeleteOptionalParams)	Deletes a managed Cassandra cluster.
beginInvokeCommand(string, string, CommandPostBody, CassandraClustersInvokeCommandOptionalParams)	Invoke a command like nodetool for cassandra maintenance
beginInvokeCommandAndWait(string, string, CommandPostBody, CassandraClustersInvokeCommandOptionalParams)	Invoke a command like nodetool for cassandra maintenance
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.
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.
beginUpdate(string, string, ClusterResource, CassandraClustersUpdateOptionalParams)	Updates some of the properties of a managed Cassandra cluster.
beginUpdateAndWait(string, string, ClusterResource, CassandraClustersUpdateOptionalParams)	Updates some of the properties of a managed Cassandra cluster.
get(string, string, CassandraClustersGetOptionalParams)	Get the properties of a managed Cassandra cluster.
listByResourceGroup(string, CassandraClustersListByResourceGroupOptionalParams)	List all managed Cassandra clusters in this resource group.
listBySubscription(CassandraClustersListBySubscriptionOptionalParams)	List all managed Cassandra clusters in this subscription.
status(string, string, CassandraClustersStatusOptionalParams)	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.

options

CassandraClustersCreateUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.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.

options

CassandraClustersCreateUpdateOptionalParams

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.

options

CassandraClustersDeallocateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.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.

options

CassandraClustersDeallocateOptionalParams

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.

options

CassandraClustersDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.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.

options

CassandraClustersDeleteOptionalParams

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

options

CassandraClustersInvokeCommandOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.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

options

CassandraClustersInvokeCommandOptionalParams

The options parameters.

Returns

Promise<CommandOutput>

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.

options

CassandraClustersStartOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.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.

options

CassandraClustersStartOptionalParams

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.

options

CassandraClustersUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.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.

options

CassandraClustersUpdateOptionalParams

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.

options

CassandraClustersGetOptionalParams

The options parameters.

Returns

Promise<ClusterResource>

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.

options

CassandraClustersListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ClusterResource, ClusterResource[], PageSettings>

listBySubscription(CassandraClustersListBySubscriptionOptionalParams)

List all managed Cassandra clusters in this subscription.

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

Parameters

options

CassandraClustersListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ClusterResource, ClusterResource[], PageSettings>

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.

options

CassandraClustersStatusOptionalParams

The options parameters.

Returns

Promise<CassandraClusterPublicStatus>