az cosmosdb sql container
Manage Azure Cosmos DB SQL containers.
Commands
az cosmosdb sql container create |
Create an SQL container under an Azure Cosmos DB SQL database. |
az cosmosdb sql container delete |
Delete the SQL container under an Azure Cosmos DB SQL database. |
az cosmosdb sql container exists |
Checks if an Azure Cosmos DB SQL container exists. |
az cosmosdb sql container list |
List the SQL containers under an Azure Cosmos DB SQL database. |
az cosmosdb sql container show |
Show the details of a SQL container under an Azure Cosmos DB SQL database. |
az cosmosdb sql container throughput |
Manage throughput of SQL container under an Azure Cosmos DB account. |
az cosmosdb sql container throughput migrate |
Migrate the throughput of the SQL container between autoscale and manually provisioned. |
az cosmosdb sql container throughput show |
Get the throughput of the SQL container under an Azure Cosmos DB SQL database. |
az cosmosdb sql container throughput update |
Update the throughput of the SQL container under an Azure Cosmos DB SQL database. |
az cosmosdb sql container update |
Update an SQL container under an Azure Cosmos DB SQL database. |
az cosmosdb sql container create
Create an SQL container under an Azure Cosmos DB SQL database.
az cosmosdb sql container create --account-name
--database-name
--name
--partition-key-path
--resource-group
[--conflict-resolution-policy]
[--idx]
[--max-throughput]
[--partition-key-version]
[--subscription]
[--throughput]
[--ttl]
[--unique-key-policy]
Examples
Create an Azure Cosmos DB SQL container.
az cosmosdb sql container create -g MyResourceGroup -a MyAccount -d MyDatabase -n MyContainer --partition-key-path "/my/path" --idx @policy-file.json --ttl 1000 --throughput "700"
Required Parameters
Cosmosdb account name.
Database name.
Container name.
Partition Key Path, e.g., '/address/zipcode'.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
Conflict Resolution Policy, you can enter it as a string or as a file, e.g., --conflict-resolution-policy @policy-file.json or --conflict-resolution-policy "{"mode": "lastWriterWins", "conflictResolutionPath": "/path"}".
Indexing Policy, you can enter it as a string or as a file, e.g., --idx @policy-file.json or --idx "{"indexingMode": "consistent", "automatic": true, "includedPaths": [{"path": "/*"}], "excludedPaths": [{ "path": "/headquarters/employees/?"}, { "path": "/"_etag"/?"}]}".
The maximum throughput resource can scale to (RU/s). Provided when the resource is autoscale enabled. The minimum value can be 4000 (RU/s).
The version of partition key.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
The throughput of SQL container (RU/s). Default value is 400. Omit this parameter if the database has shared throughput unless the container should have dedicated throughput.
Default TTL. If the value is missing or set to "-1", items don’t expire. If the value is set to "n", items will expire "n" seconds after last modified time.
Unique Key Policy, you can enter it as a string or as a file, e.g., --unique-key-policy @policy-file.json or --unique-key-policy "{"uniqueKeys": [{"paths": ["/path/to/key1"]}, {"paths": ["/path/to/key2"]}]}".
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
az cosmosdb sql container delete
Delete the SQL container under an Azure Cosmos DB SQL database.
az cosmosdb sql container delete --account-name
--database-name
--name
--resource-group
[--subscription]
[--yes]
Required Parameters
Cosmosdb account name.
Database name.
Container name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Do not prompt for confirmation.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
az cosmosdb sql container exists
Checks if an Azure Cosmos DB SQL container exists.
az cosmosdb sql container exists --account-name
--database-name
--name
--resource-group
[--subscription]
Required Parameters
Cosmosdb account name.
Database name.
Container name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
az cosmosdb sql container list
List the SQL containers under an Azure Cosmos DB SQL database.
az cosmosdb sql container list --account-name
--database-name
--resource-group
[--query-examples]
[--subscription]
Required Parameters
Cosmosdb account name.
Database name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
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.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
az cosmosdb sql container show
Show the details of a SQL container under an Azure Cosmos DB SQL database.
az cosmosdb sql container show --account-name
--database-name
--name
--resource-group
[--query-examples]
[--subscription]
Required Parameters
Cosmosdb account name.
Database name.
Container name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
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.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
az cosmosdb sql container update
Update an SQL container under an Azure Cosmos DB SQL database.
az cosmosdb sql container update --account-name
--database-name
--name
--resource-group
[--idx]
[--subscription]
[--ttl]
Required Parameters
Cosmosdb account name.
Database name.
Container name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
Indexing Policy, you can enter it as a string or as a file, e.g., --idx @policy-file.json or --idx "{"indexingMode": "consistent", "automatic": true, "includedPaths": [{"path": "/*"}], "excludedPaths": [{ "path": "/headquarters/employees/?"}, { "path": "/"_etag"/?"}]}".
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Default TTL. If the value is missing or set to "-1", items don’t expire. If the value is set to "n", items will expire "n" seconds after last modified time.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.