az cosmosdb service
Note
This reference is part of the cosmosdb-preview extension for the Azure CLI (version 2.17.1 or higher). The extension will automatically install the first time you run an az cosmosdb service command. Learn more about extensions.
This command group is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Commands to perform operations on Service.
Commands
Name | Description | Type | Status |
---|---|---|---|
az cosmosdb service create |
Create a cosmosdb service resource. |
Extension | Preview |
az cosmosdb service delete |
Delete the given cosmosdb service resource. |
Extension | Preview |
az cosmosdb service list |
List all cosmosdb service resource under an account. |
Extension | Preview |
az cosmosdb service show |
Get cosmosdb service resource under an account. |
Extension | Preview |
az cosmosdb service update |
Update a cosmosdb service resource. |
Extension | Preview |
az cosmosdb service create
Command group 'cosmosdb service' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Create a cosmosdb service resource.
az cosmosdb service create --account-name
--kind
--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" --kind "SqlDedicatedGateway" --count 3 --size "Cosmos.D4s"
Create a cosmosdb materialized views builder service resource.
az cosmosdb service create --resource-group MyResourceGroup --account-name MyAccount --name "MaterializedViewsBuilder" --kind "MaterializedViewsBuilder" --count 3 --size "Cosmos.D4s"
Required Parameters
Name of the Cosmos DB database account.
Service kind.
Service Name.
Name of the resource group of the database account.
Optional Parameters
Instance Count.
Do not wait for the long-running operation to finish.
Instance Size. Possible values are: Cosmos.D4s, Cosmos.D8s, Cosmos.D16s etc.
Global Parameters
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.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az cosmosdb service delete
Command group 'cosmosdb service' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
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"
Delete the cosmosdb materialized views builder service resource.
az cosmosdb service delete --resource-group MyResourceGroup --account-name MyAccount --name "MaterializedViewsBuilder"
Required Parameters
Name of the Cosmos DB database account.
Service Name.
Name of the resource group of the database account.
Optional Parameters
Do not wait for the long-running operation to finish.
Do not prompt for confirmation.
Global Parameters
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.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az cosmosdb service list
Command group 'cosmosdb service' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
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
Name of the Cosmos DB database account.
Name of the resource group of the database account.
Global Parameters
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.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az cosmosdb service show
Command group 'cosmosdb service' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
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
Name of the Cosmos DB database account.
Service Name.
Name of the resource group of the database account.
Global Parameters
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.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az cosmosdb service update
Command group 'cosmosdb service' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Update a cosmosdb service resource.
az cosmosdb service update --account-name
--count
--kind
--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" --kind "SqlDedicatedGateway" --count 3
Update a cosmosdb materialized views builder service resource.
az cosmosdb service update --resource-group MyResourceGroup --account-name MyAccount --name "MaterializedViewsBuilder" --kind "MaterializedViewsBuilder" --count 3
Required Parameters
Name of the Cosmos DB database account.
Instance Count.
Service kind.
Service Name.
Name of the resource group of the database account.
Optional Parameters
Do not wait for the long-running operation to finish.
Instance Size. Possible values are: Cosmos.D4s, Cosmos.D8s, Cosmos.D16s etc.
Global Parameters
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.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for