Поделиться через

Database Accounts - List Keys

Служба:
Cosmos DB Resource Provider
Версия API:
2025-10-15

Список ключей доступа для указанной учетной записи базы данных Azure Cosmos DB.

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

Параметры URI

Имя В Обязательно Тип Описание
accountName
 path True

string

minLength: 3
maxLength: 50
pattern: ^[a-z0-9]+(-[a-z0-9]+)*

Имя учетной записи базы данных Cosmos DB.
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

Имя группы ресурсов. Имя не зависит от регистра.
subscriptionId
 path True

string

minLength: 1

Идентификатор целевой подписки.
api-version
 query True

string

minLength: 1

Версия API, используемая для данной операции.

Ответы

Имя Тип Описание
200 OK

DatabaseAccountListKeysResult

Операция успешно завершена.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя Описание
user_impersonation Олицетворения учетной записи пользователя

Примеры

CosmosDBDatabaseAccountListKeys

Образец запроса

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

Пример ответа

Код состояния:
200 
{
  "primaryMasterKey": "primaryMasterKey",
  "secondaryMasterKey": "secondaryMasterKey",
  "primaryReadonlyMasterKey": "primaryReadonlyMasterKey",
  "secondaryReadonlyMasterKey": "secondaryReadonlyMasterKey"
}

Определения

DatabaseAccountListKeysResult

Object

Ключи доступа для данной учетной записи базы данных.

Имя Тип Описание
primaryMasterKey

string

Основание 64 закодированное значение первичного ключа чтения-записи.
primaryReadonlyMasterKey

string

Основание 64 Закодированное значение первичного ключа только для чтения.
secondaryMasterKey

string

Закодированное по основанию 64 значение вторичного ключа чтения-записи.
secondaryReadonlyMasterKey

string

Закодированное по умолчанию 64 значение вторичного ключа, доступного только для чтения.