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
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
resource
|
path | True |
string |
Имя группы ресурсов в текущей подписке. Это значение можно получить от API-интерфейса диспетчера ресурсов Azure или портала. |
search
|
path | True |
string |
Имя службы поиска, связанной с указанной группой ресурсов. |
subscription
|
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 |
Ключи администратора были успешно получены и находятся в ответе. Вы можете использовать первичный или вторичный ключ в качестве значения параметра api-key в REST API плоскости данных или пакет SDK Azure для выполнения любых операций в службе поиска, включая привилегированные операции. Привилегированные операции включают управление ресурсами, такими как индексы и источники данных, а также отправку, изменение или удаление данных в индексах. |
|
Other Status Codes |
HTTP 404 (не найдено): не удалось найти подписку, группу ресурсов или службу поиска. HTTP 409 (конфликт): указанная подписка отключена. |
Безопасность
azure_auth
Microsoft Entra ID поток авторизации OAuth2.
Тип:
oauth2
Flow:
implicit
URL-адрес авторизации:
https://login.microsoftonline.com/common/oauth2/authorize
Области
Имя | Описание |
---|---|
user_impersonation | олицетворения учетной записи пользователя |
Примеры
SearchGetAdminKeys
Образец запроса
Пример ответа
{
"primaryKey": "<your primary admin API key>",
"secondaryKey": "<your secondary admin API key>"
}
Определения
Имя | Описание |
---|---|
Admin |
Ответ, содержащий первичный и дополнительный ключи API администратора для данной службы поиска. |
Cloud |
Содержит сведения об ошибке API. |
Cloud |
Описывает конкретную ошибку API с кодом ошибки и сообщением. |
AdminKeyResult
Ответ, содержащий первичный и дополнительный ключи API администратора для данной службы поиска.
Имя | Тип | Описание |
---|---|---|
primaryKey |
string |
Первичный ключ API администратора службы поиска. |
secondaryKey |
string |
Дополнительный ключ API администратора службы поиска. |
CloudError
Содержит сведения об ошибке API.
Имя | Тип | Описание |
---|---|---|
error |
Описывает конкретную ошибку API с кодом ошибки и сообщением. |
CloudErrorBody
Описывает конкретную ошибку API с кодом ошибки и сообщением.
Имя | Тип | Описание |
---|---|---|
code |
string |
Код ошибки, описывающий условие ошибки более точно, чем код состояния HTTP. Может использоваться для программной обработки конкретных случаев ошибок. |
details |
Содержит вложенные ошибки, связанные с этой ошибкой. |
|
message |
string |
Сообщение, подробно описывающее ошибку и предоставляющее сведения об отладке. |
target |
string |
Целевой объект конкретной ошибки (например, имя свойства в ошибке). |