az cosmosdb sql

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 SQL resources of Azure Cosmos DB account.

Commands

Name Description Type Status
az cosmosdb sql container

Manage Azure Cosmos DB SQL containers.

Core and Extension GA
az cosmosdb sql container create

Create an SQL container under an Azure Cosmos DB SQL database.

Core GA
az cosmosdb sql container create (cosmosdb-preview extension)

Create an SQL container under an Azure Cosmos DB SQL database.

Extension GA
az cosmosdb sql container delete

Delete the SQL container under an Azure Cosmos DB SQL database.

Core GA
az cosmosdb sql container exists

Checks if an Azure Cosmos DB SQL container exists.

Core GA
az cosmosdb sql container list

List the SQL containers under an Azure Cosmos DB SQL database.

Core GA
az cosmosdb sql container merge

Merges the partitions of a sql container.

Extension Preview
az cosmosdb sql container redistribute-partition-throughput

Redistributes the partition throughput of a sql container.

Extension Preview
az cosmosdb sql container restore

Restore a deleted sql container within the same account.

Core GA
az cosmosdb sql container restore (cosmosdb-preview extension)

Restore a deleted sql container within the same account.

Extension Preview
az cosmosdb sql container retrieve-partition-throughput

Retrieve the partition throughput of a sql container.

Extension Preview
az cosmosdb sql container show

Show the details of a SQL container under an Azure Cosmos DB SQL database.

Core GA
az cosmosdb sql container throughput

Manage throughput of SQL container under an Azure Cosmos DB account.

Core GA
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 update

Update an SQL container under an Azure Cosmos DB SQL database.

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

Update an SQL container under an Azure Cosmos DB SQL database.

Extension GA
az cosmosdb sql database

Manage Azure Cosmos DB SQL databases.

Core and Extension GA
az cosmosdb sql database create

Create an SQL database under an Azure Cosmos DB account.

Core GA
az cosmosdb sql database delete

Delete the SQL database under an Azure Cosmos DB account.

Core GA
az cosmosdb sql database exists

Checks if an Azure Cosmos DB SQL database exists.

Core GA
az cosmosdb sql database list

List the SQL databases under an Azure Cosmos DB account.

Core GA
az cosmosdb sql database merge

Merge the partitions of a sql database.

Extension Preview
az cosmosdb sql database restore

Restore a deleted sql database within the same account.

Core GA
az cosmosdb sql database restore (cosmosdb-preview extension)

Restore a deleted sql database within the same account.

Extension Preview
az cosmosdb sql database show

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

Core GA
az cosmosdb sql database throughput

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

Core GA
az cosmosdb sql database throughput migrate

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

Core GA
az cosmosdb sql database throughput show

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

Core GA
az cosmosdb sql database throughput update

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

Core GA
az cosmosdb sql restorable-container

Manage different versions of sql containers that are restorable in a database of a Azure Cosmos DB account.

Core and Extension GA
az cosmosdb sql restorable-container list

List all the versions of all the sql containers that were created / modified / deleted in the given database and restorable account.

Core GA
az cosmosdb sql restorable-container list (cosmosdb-preview extension)

List all the versions of all the sql containers that were created / modified / deleted in the given database and restorable account.

Extension Preview
az cosmosdb sql restorable-database

Manage different versions of sql databases that are restorable in a Azure Cosmos DB account.

Core GA
az cosmosdb sql restorable-database list

List all the versions of all the sql databases that were created / modified / deleted in the given restorable account.

Core GA
az cosmosdb sql restorable-resource

Manage the databases and its containers that can be restored in the given account at the given timesamp and region.

Core GA
az cosmosdb sql restorable-resource list

List all the databases and its containers that can be restored in the given account at the given timesamp and region.

Core GA
az cosmosdb sql retrieve-latest-backup-time

Retrieves latest restorable timestamp for the given sql container in given region.

Core GA
az cosmosdb sql role

Manage Azure Cosmos DB SQL role resources.

Core GA
az cosmosdb sql role assignment

Manage Azure Cosmos DB SQL role assignments.

Core GA
az cosmosdb sql role assignment create

Create a SQL role assignment under an Azure Cosmos DB account.

Core GA
az cosmosdb sql role assignment delete

Delete a SQL role assignment under an Azure Cosmos DB account.

Core GA
az cosmosdb sql role assignment exists

Check if an Azure Cosmos DB role assignment exists.

Core GA
az cosmosdb sql role assignment list

List all SQL role assignments under an Azure Cosmos DB account.

Core GA
az cosmosdb sql role assignment show

Show the properties of a SQL role assignment under an Azure Cosmos DB account.

Core GA
az cosmosdb sql role assignment update

Update a SQL role assignment under an Azure Cosmos DB account.

Core GA
az cosmosdb sql role assignment wait

Poll on a SQL role assignment until a specific condition is met.

Core GA
az cosmosdb sql role definition

Manage Azure Cosmos DB SQL role definitions.

Core GA
az cosmosdb sql role definition create

Create a SQL role definition under an Azure Cosmos DB account.

Core GA
az cosmosdb sql role definition delete

Delete a SQL role definition under an Azure Cosmos DB account.

Core GA
az cosmosdb sql role definition exists

Check if an Azure Cosmos DB role definition exists.

Core GA
az cosmosdb sql role definition list

List all SQL role definitions under an Azure Cosmos DB account.

Core GA
az cosmosdb sql role definition show

Show the properties of a SQL role definition under an Azure Cosmos DB account.

Core GA
az cosmosdb sql role definition update

Update a SQL role definition under an Azure Cosmos DB account.

Core GA
az cosmosdb sql role definition wait

Poll on a SQL role definition until a specific condition is met.

Core GA
az cosmosdb sql stored-procedure

Manage Azure Cosmos DB SQL stored procedures.

Core GA
az cosmosdb sql stored-procedure create

Create an SQL stored procedure under an Azure Cosmos DB SQL container.

Core GA
az cosmosdb sql stored-procedure delete

Delete the SQL stored procedure under an Azure Cosmos DB SQL container.

Core GA
az cosmosdb sql stored-procedure list

List the SQL stored procedures under an Azure Cosmos DB SQL container.

Core GA
az cosmosdb sql stored-procedure show

Show the details of a SQL stored procedure under an Azure Cosmos DB SQL container.

Core GA
az cosmosdb sql stored-procedure update

Creates or Updates an Azure Cosmos DB SQL stored procedure.

Core GA
az cosmosdb sql trigger

Manage Azure Cosmos DB SQL triggers.

Core GA
az cosmosdb sql trigger create

Create an SQL trigger under an Azure Cosmos DB SQL container.

Core GA
az cosmosdb sql trigger delete

Delete the SQL trigger under an Azure Cosmos DB SQL container.

Core GA
az cosmosdb sql trigger list

List the SQL triggers under an Azure Cosmos DB SQL container.

Core GA
az cosmosdb sql trigger show

Show the details of a SQL trigger under an Azure Cosmos DB SQL container.

Core GA
az cosmosdb sql trigger update

Updates an Azure Cosmos DB SQL trigger.

Core GA
az cosmosdb sql user-defined-function

Manage Azure Cosmos DB SQL user defined functions.

Core GA
az cosmosdb sql user-defined-function create

Create an SQL user defined function under an Azure Cosmos DB SQL container.

Core GA
az cosmosdb sql user-defined-function delete

Delete the SQL user defined function under an Azure Cosmos DB SQL container.

Core GA
az cosmosdb sql user-defined-function list

List the SQL user defined functions under an Azure Cosmos DB SQL container.

Core GA
az cosmosdb sql user-defined-function show

Show the details of a SQL user defined function under an Azure Cosmos DB SQL container.

Core GA
az cosmosdb sql user-defined-function update

Creates or Updates an Azure Cosmos DB SQL user defined function.

Core GA

az cosmosdb sql retrieve-latest-backup-time

Retrieves latest restorable timestamp for the given sql container in given region.

az cosmosdb sql retrieve-latest-backup-time --account-name
                                            --container-name
                                            --database-name
                                            --location
                                            --resource-group

Required Parameters

--account-name -a

Name of the CosmosDB database account.

--container-name -c

Name of the CosmosDB Sql container name.

--database-name -d

Name of the CosmosDB Sql database name.

--location -l

Location of the account.

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