Database Accounts - List Keys

Reference

Service:: Cosmos DB Resource Provider

API Version:: 2024-11-15

Lists the access keys for the specified Azure Cosmos DB database account.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/listKeys?api-version=2024-11-15

URI Parameters

Name	In	Required	Type	Description
accountName	path	True	string	Cosmos DB database account name. Regex pattern: `^[a-z0-9]+(-[a-z0-9]+)*`
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string	The ID of the target subscription.
api-version	query	True	string	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	DatabaseAccountListKeysResult	The operation completed successfully.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	Impersonate your user account

Examples

CosmosDBDatabaseAccountListKeys

Sample request

HTTP

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/listKeys?api-version=2024-11-15

Sample response

Status code:: 200

{
  "primaryMasterKey": "primaryMasterKey",
  "secondaryMasterKey": "secondaryMasterKey",
  "primaryReadonlyMasterKey": "primaryReadonlyMasterKey",
  "secondaryReadonlyMasterKey": "secondaryReadonlyMasterKey"
}

Definitions

DatabaseAccountListKeysResult

The access keys for the given database account.

Name	Type	Description
primaryMasterKey	string	Base 64 encoded value of the primary read-write key.
primaryReadonlyMasterKey	string	Base 64 encoded value of the primary read-only key.
secondaryMasterKey	string	Base 64 encoded value of the secondary read-write key.
secondaryReadonlyMasterKey	string	Base 64 encoded value of the secondary read-only key.

Share via