az managed-cassandra cluster

Is this page helpful?

Any additional feedback?

Feedback will be sent to Microsoft: By pressing the submit button, your feedback will be used to improve Microsoft products and services. Privacy policy.

Azure Managed Cassandra Cluster.

Commands

az managed-cassandra cluster backup	Azure Managed Cassandra cluster Backup.
az managed-cassandra cluster backup list	List the backups of this cluster that are available to restore.
az managed-cassandra cluster backup show	Get a managed cassandra backup resource of this cluster.
az managed-cassandra cluster create	Create a Managed Cassandra Cluster.
az managed-cassandra cluster 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.
az managed-cassandra cluster delete	Deletes a Managed Cassandra Cluster.
az managed-cassandra cluster invoke-command	Invoke a command like nodetool for cassandra maintenance.
az managed-cassandra cluster list	List the Managed Cassandra Clusters in a ResourceGroup and Subscription. If the ResourceGroup is not specified all the clusters in this Subscription are returned.
az managed-cassandra cluster show	Get a Managed Cassandra Cluster Resource.
az managed-cassandra cluster 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.
az managed-cassandra cluster status	Gets the CPU, memory, and disk usage statistics for each Cassandra node in a cluster.
az managed-cassandra cluster update	Update a Managed Cassandra Cluster.

az managed-cassandra cluster create

Create a Managed Cassandra Cluster.

az managed-cassandra cluster create --cluster-name
                                    --delegated-management-subnet-id
                                    --location
                                    --resource-group
                                    [--authentication-method {Cassandra, None}]
                                    [--cassandra-version]
                                    [--client-certificates]
                                    [--cluster-name-override]
                                    [--external-gossip-certificates]
                                    [--external-seed-nodes]
                                    [--hours-between-backups]
                                    [--identity-type {None, SystemAssigned}]
                                    [--initial-cassandra-admin-password]
                                    [--no-wait]
                                    [--repair-enabled {false, true}]
                                    [--restore-from-backup-id]
                                    [--tags]

Examples

Create a Managed Cassandra Cluster in a given Subscription and ResourceGroup. Either a cassandra admin password or external seed needs are required.

az managed-cassandra cluster create \
--resource-group MyResourceGroup \
--cluster-name MyCluster \
--location MyLocation \
--initial-cassandra-admin-password password \
--delegated-management-subnet-id /subscriptions/94d9b402-77b4-4049-b4c1-947bc6b7729b/resourceGroups/My-vnet/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-subnet

Required Parameters

--cluster-name -c

Cluster Name.

--delegated-management-subnet-id -s

The resource id of a subnet where the ip address of the cassandra management server will be allocated. This subnet must have connectivity to the delegated_subnet_id subnet of each data center.

--location -l

Azure Location of the Cluster.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--authentication-method

Authentication mode can be None or Cassandra. If None, no authentication will be required to connect to the Cassandra API. If Cassandra, then passwords will be used.

accepted values: Cassandra, None

--cassandra-version

The version of Cassandra chosen.

--client-certificates

If specified, enables client certificate authentication to the Cassandra API.

--cluster-name-override

If a cluster must have a name that is not a valid azure resource name, this field can be specified to choose the Cassandra cluster name. Otherwise, the resource name will be used as the cluster name.

--external-gossip-certificates -e

A list of certificates that the managed cassandra data center's should accept.

--external-seed-nodes

A list of ip addresses of the seed nodes of on-premise data centers.

--hours-between-backups

The number of hours between backup attempts.

--identity-type

Type of identity used for Customer Managed Disk Key.

accepted values: None, SystemAssigned

default value: None

--initial-cassandra-admin-password -i

The intial password to be configured when a cluster is created for authentication_method Cassandra.

--no-wait

Do not wait for the long-running operation to finish.

--repair-enabled

Enables automatic repair.

accepted values: false, true

--restore-from-backup-id

The resource id of a backup. If provided on create, the backup will be used to prepopulate the cluster. The cluster data center count and node counts must match the backup.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az managed-cassandra cluster 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.

az managed-cassandra cluster deallocate --cluster-name
                                        --resource-group
                                        [--no-wait]

Examples

This command deallocates this cluster.

az managed-cassandra cluster deallocate --resource-group MyResourceGroup --cluster-name MyCluster

Required Parameters

--cluster-name -c

Cluster Name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--no-wait

Do not wait for the long-running operation to finish.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az managed-cassandra cluster delete

Deletes a Managed Cassandra Cluster.

az managed-cassandra cluster delete --cluster-name
                                    --resource-group
                                    [--no-wait]
                                    [--yes]

Examples

Deletes a Managed Cassandra Cluster in the given Subscription and ResourceGroup.

az managed-cassandra cluster delete --resource-group MyResourceGroup --cluster-name MyCluster

Required Parameters

--cluster-name -c

Cluster Name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--no-wait

Do not wait for the long-running operation to finish.

--yes -y

Do not prompt for confirmation.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az managed-cassandra cluster invoke-command

Invoke a command like nodetool for cassandra maintenance.

az managed-cassandra cluster invoke-command --cluster-name
                                            --command-name
                                            --host
                                            --resource-group
                                            [--arguments]
                                            [--cassandra-stop-start {false, true}]
                                            [--no-wait]
                                            [--readwrite {false, true}]

Examples

This command runs nodetool with these arguments in a host node of the cluster.

az managed-cassandra cluster invoke-command --resource-group MyResourceGroup --cluster-name MyCluster --host "10.0.1.12" --command-name "nodetool" --arguments arg1="value1" arg2="value2" arg3="value3"

Required Parameters

--cluster-name -c

Cluster Name.

--command-name

The command which should be run.

--host

IP address of the cassandra host to run the command on.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--arguments

The key="value" of arguments for the command.

--cassandra-stop-start

If true, stops cassandra before executing the command and then start it again.

accepted values: false, true

--no-wait

Do not wait for the long-running operation to finish.

--readwrite

If true, allows the command to *write* to the cassandra directory, otherwise read-only.

accepted values: false, true

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az managed-cassandra cluster list

List the Managed Cassandra Clusters in a ResourceGroup and Subscription. If the ResourceGroup is not specified all the clusters in this Subscription are returned.

az managed-cassandra cluster list [--resource-group]

Examples

List all Managed Cassandra Clusters in a given Subscription and ResourceGroup.

az managed-cassandra cluster list --resource-group MyResourceGroup

List all Managed Cassandra Clusters in a given Subscription.

az managed-cassandra cluster list

Optional Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az managed-cassandra cluster show

Get a Managed Cassandra Cluster Resource.

az managed-cassandra cluster show --cluster-name
                                  --resource-group

Examples

Gets a Managed Cassandra Cluster Resource. ProvisioningState tells the state of this cluster. If the cluster doesnot exist a NotFound response is returned.

az managed-cassandra cluster show --resource-group MyResourceGroup --cluster-name MyCluster

Required Parameters

--cluster-name -c

Cluster Name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az managed-cassandra cluster 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.

az managed-cassandra cluster start --cluster-name
                                   --resource-group
                                   [--no-wait]

Examples

This command starts this cluster.

az managed-cassandra cluster start --resource-group MyResourceGroup --cluster-name MyCluster

Required Parameters

--cluster-name -c

Cluster Name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--no-wait

Do not wait for the long-running operation to finish.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az managed-cassandra cluster status

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

az managed-cassandra cluster status --cluster-name
                                    --resource-group

Examples

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

az managed-cassandra cluster status --resource-group MyResourceGroup --cluster-name MyCluster

Required Parameters

--cluster-name -c

Cluster Name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az managed-cassandra cluster update

Update a Managed Cassandra Cluster.

az managed-cassandra cluster update --cluster-name
                                    --resource-group
                                    [--authentication-method {Cassandra, None}]
                                    [--cassandra-version]
                                    [--client-certificates]
                                    [--external-gossip-certificates]
                                    [--external-seed-nodes]
                                    [--hours-between-backups]
                                    [--identity-type {None, SystemAssigned}]
                                    [--no-wait]
                                    [--repair-enabled {false, true}]
                                    [--tags]

Examples

Update External Seed Nodes of a given cluster.

az managed-cassandra cluster update --resource-group MyResourceGroup --cluster-name MyCluster --external-seed-nodes 127.0.0.1 127.0.0.2

Update External Gossip Certificates of a given cluster. Certs can be passed in as strings or the file locations.

az managed-cassandra cluster update --resource-group MyResourceGroup --cluster-name MyCluster --external-gossip-certificates C:/MyFolder/test.pem BeginCert-MLXCF-EndCert

Required Parameters

--cluster-name -c

Cluster Name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--authentication-method

Authentication mode can be None or Cassandra. If None, no authentication will be required to connect to the Cassandra API. If Cassandra, then passwords will be used.

accepted values: Cassandra, None

--cassandra-version

The version of Cassandra chosen.

--client-certificates

If specified, enables client certificate authentication to the Cassandra API.

--external-gossip-certificates -e

A list of certificates that the managed cassandra data center's should accept.

--external-seed-nodes

A list of ip addresses of the seed nodes of on-premise data centers.

--hours-between-backups

The number of hours between backup attempts.

--identity-type

Type of identity used for Customer Managed Disk Key.

accepted values: None, SystemAssigned

--no-wait

Do not wait for the long-running operation to finish.

--repair-enabled

Enables automatic repair.

accepted values: false, true

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.