Database Accounts - Get Read Only Keys
Lists the read-only access keys for the specified Azure Cosmos DB database account.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/readonlykeys?api-version=2024-08-15
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
account
|
path | True |
string |
Cosmos DB database account name. Regex pattern: |
resource
|
path | True |
string |
The name of the resource group. The name is case insensitive. |
subscription
|
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 |
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
CosmosDBDatabaseAccountListReadOnlyKeys
Sample request
Sample response
{
"primaryReadonlyMasterKey": "primaryReadonlyMasterKey",
"secondaryReadonlyMasterKey": "secondaryReadonlyMasterKey"
}
Definitions
DatabaseAccountListReadOnlyKeysResult
The read-only access keys for the given database account.
Name | Type | Description |
---|---|---|
primaryReadonlyMasterKey |
string |
Base 64 encoded value of the primary read-only key. |
secondaryReadonlyMasterKey |
string |
Base 64 encoded value of the secondary read-only key. |