az cosmosdb service

Commands to perform operations on Service.

Commands

az cosmosdb service create	Create a cosmosdb service resource.
az cosmosdb service delete	Delete the given cosmosdb service resource.
az cosmosdb service list	List all cosmosdb service resource under an account.
az cosmosdb service show	Get cosmosdb service resource under an account.
az cosmosdb service update	Update a cosmosdb service resource.

az cosmosdb service create

Create a cosmosdb service resource.

az cosmosdb service create --account-name
                           --name
                           --resource-group-name
                           [--count]
                           [--no-wait]
                           [--size]

Examples

Create a cosmosdb service resource.

az cosmosdb service create --resource-group MyResourceGroup --account-name MyAccount --name "sqlDedicatedGateway" --count 3 --size "Cosmos.D4s"

Required Parameters

--account-name -a

Name of the Cosmos DB database account.

--name -n

Service Name.

--resource-group-name -g

Name of the resource group of the database account.

Optional Parameters

--count -c

Instance Count.

default value: 1

--no-wait

Do not wait for the long-running operation to finish.

default value: False

--size

Instance Size. Possible values are: Cosmos.D4s, Cosmos.D8s, Cosmos.D16s etc.

default value: Cosmos.D4s

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.

--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 service delete

Delete the given cosmosdb service resource.

az cosmosdb service delete --account-name
                           --name
                           --resource-group-name
                           [--no-wait]
                           [--yes]

Examples

Delete the given cosmosdb service resource.

az cosmosdb service delete --resource-group MyResourceGroup --account-name MyAccount --name "sqlDedicatedGateway"

Required Parameters

--account-name -a

Name of the Cosmos DB database account.

--name -n

Service Name.

--resource-group-name -g

Name of the resource group of the database account.

Optional Parameters

--no-wait

Do not wait for the long-running operation to finish.

default value: False

--yes -y

Do not prompt for confirmation.

default value: False

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.

--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 service list

List all cosmosdb service resource under an account.

az cosmosdb service list --account-name
                         --resource-group-name

Examples

List all cosmosdb service resource under an account.

az cosmosdb service list --resource-group MyResourceGroup --account-name MyAccount

Required Parameters

--account-name -a

Name of the Cosmos DB database account.

--resource-group-name -g

Name of the resource group of the database account.

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.

--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 service show

Get cosmosdb service resource under an account.

az cosmosdb service show --account-name
                         --name
                         --resource-group-name

Examples

Get cosmosdb service resource under an account.

az cosmosdb service show --resource-group MyResourceGroup --account-name MyAccount --name "sqlDedicatedGateway"

Required Parameters

--account-name -a

Name of the Cosmos DB database account.

--name -n

Service Name.

--resource-group-name -g

Name of the resource group of the database account.

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.

--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 service update

Update a cosmosdb service resource.

az cosmosdb service update --account-name
                           --count
                           --name
                           --resource-group-name
                           [--no-wait]
                           [--size]

Examples

Update a cosmosdb service resource.

az cosmosdb service update --resource-group MyResourceGroup --account-name MyAccount --name "sqlDedicatedGateway" --count 3

Required Parameters

--account-name -a

Name of the Cosmos DB database account.

--count -c

Instance Count.

--name -n

Service Name.

--resource-group-name -g

Name of the resource group of the database account.

Optional Parameters

--no-wait

Do not wait for the long-running operation to finish.

default value: False

--size

Instance Size. Possible values are: Cosmos.D4s, Cosmos.D8s, Cosmos.D16s etc.

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.

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