az cosmosdb table

Manage Table resources of Azure Cosmos DB account.

Commands

az cosmosdb table create

Create an Table under an Azure Cosmos DB account.

az cosmosdb table delete

Delete the Table under an Azure Cosmos DB account.

az cosmosdb table exists

Checks if an Azure Cosmos DB table exists.

az cosmosdb table list

List the Tables under an Azure Cosmos DB account.

az cosmosdb table show

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

az cosmosdb table throughput

Manage throughput of Table under an Azure Cosmos DB account.

az cosmosdb table throughput migrate

Migrate the throughput of the Table between autoscale and manually provisioned.

az cosmosdb table throughput show

Get the throughput of the Table under an Azure Cosmos DB account.

az cosmosdb table throughput update

Update the throughput of the Table under an Azure Cosmos DB account.

az cosmosdb table create

Create an Table under an Azure Cosmos DB account.

az cosmosdb table create --account-name
                         --name
                         --resource-group
                         [--max-throughput]
                         [--subscription]
                         [--throughput]

Required Parameters

--account-name -a

Cosmosdb account 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

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

--subscription

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

--throughput

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

az cosmosdb table delete

Delete the Table under an Azure Cosmos DB account.

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

Required Parameters

--account-name -a

Cosmosdb account 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

--subscription

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

--yes -y

Do not prompt for confirmation.

az cosmosdb table exists

Checks if an Azure Cosmos DB table exists.

az cosmosdb table exists --account-name
                         --name
                         --resource-group
                         [--subscription]

Required Parameters

--account-name -a

Cosmosdb account 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

--subscription

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

az cosmosdb table list

List the Tables under an Azure Cosmos DB account.

az cosmosdb table list --account-name
                       --resource-group
                       [--query-examples]
                       [--subscription]

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

Optional Parameters

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--subscription

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

az cosmosdb table show

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

az cosmosdb table show --account-name
                       --name
                       --resource-group
                       [--query-examples]
                       [--subscription]

Required Parameters

--account-name -a

Cosmosdb account 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

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--subscription

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