Share via

az cosmosdb mongodb database

  • Reference

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 mongodb database command. Learn more about extensions.

Manage Azure Cosmos DB MongoDB databases.

Commands

Name Description Type Status
az cosmosdb mongodb database merge

Merges the partitions of a mongodb database.

 Extension Preview
az cosmosdb mongodb database restore

Restore a deleted mongodb database within the same account.

 Extension Preview

az cosmosdb mongodb database merge

Preview

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

Merges the partitions of a mongodb database.

az cosmosdb mongodb database merge --account-name
                                   --name
                                   --resource-group

Examples

merge partitions of database my-mongodb-database

az cosmosdb mongodb database merge -g my-resource-group -a my-account --name my-mongodb-collection

Required Parameters

--account-name -a

Name of the CosmosDB database account.

--name -n

Name of the mongoDB database.

--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 mongodb database restore

Preview

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

Restore a deleted mongodb database within the same account.

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

Examples

Restore a deleted mongodb database within the same account.

az cosmosdb mongodb 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

--account-name -a

Cosmosdb account name.

--name -n

Database name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<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 database 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.