az cosmosdb sql database
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 sql database command. Learn more about extensions.
Manage Azure Cosmos DB SQL databases.
Commands
Name | Description | Type | Status |
---|---|---|---|
az cosmosdb sql database merge |
Merge the partitions of a sql database. |
Extension | Preview |
az cosmosdb sql database restore |
Restore a deleted sql database within the same account. |
Extension | Preview |
az cosmosdb sql database merge
This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Merge the partitions of a sql database.
az cosmosdb sql database merge --account-name
--name
--resource-group
Examples
Merge partitions of database my-database
az cosmosdb sql database merge -g my-resource-group -a my-account --name my-database
Required Parameters
Name of the CosmosDB database account.
Name of the CosmosDB database name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az cosmosdb sql database restore
This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Restore a deleted sql database within the same account.
az cosmosdb sql database restore --account-name
--name
--resource-group
[--disable-ttl {false, true}]
[--restore-timestamp]
Examples
Restore a deleted sql database within the same account.
az cosmosdb sql database restore --resource-group resource_group --account-name database_account_name --name name_of_database_needs_to_be_restored --restore-timestamp 2020-07-13T16:03:41+0000
Required Parameters
Cosmosdb account name.
Database name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
Enable or disable restoring with ttl disabled.
The timestamp to which the database needs to be restored to.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for