Share via

az cosmosdb mongodb database throughput

  • Reference

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

Commands

Name Description Type Status
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 throughput migrate

Edit

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

az cosmosdb mongodb database throughput migrate --account-name
                                                --name
                                                --resource-group
                                                --throughput-type {autoscale, manual}

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

--throughput-type -t

The type of throughput to migrate to.

Accepted values: autoscale, manual
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 throughput show

Edit

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

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

az cosmosdb mongodb database throughput update

Edit

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

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

Examples

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

az cosmosdb mongodb database throughput update --account-name MyAccount --name MyDatabase --resource-group MyResourceGroup --throughput "500"

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

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.