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


Accounts - List Keys

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

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

Параметры URI

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

string

minLength: 2
maxLength: 64
pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$

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

resourceGroupName
path True

string

minLength: 1
maxLength: 90

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

subscriptionId
path True

string

minLength: 1

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

api-version
query True

string

minLength: 1

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

Ответы

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

ApiKeys

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

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

Other Status Codes

ErrorResponse

Ответ на ошибку, описывающий причину сбоя операции

Примеры

List Keys

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

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

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

{
  "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

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