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


Database Accounts - List Keys

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

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

Параметры URI

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

string

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

Шаблон регулярного выражения: ^[a-z0-9]+(-[a-z0-9]+)*

resourceGroupName
path True

string

Имя группы ресурсов. Регистр букв в имени не учитывается.

subscriptionId
path True

string

Идентификатор целевой подписки.

api-version
query True

string

Версия 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=2024-05-15

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

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

Определения

DatabaseAccountListKeysResult

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

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

string

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

primaryReadonlyMasterKey

string

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

secondaryMasterKey

string

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

secondaryReadonlyMasterKey

string

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