az cosmosdb table

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

Manage Table resources of Azure Cosmos DB account.

Commands

Name Description Type Status
az cosmosdb table create

Create an Table under an Azure Cosmos DB account.

 Core GA
az cosmosdb table delete

Delete the Table under an Azure Cosmos DB account.

 Core GA
az cosmosdb table exists

Checks if an Azure Cosmos DB table exists.

 Core GA
az cosmosdb table list

List the Tables under an Azure Cosmos DB account.

 Core GA
az cosmosdb table restorable-resource

Manage the tables that can be restored in the given account at the given timestamp and region.

 Core and Extension GA
az cosmosdb table restorable-resource list

List all the tables that can be restored in the given account at the given timestamp and region.

 Core GA
az cosmosdb table restorable-resource list (cosmosdb-preview extension)

List all the tables that can be restored in the given account at the given timestamp and region.

 Extension Preview
az cosmosdb table restorable-table

Manage different versions of tables that are restorable in Azure Cosmos DB account.

 Core and Extension GA
az cosmosdb table restorable-table list

List all the versions of all the tables that were created / modified / deleted in the given restorable account.

 Core GA
az cosmosdb table restorable-table list (cosmosdb-preview extension)

List all the versions of all the tables that were created / modified / deleted in the given restorable account.

 Extension Preview
az cosmosdb table restore

Restore a deleted table within the same account.

 Core GA
az cosmosdb table restore (cosmosdb-preview extension)

Restore a deleted table within the same account.

 Extension Preview
az cosmosdb table retrieve-latest-backup-time

Retrieves latest restorable timestamp for the given table in given region.

 Core GA
az cosmosdb table retrieve-latest-backup-time (cosmosdb-preview extension)

Retrieves latest restorable timestamp for the given table in given region.

 Extension Preview
az cosmosdb table show

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

 Core GA
az cosmosdb table throughput

Manage throughput of Table under an Azure Cosmos DB account.

 Core GA
az cosmosdb table throughput migrate

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

 Core GA
az cosmosdb table throughput show

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

 Core GA
az cosmosdb table throughput update

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

 Core GA

az cosmosdb table create

Edit

Create an Table under an Azure Cosmos DB account.

az cosmosdb table create --account-name
                         --name
                         --resource-group
                         [--max-throughput]
                         [--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).

--throughput

The throughput of Table (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 table delete

Edit

Delete the Table under an Azure Cosmos DB account.

az cosmosdb table delete --account-name
                         --name
                         --resource-group
                         [--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

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

Edit

Checks if an Azure Cosmos DB table exists.

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

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

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

Edit

List the Tables under an Azure Cosmos DB account.

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

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

Edit

Restore a deleted table within the same account.

az cosmosdb table restore --account-name
                          --resource-group
                          --table-name
                          [--restore-timestamp]

Examples

Restore a deleted table within the same account.

az cosmosdb table restore --resource-group resource_group --account-name database_account_name --table-name name_of_table_needs_to_be_restored --restore-timestamp 2020-07-13T16:03:41+0000

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

--table-name -n

Name of the CosmosDB Table name.

Optional Parameters

--restore-timestamp -t

The timestamp to which the Table needs to be restored to.

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 table restore (cosmosdb-preview extension)

Preview

This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Restore a deleted table within the same account.

az cosmosdb table restore --account-name
                          --resource-group
                          --table-name
                          [--disable-ttl {false, true}]
                          [--restore-timestamp]

Examples

Restore a deleted table within the same account.

az cosmosdb table restore --resource-group resource_group --account-name database_account_name --table-name name_of_table_needs_to_be_restored --restore-timestamp 2020-07-13T16:03:41+0000

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

--table-name -n

Name of the CosmosDB Table name.

Optional Parameters

--disable-ttl
Preview

Enable or disable restoring with ttl disabled.

accepted values: false, true
--restore-timestamp -t

The timestamp to which the Table needs to be restored to.

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 table retrieve-latest-backup-time

Edit

Retrieves latest restorable timestamp for the given table in given region.

az cosmosdb table retrieve-latest-backup-time --account-name
                                              --location
                                              --resource-group
                                              --table-name

Required Parameters

--account-name -a

Name of the CosmosDB database account.

--location -l

Location of the account.

--resource-group -g

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

--table-name -n

Name of the CosmosDB Table 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 table retrieve-latest-backup-time (cosmosdb-preview extension)

Preview

This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Retrieves latest restorable timestamp for the given table in given region.

az cosmosdb table retrieve-latest-backup-time --account-name
                                              --location
                                              --resource-group
                                              --table-name

Required Parameters

--account-name -a

Name of the CosmosDB database account.

--location -l

Location of the account.

--resource-group -g

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

--table-name -n

Name of the CosmosDB Table 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 table show

Edit

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

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

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

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.