Share via

az cosmosdb cassandra keyspace

  • Reference

Manage Azure Cosmos DB Cassandra keyspaces.

Commands

Name Description Type Status
az cosmosdb cassandra keyspace create

Create an Cassandra keyspace under an Azure Cosmos DB account.

 Core GA
az cosmosdb cassandra keyspace delete

Delete the Cassandra keyspace under an Azure Cosmos DB account.

 Core GA
az cosmosdb cassandra keyspace exists

Checks if an Azure Cosmos DB Cassandra keyspace exists.

 Core GA
az cosmosdb cassandra keyspace list

List the Cassandra keyspaces under an Azure Cosmos DB account.

 Core GA
az cosmosdb cassandra keyspace show

Show the details of a Cassandra keyspace under an Azure Cosmos DB account.

 Core GA
az cosmosdb cassandra keyspace throughput

Manage throughput of Cassandra keyspace under an Azure Cosmos DB account.

 Core GA
az cosmosdb cassandra keyspace throughput migrate

Migrate the throughput of the Cassandra keyspace between autoscale and manually provisioned.

 Core GA
az cosmosdb cassandra keyspace throughput show

Get the throughput of the Cassandra keyspace under an Azure Cosmos DB account.

 Core GA
az cosmosdb cassandra keyspace throughput update

Update the throughput of the Cassandra keyspace under an Azure Cosmos DB account.

 Core GA

az cosmosdb cassandra keyspace create

Edit

Create an Cassandra keyspace under an Azure Cosmos DB account.

az cosmosdb cassandra keyspace create --account-name
                                      --name
                                      --resource-group
                                      [--max-throughput]
                                      [--throughput]

Required Parameters

--account-name -a

Cosmosdb account name.

--name -n

Keyspace name.

--resource-group -g

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

Optional Parameters

--max-throughput

The maximum throughput resource can scale to (RU/s). Provided when the resource is autoscale enabled. The minimum value can be 4000 (RU/s).

--throughput

The throughput of Cassandra keyspace (RU/s). Default value is 400.

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 cosmosdb cassandra keyspace delete

Edit

Delete the Cassandra keyspace under an Azure Cosmos DB account.

az cosmosdb cassandra keyspace delete --account-name
                                      --name
                                      --resource-group
                                      [--yes]

Examples

Delete the Cassandra keyspace under an Azure Cosmos DB account. (autogenerated)

az cosmosdb cassandra keyspace delete --account-name MyAccount --name MyKeyspace --resource-group MyResourceGroup

Required Parameters

--account-name -a

Cosmosdb account name.

--name -n

Keyspace name.

--resource-group -g

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

Optional Parameters

--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 cosmosdb cassandra keyspace exists

Edit

Checks if an Azure Cosmos DB Cassandra keyspace exists.

az cosmosdb cassandra keyspace exists --account-name
                                      --name
                                      --resource-group

Required Parameters

--account-name -a

Cosmosdb account name.

--name -n

Keyspace 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 cosmosdb cassandra keyspace list

Edit

List the Cassandra keyspaces under an Azure Cosmos DB account.

az cosmosdb cassandra keyspace list --account-name
                                    --resource-group

Examples

List the Cassandra keyspaces under an Azure Cosmos DB account. (autogenerated)

az cosmosdb cassandra keyspace list --account-name MyAccount --resource-group MyResourceGroup

Required Parameters

--account-name -a

Cosmosdb account 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 cosmosdb cassandra keyspace show

Edit

Show the details of a Cassandra keyspace under an Azure Cosmos DB account.

az cosmosdb cassandra keyspace show --account-name
                                    --name
                                    --resource-group

Required Parameters

--account-name -a

Cosmosdb account name.

--name -n

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