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

Admin Keys - Get

Служба:
Search Management
Версия API:
2025-05-01

Возвращает ключи API первичного и дополнительного администратора для указанной службы поиска ИИ Azure.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/listAdminKeys?api-version=2025-05-01

Параметры URI

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

string

minLength: 1
maxLength: 90

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

string

pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$

Имя службы поиска ИИ Azure, связанной с указанной группой ресурсов.
subscriptionId
 path True

string (uuid)

Идентификатор целевой подписки. Значение должно быть Универсальным Уникальным Идентификатором (UUID).
api-version
 query True

string

minLength: 1

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

Заголовок запроса

Имя Обязательно Тип Описание
x-ms-client-request-id

string (uuid)

Значение GUID, созданное клиентом, идентифицирующее этот запрос. Если этот параметр указан, он будет включен в сведения о ответе в качестве способа отслеживания запроса.

Ответы

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

AdminKeyResult

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

CloudError

Непредвиденное сообщение об ошибке.

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

azure_auth

Поток OAuth2 в Azure Active Directory.

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

Области

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

Примеры

SearchGetAdminKeys

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

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/listAdminKeys?api-version=2025-05-01

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

Код состояния:
200 
{
  "primaryKey": "<your primary admin API key>",
  "secondaryKey": "<your secondary admin API key>"
}

Определения

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

Ответ, содержащий ключи API первичного и дополнительного администратора для данной службы поиска ИИ Azure.
CloudError

Содержит сведения об ошибке API.
CloudErrorBody

Описывает определенную ошибку API с кодом ошибки и сообщением.

AdminKeyResult

Объект

Ответ, содержащий ключи API первичного и дополнительного администратора для данной службы поиска ИИ Azure.

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

string

Ключ API первичного администратора службы поиска.
secondaryKey

string

Ключ API вторичного администратора службы поиска.

CloudError

Объект

Содержит сведения об ошибке API.

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

CloudErrorBody

Описывает определенную ошибку API с кодом ошибки и сообщением.
message

string

Краткое описание ошибки, которая указывает на то, что пошло не так (для получения сведений или отладки см. свойство error.message).

CloudErrorBody

Объект

Описывает определенную ошибку API с кодом ошибки и сообщением.

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

string

Код ошибки, описывающий условие ошибки точнее, чем код состояния HTTP. Можно использовать для программной обработки конкретных случаев ошибок.
details

CloudErrorBody[]

Содержит вложенные ошибки, связанные с этой ошибкой.
message

string

Сообщение, описывающее ошибку подробно и предоставляющее сведения об отладке.
target

string

Целевой объект конкретной ошибки (например, имя свойства в ошибке).