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

--name -n

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

--type

The type of account key.

accepted values: connection-strings, keys, read-only-keys
default value: keys

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

--key-kind

The access key to regenerate.

accepted values: primary, primaryReadonly, secondary, secondaryReadonly

Optional Parameters

--ids

One or more resource IDs (space-delimited). If provided, no other 'Resource Id' arguments should be specified.

--name -n

Name of the Cosmos DB database account.

--resource-group -g

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

--subscription

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