az cosmosdb mongodb database

Manage Azure Cosmos DB MongoDB databases.

Commands

az cosmosdb mongodb database create

Create an MongoDB database under an Azure Cosmos DB account.

az cosmosdb mongodb database delete

Delete the MongoDB database under an Azure Cosmos DB account.

az cosmosdb mongodb database exists

Checks if an Azure Cosmos DB MongoDB database exists.

az cosmosdb mongodb database list

List the MongoDB databases under an Azure Cosmos DB account.

az cosmosdb mongodb database show

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

az cosmosdb mongodb database throughput

Manage throughput of MongoDB database under an Azure Cosmos DB account.

az cosmosdb mongodb database throughput migrate

Migrate the throughput of the MongoDB database between autoscale and manually provisioned.

az cosmosdb mongodb database throughput show

Get the throughput of the MongoDB database under an Azure Cosmos DB account.

az cosmosdb mongodb database throughput update

Update the throughput of the MongoDB database under an Azure Cosmos DB account.

az cosmosdb mongodb database create

Create an MongoDB database under an Azure Cosmos DB account.

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

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--throughput

The throughput of MongoDB database (RU/s). Default value is 400.

az cosmosdb mongodb database delete

Delete the MongoDB database under an Azure Cosmos DB account.

az cosmosdb mongodb database delete --account-name
                                    --name
                                    --resource-group
                                    [--subscription]
                                    [--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

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--yes -y

Do not prompt for confirmation.

az cosmosdb mongodb database exists

Checks if an Azure Cosmos DB MongoDB database exists.

az cosmosdb mongodb database exists --account-name
                                    --name
                                    --resource-group
                                    [--subscription]

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

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az cosmosdb mongodb database list

List the MongoDB databases under an Azure Cosmos DB account.

az cosmosdb mongodb database list --account-name
                                  --resource-group
                                  [--query-examples]
                                  [--subscription]

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

Optional Parameters

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az cosmosdb mongodb database show

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

az cosmosdb mongodb database show --account-name
                                  --name
                                  --resource-group
                                  [--query-examples]
                                  [--subscription]

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

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.