Accounts - List Keys

Списки ключи учетной записи для указанной учетной записи Cognitive Services.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/listKeys?api-version=2023-05-01

Параметры URI

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

string

Имя учетной записи Cognitive Services.

Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$

resourceGroupName
path True

string

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

subscriptionId
path True

string

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

api-version
query True

string

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

Ответы

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

ApiKeys

Возвращает текст ответа, содержащий ключи подписки для ресурса: key1 — первый ключ API для проверки подлинности при вызове клиентом конечной точки API.

key2 — второй ключ API для проверки подлинности, когда клиент вызывает конечную точку API.

Other Status Codes

ErrorResponse

Сообщение об ошибке с описанием причины сбоя операции.

Примеры

List Keys

Sample Request

POST https://management.azure.com/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/myAccount/listKeys?api-version=2023-05-01

Sample Response

{
  "key1": "KEY1",
  "key2": "KEY2"
}

Определения

Имя Описание
ApiKeys

Ключи доступа для учетной записи Cognitive Services.

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

ErrorDetail

Сведения об ошибке.

ErrorResponse

Сообщение об ошибке

ApiKeys

Ключи доступа для учетной записи Cognitive Services.

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

string

Возвращает значение ключа 1.

key2

string

Возвращает значение ключа 2.

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

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

object

Дополнительные сведения.

type

string

Тип дополнительных сведений.

ErrorDetail

Сведения об ошибке.

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

ErrorAdditionalInfo[]

Дополнительные сведения об ошибке.

code

string

Код ошибки.

details

ErrorDetail[]

Сведения об ошибке.

message

string

Сообщение об ошибке.

target

string

Целевой объект ошибки.

ErrorResponse

Сообщение об ошибке

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

ErrorDetail

Объект ошибки.