Share via


az cosmosdb table

Note

This reference is part of the cosmosdb-preview extension for the Azure CLI (version 2.17.1 or higher). The extension will automatically install the first time you run an az cosmosdb table command. Learn more about extensions.

Manage Table resources of Azure Cosmos DB account.

Commands

Name Description Type Status
az cosmosdb table restorable-resource

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

Extension Preview
az cosmosdb table restorable-resource list

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.

Extension Preview
az cosmosdb table restorable-table list

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.

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

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

Extension Preview

az cosmosdb table restore

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

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.