Share via


az cosmosdb sql container throughput

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 show

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

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

Experimental Preview Deprecated

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

Required Parameters

--account-name -a
Experimental Preview Deprecated

Cosmosdb account name.

--database-name -d
Experimental Preview Deprecated

Database name.

--name -n
Experimental Preview Deprecated

Container name.

--resource-group -g
Experimental Preview Deprecated

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--throughput-type -t
Experimental Preview Deprecated

The type of throughput to migrate to.

Accepted values: autoscale, manual

Optional Parameters

Global Parameters
--debug
Experimental Preview Deprecated

Increase logging verbosity to show all debug logs.

--help -h
Experimental Preview Deprecated

Show this help message and exit.

--only-show-errors
Experimental Preview Deprecated

Only show errors, suppressing warnings.

--output -o
Experimental Preview Deprecated

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query
Experimental Preview Deprecated

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription
Experimental Preview Deprecated

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

--verbose
Experimental Preview Deprecated

Increase logging verbosity. Use --debug for full debug logs.

az cosmosdb sql container throughput show

Experimental Preview Deprecated

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

Examples

Required Parameters

--account-name -a
Experimental Preview Deprecated

Cosmosdb account name.

--database-name -d
Experimental Preview Deprecated

Database name.

--name -n
Experimental Preview Deprecated

Container name.

--resource-group -g
Experimental Preview Deprecated

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

Global Parameters
--debug
Experimental Preview Deprecated

Increase logging verbosity to show all debug logs.

--help -h
Experimental Preview Deprecated

Show this help message and exit.

--only-show-errors
Experimental Preview Deprecated

Only show errors, suppressing warnings.

--output -o
Experimental Preview Deprecated

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query
Experimental Preview Deprecated

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription
Experimental Preview Deprecated

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

--verbose
Experimental Preview Deprecated

Increase logging verbosity. Use --debug for full debug logs.

az cosmosdb sql container throughput update

Experimental Preview Deprecated

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]

Examples

Required Parameters

--account-name -a
Experimental Preview Deprecated

Cosmosdb account name.

--database-name -d
Experimental Preview Deprecated

Database name.

--name -n
Experimental Preview Deprecated

Container name.

--resource-group -g
Experimental Preview Deprecated

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--max-throughput
Experimental Preview Deprecated

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
Experimental Preview Deprecated

The throughput of SQL container (RU/s).

Global Parameters
--debug
Experimental Preview Deprecated

Increase logging verbosity to show all debug logs.

--help -h
Experimental Preview Deprecated

Show this help message and exit.

--only-show-errors
Experimental Preview Deprecated

Only show errors, suppressing warnings.

--output -o
Experimental Preview Deprecated

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query
Experimental Preview Deprecated

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription
Experimental Preview Deprecated

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

--verbose
Experimental Preview Deprecated

Increase logging verbosity. Use --debug for full debug logs.