Share via

az cosmosdb sql container throughput

  • 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 throughput of SQL container under an Azure Cosmos DB account.

Commands

Name Description Type Status
az cosmosdb sql container throughput migrate

Migrate the throughput of the SQL container between autoscale and manually provisioned.

 Core GA
az cosmosdb sql container throughput migrate (cosmosdb-preview extension)

Migrate the throughput of the SQL container between autoscale and manually provisioned.

 Extension GA
az cosmosdb sql container throughput show

Get the throughput of the SQL container under an Azure Cosmos DB SQL database.

 Core GA
az cosmosdb sql container throughput show (cosmosdb-preview extension)

Get the throughput of the SQL container under an Azure Cosmos DB SQL database.

 Extension GA
az cosmosdb sql container throughput update

Update the throughput of the SQL container under an Azure Cosmos DB SQL database.

 Core GA
az cosmosdb sql container throughput update (cosmosdb-preview extension)

Update the throughput of the SQL container under an Azure Cosmos DB SQL database.

 Extension GA

az cosmosdb sql container throughput migrate

Edit

Migrate the throughput of the SQL container between autoscale and manually provisioned.

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

Required Parameters

--account-name -a

Cosmosdb account name.

--database-name -d

Database name.

--name -n

Container 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 sql container throughput migrate (cosmosdb-preview extension)

Migrate the throughput of the SQL container between autoscale and manually provisioned.

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

Examples

Migrate the throughput of the SQL container between autoscale and manually provisioned.

az cosmosdb sql container throughput migrate --resource-group resource_group --account-name database_account_name --database-name parent_database_name --name name_of_collection_needs_to_be_restored --throughput-type Manual

Required Parameters

--account-name -a

Cosmosdb account name.

--database-name -d

Database name.

--name -n

Container 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 sql container throughput show

Edit

Get the throughput of the SQL container under an Azure Cosmos DB SQL database.

az cosmosdb sql container throughput show --account-name
                                          --database-name
                                          --name
                                          --resource-group

Required Parameters

--account-name -a

Cosmosdb account name.

--database-name -d

Database name.

--name -n

Container 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 sql container throughput show (cosmosdb-preview extension)

Get the throughput of the SQL container under an Azure Cosmos DB SQL database.

az cosmosdb sql container throughput show --account-name
                                          --database-name
                                          --name
                                          --resource-group

Required Parameters

--account-name -a

Cosmosdb account name.

--database-name -d

Database name.

--name -n

Container 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 sql container throughput update

Edit

Update the throughput of the SQL container under an Azure Cosmos DB SQL database.

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

Required Parameters

--account-name -a

Cosmosdb account name.

--database-name -d

Database name.

--name -n

Container 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 SQL container (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.

az cosmosdb sql container throughput update (cosmosdb-preview extension)

Update the throughput of the SQL container under an Azure Cosmos DB SQL database.

az cosmosdb sql container throughput update --account-name
                                            --database-name
                                            --name
                                            --resource-group
                                            [--max-throughput]
                                            [--throughput]
                                            [--throughput-buckets]

Examples

Update the throughput of the SQL container under an Azure Cosmos DB SQL database.

az cosmosdb sql container throughput update --resource-group resource_group --account-name database_account_name --database-name parent_database_name --name name_of_collection_needs_to_be_restored --throughput 1000

Required Parameters

--account-name -a

Cosmosdb account name.

--database-name -d

Database name.

--name -n

Container 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 SQL container (RU/s).

--throughput-buckets

Throughput Buckets, you can enter it as a string or as a file, e.g., --throughput-buckets @throughput-buckets-file.json or --throughput-buckets "[ { "id": 1, "maxThroughputPercentage" : 10 }, { "id": 2, "maxThroughputPercentage" : 20 } ]".

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.