Share via

az cosmosdb cassandra table

  • Reference

Manage Azure Cosmos DB Cassandra tables.

Commands

Name Description Type Status
az cosmosdb cassandra table create

Create an Cassandra table under an Azure Cosmos DB Cassandra keyspace.

 Core GA
az cosmosdb cassandra table delete

Delete the Cassandra table under an Azure Cosmos DB Cassandra keyspace.

 Core GA
az cosmosdb cassandra table exists

Checks if an Azure Cosmos DB Cassandra table exists.

 Core GA
az cosmosdb cassandra table list

List the Cassandra tables under an Azure Cosmos DB Cassandra keyspace.

 Core GA
az cosmosdb cassandra table show

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

 Core GA
az cosmosdb cassandra table throughput

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

 Core GA
az cosmosdb cassandra table throughput migrate

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

 Core GA
az cosmosdb cassandra table throughput show

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

 Core GA
az cosmosdb cassandra table throughput update

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

 Core GA
az cosmosdb cassandra table update

Update an Cassandra table under an Azure Cosmos DB Cassandra keyspace.

 Core GA

az cosmosdb cassandra table create

Edit

Create an Cassandra table under an Azure Cosmos DB Cassandra keyspace.

az cosmosdb cassandra table create --account-name
                                   --keyspace-name
                                   --name
                                   --resource-group
                                   --schema
                                   [--analytical-storage-ttl]
                                   [--max-throughput]
                                   [--throughput]
                                   [--ttl]

Examples

Create an Azure Cosmos DB Cassandra table.

az cosmosdb cassandra table create -g MyResourceGroup -a MyAccount -k MyKeyspace -n MyTable --schema @indexes-file.json --throughput "500" --ttl 1000

Required Parameters

--account-name -a

Cosmosdb account name.

--keyspace-name -k

Keyspace name.

--name -n

Table name.

--resource-group -g

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

--schema

Schema, you can enter it as a string or as a file, e.g., --schema @schema-file.json or --schema "{"columns": [{"name": "columnA","type": "uuid"}, {"name": "columnB","type": "Ascii"}],"partitionKeys": [{"name": "columnA"}]}".

Optional Parameters

--analytical-storage-ttl

Analytical TTL, when analytical storage is enabled.

--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 table (RU/s). Default value is 400. Omit this parameter if the keyspace has shared throughput unless the table should have dedicated throughput.

--ttl

Default TTL. If the value is missing or set to "-1", items don’t expire. If the value is set to "n", items will expire "n" seconds after last modified time.

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 table delete

Edit

Delete the Cassandra table under an Azure Cosmos DB Cassandra keyspace.

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

Required Parameters

--account-name -a

Cosmosdb account name.

--keyspace-name -k

Keyspace name.

--name -n

Table 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 table exists

Edit

Checks if an Azure Cosmos DB Cassandra table exists.

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

Required Parameters

--account-name -a

Cosmosdb account name.

--keyspace-name -k

Keyspace name.

--name -n

Table 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 table list

Edit

List the Cassandra tables under an Azure Cosmos DB Cassandra keyspace.

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

Examples

List the Cassandra tables under an Azure Cosmos DB Cassandra keyspace. (autogenerated)

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

Required Parameters

--account-name -a

Cosmosdb account name.

--keyspace-name -k

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 table show

Edit

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

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

Required Parameters

--account-name -a

Cosmosdb account name.

--keyspace-name -k

Keyspace name.

--name -n

Table 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 table update

Edit

Update an Cassandra table under an Azure Cosmos DB Cassandra keyspace.

az cosmosdb cassandra table update --account-name
                                   --keyspace-name
                                   --name
                                   --resource-group
                                   [--analytical-storage-ttl]
                                   [--schema]
                                   [--ttl]

Examples

Update an Cassandra table under an Azure Cosmos DB Cassandra keyspace. (autogenerated)

az cosmosdb cassandra table update --account-name MyAccount --keyspace-name MyKeyspace --name MyTable --resource-group MyResourceGroup --schema @indexes-file.json

Required Parameters

--account-name -a

Cosmosdb account name.

--keyspace-name -k

Keyspace name.

--name -n

Table name.

--resource-group -g

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

Optional Parameters

--analytical-storage-ttl

Analytical TTL, when analytical storage is enabled.

--schema

Schema, you can enter it as a string or as a file, e.g., --schema @schema-file.json or --schema "{"columns": [{"name": "columnA","type": "uuid"}, {"name": "columnB","type": "Ascii"}],"partitionKeys": [{"name": "columnA"}]}".

--ttl

Default TTL. If the value is missing or set to "-1", items don’t expire. If the value is set to "n", items will expire "n" seconds after last modified time.

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.