az cosmosdb mongodb database

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 Azure Cosmos DB MongoDB databases.

Commands

Name	Description	Type	Status
az cosmosdb mongodb database create	Create an MongoDB database under an Azure Cosmos DB account.	Core	GA
az cosmosdb mongodb database delete	Delete the MongoDB database under an Azure Cosmos DB account.	Core	GA
az cosmosdb mongodb database exists	Checks if an Azure Cosmos DB MongoDB database exists.	Core	GA
az cosmosdb mongodb database list	List the MongoDB databases under an Azure Cosmos DB account.	Core	GA
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.	Core	GA
az cosmosdb mongodb database restore (cosmosdb-preview extension)	Restore a deleted mongodb database within the same account.	Extension	Preview
az cosmosdb mongodb database show	Show the details of a MongoDB database under an Azure Cosmos DB account.	Core	GA
az cosmosdb mongodb database throughput	Manage throughput of MongoDB database under an Azure Cosmos DB account.	Core	GA
az cosmosdb mongodb database throughput migrate	Migrate the throughput of the MongoDB database between autoscale and manually provisioned.	Core	GA
az cosmosdb mongodb database throughput show	Get the throughput of the MongoDB database under an Azure Cosmos DB account.	Core	GA
az cosmosdb mongodb database throughput update	Update the throughput of the MongoDB database under an Azure Cosmos DB account.	Core	GA

az cosmosdb mongodb database create

Edit

Create an MongoDB database under an Azure Cosmos DB account.

az cosmosdb mongodb database create --account-name
                                    --name
                                    --resource-group
                                    [--max-throughput]
                                    [--throughput]

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

--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 MongoDB database (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 mongodb database delete

Edit

Delete the MongoDB database under an Azure Cosmos DB account.

az cosmosdb mongodb database delete --account-name
                                    --name
                                    --resource-group
                                    [--yes]

Examples

Delete the MongoDB database under an Azure Cosmos DB account. (autogenerated)

az cosmosdb mongodb database delete --account-name MyAccount --name MyDatabase --resource-group MyResourceGroup

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

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

Edit

Checks if an Azure Cosmos DB MongoDB database exists.

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

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

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 list

Edit

List the MongoDB databases under an Azure Cosmos DB account.

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

Examples

List the MongoDB databases under an Azure Cosmos DB account. (autogenerated)

az cosmosdb mongodb database list --account-name MyAccount --resource-group MyResourceGroup

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

Edit

Restore a deleted mongodb database within the same account.

az cosmosdb mongodb database restore --account-name
                                     --name
                                     --resource-group
                                     [--disable-ttl]
                                     [--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

Flag to restore with TTL disabled.

Usage: --disable-ttl True Default: false.

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

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

az cosmosdb mongodb database show

Edit

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

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

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

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.

Share via

az cosmosdb mongodb database

Commands

az cosmosdb mongodb database create

Required Parameters

Optional Parameters

az cosmosdb mongodb database delete

Examples

Required Parameters

Optional Parameters

az cosmosdb mongodb database exists

Required Parameters

az cosmosdb mongodb database list

Examples

Required Parameters

az cosmosdb mongodb database merge

Examples

Required Parameters

az cosmosdb mongodb database restore

Examples

Required Parameters

Optional Parameters

az cosmosdb mongodb database restore (cosmosdb-preview extension)

Examples

Required Parameters

Optional Parameters

az cosmosdb mongodb database show

Required Parameters

Additional resources