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


Admin Keys - Get

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

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

Параметры URI

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

string

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

searchServiceName
path True

string

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

subscriptionId
path True

string

Уникальный идентификатор подписки Microsoft Azure. Это значение можно получить из API Azure Resource Manager, средств командной строки или портала.

api-version
query True

string

Версия API, используемая для каждого запроса.

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

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

string (uuid)

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

Ответы

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

AdminKeyResult

Ключи администратора были успешно получены и находятся в ответе. Вы можете использовать первичный или вторичный ключ в качестве значения параметра api-key в REST API плоскости данных или пакета SDK Azure для выполнения любых операций в службе поиска, включая привилегированные операции. Привилегированные операции включают управление ресурсами, такими как индексы и источники данных, а также отправка, изменение или удаление данных в индексах.

Other Status Codes

CloudError

HTTP 404 (не найдено): не удалось найти подписку, группу ресурсов или службу поиска. HTTP 409 (конфликт): указанная подписка отключена.

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

azure_auth

Поток авторизации OAuth2 идентификатора Microsoft Entra ID.

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

Области

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

Примеры

SearchGetAdminKeys

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

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/listAdminKeys?api-version=2023-11-01

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

{
  "primaryKey": "<your primary admin API key>",
  "secondaryKey": "<your secondary admin API key>"
}

Определения

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

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

CloudError

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

CloudErrorBody

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

AdminKeyResult

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

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

string

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

secondaryKey

string

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

CloudError

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

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

CloudErrorBody

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

CloudErrorBody

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

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

string

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

details

CloudErrorBody[]

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

message

string

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

target

string

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