az cosmosdb sql database

  • Reference

Manage Azure Cosmos DB SQL databases.

Commands

az cosmosdb sql database create

Create an SQL database under an Azure Cosmos DB account.
az cosmosdb sql database delete

Delete the SQL database under an Azure Cosmos DB account.
az cosmosdb sql database exists

Checks if an Azure Cosmos DB SQL database exists.
az cosmosdb sql database list

List the SQL databases under an Azure Cosmos DB account.
az cosmosdb sql database show

Show the details of a SQL database under an Azure Cosmos DB account.
az cosmosdb sql database throughput

Manage throughput of SQL database under an Azure Cosmos DB account.
az cosmosdb sql database throughput migrate

Migrate the throughput of the SQL database between autoscale and manually provisioned.
az cosmosdb sql database throughput show

Get the throughput of the SQL database under an Azure Cosmos DB account.
az cosmosdb sql database throughput update

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

az cosmosdb sql database create

Edit

Create an SQL database under an Azure Cosmos DB account.

az cosmosdb sql database create --account-name
                                --name
                                --resource-group
                                [--max-throughput]
                                [--subscription]
                                [--throughput]

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

--subscription

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

--throughput

The throughput of SQL database (RU/s). Default value is 400.

az cosmosdb sql database delete

Edit

Delete the SQL database under an Azure Cosmos DB account.

az cosmosdb sql database delete --account-name
                                --name
                                --resource-group
                                [--subscription]
                                [--yes]

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

--subscription

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

--yes -y

Do not prompt for confirmation.

az cosmosdb sql database exists

Edit

Checks if an Azure Cosmos DB SQL database exists.

az cosmosdb sql database exists --account-name
                                --name
                                --resource-group
                                [--subscription]

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

--subscription

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

az cosmosdb sql database list

Edit

List the SQL databases under an Azure Cosmos DB account.

az cosmosdb sql database list --account-name
                              --resource-group
                              [--query-examples]
                              [--subscription]

Examples

List the SQL databases under an Azure Cosmos DB account (autogenerated)

az cosmosdb sql database list --account-name MyAccount --resource-group MyResourceGroup

Required Parameters

--account-name -a

Cosmosdb account name.

--resource-group -g

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

Optional Parameters

--query-examples

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.

--subscription

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

az cosmosdb sql database show

Edit

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

az cosmosdb sql database show --account-name
                              --name
                              --resource-group
                              [--query-examples]
                              [--subscription]

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

--query-examples

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.

--subscription

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