az cosmosdb keys
Manage Azure Cosmos DB keys.
Commands
Name | Description | Type | Status |
---|---|---|---|
az cosmosdb keys list |
List the access keys or connection strings for a Azure Cosmos DB database account. |
Core | GA |
az cosmosdb keys regenerate |
Regenerate an access key for a Azure Cosmos DB database account. |
Core | GA |
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
[--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
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
The type of account key.
Property | Value |
---|---|
Default value: | keys |
Accepted values: | connection-strings, keys, read-only-keys |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
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.
Property | Value |
---|---|
Default value: | False |
az cosmosdb keys regenerate
Regenerate an access key for a Azure Cosmos DB database account.
az cosmosdb keys regenerate --key-kind {primary, primaryReadonly, secondary, secondaryReadonly}
[--ids]
[--name]
[--resource-group]
[--subscription]
Examples
Regenerate primaryReadonly access key for a Azure Cosmos DB database account.
az cosmosdb keys regenerate --key-kind primaryReadonly --name MyCosmosDBDatabaseAccount --resource-group MyResourceGroup --subscription MySubscription
Required Parameters
The access key to regenerate.
Property | Value |
---|---|
Accepted values: | primary, primaryReadonly, secondary, secondaryReadonly |
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name of the Cosmos DB database account.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |