az cosmosdb keys
Manage Azure Comsos DB keys.
Commands
az cosmosdb keys list |
List the access keys or connection strings for a Azure Cosmos DB database account. |
az cosmosdb keys regenerate |
Regenerates an access key for the specified Azure Cosmos DB database account. |
az cosmosdb keys list
List the access keys or connection strings for a Azure Cosmos DB database account.
az cosmosdb keys list --name
--resource-group
[--query-examples]
[--subscription]
[--type {connection-strings, keys, read-only-keys}]
Examples
List the access keys or connection strings for a Azure Cosmos DB database account. (autogenerated)
az cosmosdb keys list --name MyCosmosDBDatabaseAccount --resource-group MyResourceGroup --subscription MySubscription --type keys
Required Parameters
Cosmosdb account 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
.
The type of account key.
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 keys regenerate
Regenerates an access key for the specified Azure Cosmos DB database account.
az cosmosdb keys regenerate --key-kind {primary, primaryReadonly, secondary, secondaryReadonly}
[--ids]
[--name]
[--resource-group]
[--subscription]
Required Parameters
The access key to regenerate.
Optional Parameters
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Name of the Cosmos DB database account.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
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.