Share via

az managed-cassandra datacenter

  • Reference

Note

This command group has commands that are defined in both Azure CLI and at least one extension. Install each extension to benefit from its extended capabilities. Learn more about extensions.

Azure Managed Cassandra DataCenter.

Commands

Name Description Type Status
az managed-cassandra datacenter create

Create a Datacenter in an Azure Managed Cassandra Cluster.

 Core GA
az managed-cassandra datacenter create (cosmosdb-preview extension)

Create a Datacenter in an Azure Managed Cassandra Cluster.

 Extension GA
az managed-cassandra datacenter delete

Deletes a Managed Cassandra Datacenter.

 Core GA
az managed-cassandra datacenter delete (cosmosdb-preview extension)

Deletes a Managed Cassandra Datacenter.

 Extension GA
az managed-cassandra datacenter list

List the Managed Cassandra Datacenters in a given Cluster.

 Core GA
az managed-cassandra datacenter list (cosmosdb-preview extension)

List the Managed Cassandra Datacenters in a given Cluster.

 Extension GA
az managed-cassandra datacenter show

Get a Managed Cassandra DataCenter Resource.

 Core GA
az managed-cassandra datacenter show (cosmosdb-preview extension)

Get a Managed Cassandra DataCenter Resource.

 Extension GA
az managed-cassandra datacenter update

Update a Datacenter in an Azure Managed Cassandra Cluster.

 Core GA
az managed-cassandra datacenter update (cosmosdb-preview extension)

Update a Datacenter in an Azure Managed Cassandra Cluster.

 Extension GA

az managed-cassandra datacenter create

Create a Datacenter in an Azure Managed Cassandra Cluster.

az managed-cassandra datacenter create --cluster-name
                                       --data-center-location
                                       --data-center-name
                                       --delegated-subnet-id
                                       --node-count
                                       --resource-group
                                       [--availability-zone {false, true}]
                                       [--backup-storage-customer-key-uri]
                                       [--base64-encoded-cassandra-yaml-fragment]
                                       [--disk-capacity]
                                       [--disk-sku]
                                       [--managed-disk-customer-key-uri]
                                       [--no-wait]
                                       [--sku]

Examples

Create a Managed Cassandra Datacenter in a Cassandra Cluster. Each datacenter should atleast have 3 nodes.

az managed-cassandra datacenter create \
--resource-group MyResourceGroup \
--cluster-name MyCluster \
--data-center-name MyDataCenter \
--data-center-location westus2 \
--node-count 3 \
--delegated-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.

--data-center-location -l

Azure Location of the Datacenter.

--data-center-name -d

Datacenter Name.

--delegated-subnet-id -s

The resource id of a subnet where ip addresses of the Cassandra virtual machines will be allocated. This must be in the same region as data_center_location.

--node-count -n

The number of Cassandra virtual machines in this data center. The minimum value is 3.

--resource-group -g

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

Optional Parameters

--availability-zone -z

If the data center haves Availability Zone feature, apply it to the Virtual Machine ScaleSet that host the data center virtual machines.

Accepted values: false, true
--backup-storage-customer-key-uri -p

Indicates the Key Uri of the customer key to use for encryption of the backup storage account.

--base64-encoded-cassandra-yaml-fragment -b

This is a Base64 encoded yaml file that is a subset of cassandra.yaml. Supported fields will be honored and others will be ignored.

--disk-capacity

Number of disk used for data centers. Default value is 4.

--disk-sku

Disk SKU used for data centers. Default value is P30.

--managed-disk-customer-key-uri -k

Key uri to use for encryption of managed disks. Ensure the system assigned identity of the cluster has been assigned appropriate permissions(key get/wrap/unwrap permissions) on the key.

--no-wait

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

Default value: False
--sku

Virtual Machine SKU used for data centers. Default value is Standard_DS14_v2.

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.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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 datacenter create (cosmosdb-preview extension)

Create a Datacenter in an Azure Managed Cassandra Cluster.

az managed-cassandra datacenter create --cluster-name
                                       --data-center-location
                                       --data-center-name
                                       --delegated-subnet-id
                                       --node-count
                                       --resource-group
                                       [--availability-zone {false, true}]
                                       [--backup-storage-customer-key-uri]
                                       [--base64-encoded-cassandra-yaml-fragment]
                                       [--disk-capacity]
                                       [--disk-sku]
                                       [--ldap-search-base-dn]
                                       [--ldap-search-filter]
                                       [--ldap-server-certs]
                                       [--ldap-server-hostname]
                                       [--ldap-server-port]
                                       [--ldap-service-user-dn]
                                       [--ldap-svc-user-pwd]
                                       [--managed-disk-customer-key-uri]
                                       [--no-wait]
                                       [--sku]

Examples

Create a Managed Cassandra Datacenter in a Cassandra Cluster. Each datacenter should atleast have 3 nodes.

az managed-cassandra datacenter create \
--resource-group MyResourceGroup \
--cluster-name MyCluster \
--data-center-name MyDataCenter \
--data-center-location westus2 \
--node-count 3 \
--delegated-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.

--data-center-location -l

Azure Location of the Datacenter.

--data-center-name -d

Datacenter Name.

--delegated-subnet-id -s

The resource id of a subnet where ip addresses of the Cassandra virtual machines will be allocated. This must be in the same region as data_center_location.

--node-count -n

The number of Cassandra virtual machines in this data center. The minimum value is 3.

--resource-group -g

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

Optional Parameters

--availability-zone -z

If the data center haves Availability Zone feature, apply it to the Virtual Machine ScaleSet that host the data center virtual machines.

Accepted values: false, true
--backup-storage-customer-key-uri -p

Indicates the Key Uri of the customer key to use for encryption of the backup storage account.

--base64-encoded-cassandra-yaml-fragment -b

This is a Base64 encoded yaml file that is a subset of cassandra.yaml. Supported fields will be honored and others will be ignored.

--disk-capacity

Number of disk used for data centers. Default value is 4.

--disk-sku

Disk SKU used for data centers. Default value is P30.

--ldap-search-base-dn

Distinguished name of the object to start the recursive search of users from.

--ldap-search-filter

Template to use for searching. Defaults to (cn=%s) where %s will be replaced by the username used to login. While using this parameter from Windows Powershell (not Windows CommandPrompt or Linux) there is a known issue with escaping special characters, so pass as """(cn=%s)""" instead.

--ldap-server-certs

LDAP server certificate. It should have subject alternative name(SAN) DNS Name entry matching the hostname of the LDAP server.

--ldap-server-hostname

Hostname of the LDAP server.

--ldap-server-port

Port of the LDAP server. Defaults to 636.

--ldap-service-user-dn

Distinguished name of the look up user account, who can look up user details on authentication.

--ldap-svc-user-pwd

Password of the look up user.

--managed-disk-customer-key-uri -k

Key uri to use for encryption of managed disks. Ensure the system assigned identity of the cluster has been assigned appropriate permissions(key get/wrap/unwrap permissions) on the key.

--no-wait

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

Default value: False
--sku

Virtual Machine SKU used for data centers. Default value is Standard_DS14_v2.

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.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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 datacenter delete

Deletes a Managed Cassandra Datacenter.

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

Examples

Deletes a Managed Cassandra Datacenter in the given Cluster.

az managed-cassandra datacenter delete --resource-group MyResourceGroup --cluster-name MyCluster --data-center-name MyDataCenter

Deletes a Managed Cassandra Datacenter in the given Cluster without waiting for the long-running operation to finish.

az managed-cassandra datacenter delete --resource-group MyResourceGroup --cluster-name MyCluster --data-center-name MyDataCenter --no-wait

Required Parameters

--cluster-name -c

Cluster Name.

--data-center-name -d

Datacenter 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.

Default value: False
--yes -y

Do not prompt for confirmation.

Default value: False
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.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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 datacenter delete (cosmosdb-preview extension)

Deletes a Managed Cassandra Datacenter.

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

Examples

Deletes a Managed Cassandra Datacenter in the given Cluster.

az managed-cassandra datacenter delete --resource-group MyResourceGroup --cluster-name MyCluster --data-center-name MyDataCenter

Deletes a Managed Cassandra Datacenter in the given Cluster without waiting for the long-running operation to finish.

az managed-cassandra datacenter delete --resource-group MyResourceGroup --cluster-name MyCluster --data-center-name MyDataCenter --no-wait

Required Parameters

--cluster-name -c

Cluster Name.

--data-center-name -d

Datacenter 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.

Default value: False
--yes -y

Do not prompt for confirmation.

Default value: False
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.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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 datacenter list

List the Managed Cassandra Datacenters in a given Cluster.

az managed-cassandra datacenter list --cluster-name
                                     --resource-group

Examples

List all Managed Cassandra DataCenters in a given Cluster.

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

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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 datacenter list (cosmosdb-preview extension)

List the Managed Cassandra Datacenters in a given Cluster.

az managed-cassandra datacenter list --cluster-name
                                     --resource-group

Examples

List all Managed Cassandra DataCenters in a given Cluster.

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

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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 datacenter show

Get a Managed Cassandra DataCenter Resource.

az managed-cassandra datacenter show --cluster-name
                                     --data-center-name
                                     --resource-group

Examples

Gets a Managed Cassandra Datacenter Resource. ProvisioningState tells the state of this datacenter. If the datacenter does not exist a NotFound response is returned.

az managed-cassandra datacenter show --resource-group MyResourceGroup --cluster-name MyCluster --data-center-name MyDataCenter

Required Parameters

--cluster-name -c

Cluster Name.

--data-center-name -d

Datacenter 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.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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 datacenter show (cosmosdb-preview extension)

Get a Managed Cassandra DataCenter Resource.

az managed-cassandra datacenter show --cluster-name
                                     --data-center-name
                                     --resource-group

Examples

Gets a Managed Cassandra Datacenter Resource. ProvisioningState tells the state of this datacenter. If the datacenter does not exist a NotFound response is returned.

az managed-cassandra datacenter show --resource-group MyResourceGroup --cluster-name MyCluster --data-center-name MyDataCenter

Required Parameters

--cluster-name -c

Cluster Name.

--data-center-name -d

Datacenter 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.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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 datacenter update

Update a Datacenter in an Azure Managed Cassandra Cluster.

az managed-cassandra datacenter update --cluster-name
                                       --data-center-name
                                       --resource-group
                                       [--backup-storage-customer-key-uri]
                                       [--base64-encoded-cassandra-yaml-fragment]
                                       [--managed-disk-customer-key-uri]
                                       [--no-wait]
                                       [--node-count]
                                       [--sku]

Examples

Scale the number of nodes in a datacenter. This is a scale up operation assuming that the create datacenter was done with 3 nodes. Each datacenter should atleast have 3 nodes.

az managed-cassandra datacenter update --resource-group MyResourceGroup --cluster-name MyCluster --data-center-name MyDataCenter --node-count 6

Scale the number of nodes in a datacenter. This is a scale down operation assuming that the create datacenter was done with 3 nodes, followed by a scale up to 6 nodes. Each datacenter should atleast have 3 nodes.

az managed-cassandra datacenter update --resource-group MyResourceGroup --cluster-name MyCluster --data-center-name MyDataCenter --node-count 4

Required Parameters

--cluster-name -c

Cluster Name.

--data-center-name -d

Datacenter Name.

--resource-group -g

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

Optional Parameters

--backup-storage-customer-key-uri -p

Indicates the Key Uri of the customer key to use for encryption of the backup storage account.

--base64-encoded-cassandra-yaml-fragment -b

This is a Base64 encoded yaml file that is a subset of cassandra.yaml. Supported fields will be honored and others will be ignored.

--managed-disk-customer-key-uri -k

Key uri to use for encryption of managed disks. Ensure the system assigned identity of the cluster has been assigned appropriate permissions(key get/wrap/unwrap permissions) on the key.

--no-wait

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

Default value: False
--node-count -n

The number of Cassandra virtual machines in this data center. The minimum value is 3.

--sku

Virtual Machine SKU used for data centers. Default value is Standard_DS14_v2.

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.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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 datacenter update (cosmosdb-preview extension)

Update a Datacenter in an Azure Managed Cassandra Cluster.

az managed-cassandra datacenter update --cluster-name
                                       --data-center-name
                                       --resource-group
                                       [--backup-storage-customer-key-uri]
                                       [--base64-encoded-cassandra-yaml-fragment]
                                       [--ldap-search-base-dn]
                                       [--ldap-search-filter]
                                       [--ldap-server-certs]
                                       [--ldap-server-hostname]
                                       [--ldap-server-port]
                                       [--ldap-service-user-dn]
                                       [--ldap-svc-user-pwd]
                                       [--managed-disk-customer-key-uri]
                                       [--no-wait]
                                       [--node-count]

Examples

Scale the number of nodes in a datacenter. This is a scale up operation assuming that the create datacenter was done with 3 nodes. Each datacenter should atleast have 3 nodes.

az managed-cassandra datacenter update --resource-group MyResourceGroup --cluster-name MyCluster --data-center-name MyDataCenter --node-count 6

Scale the number of nodes in a datacenter. This is a scale down operation assuming that the create datacenter was done with 3 nodes, followed by a scale up to 6 nodes. Each datacenter should atleast have 3 nodes.

az managed-cassandra datacenter update --resource-group MyResourceGroup --cluster-name MyCluster --data-center-name MyDataCenter --node-count 4

Required Parameters

--cluster-name -c

Cluster Name.

--data-center-name -d

Datacenter Name.

--resource-group -g

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

Optional Parameters

--backup-storage-customer-key-uri -p

Indicates the Key Uri of the customer key to use for encryption of the backup storage account.

--base64-encoded-cassandra-yaml-fragment -b

This is a Base64 encoded yaml file that is a subset of cassandra.yaml. Supported fields will be honored and others will be ignored.

--ldap-search-base-dn

Distinguished name of the object to start the recursive search of users from.

--ldap-search-filter

Template to use for searching. Defaults to (cn=%s) where %s will be replaced by the username used to login. While using this parameter from Windows Powershell (not Windows CommandPrompt or Linux) there is a known issue with escaping special characters, so pass as """(cn=%s)""" instead.

--ldap-server-certs

LDAP server certificate. It should have subject alternative name(SAN) DNS Name entry matching the hostname of the LDAP server.

--ldap-server-hostname

Hostname of the LDAP server.

--ldap-server-port

Port of the LDAP server. Defaults to 636.

--ldap-service-user-dn

Distinguished name of the look up user account, who can look up user details on authentication.

--ldap-svc-user-pwd

Password of the look up user.

--managed-disk-customer-key-uri -k

Key uri to use for encryption of managed disks. Ensure the system assigned identity of the cluster has been assigned appropriate permissions(key get/wrap/unwrap permissions) on the key.

--no-wait

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

Default value: False
--node-count -n

The number of Cassandra virtual machines in this data center. The minimum value is 3.

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.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.