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

Query Keys - List By Search Service

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

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

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

Параметры URI

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

string

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

string

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

Имя службы поиска ИИ Azure, связанной с указанной группой ресурсов.
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

ListQueryKeysResult

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

CloudError

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

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

azure_auth

Указывает неявный поток предоставления, как поддерживается на платформе удостоверений Майкрософт.

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

Области

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

Примеры

SearchListQueryKeysBySearchService

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

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

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

Код состояния:
200 
{
  "value": [
    {
      "name": "Query key for browser-based clients",
      "key": "<a query API key>"
    },
    {
      "name": "Query key for mobile clients",
      "key": "<another query API key>"
    }
  ]
}

Определения

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

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

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

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

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

CloudError

Object

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

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

CloudErrorBody

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

string

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

CloudErrorBody

Object

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

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

string

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

CloudErrorBody[]

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

string

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

string

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

ListQueryKeysResult

Object

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

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

string

URL-адрес запроса, который можно использовать для запроса следующей страницы ключей запросов. Возвращается, когда общее количество запрошенных ключей запросов превышает максимальный размер страницы.
value

QueryKey[]

Ключи запросов для службы поиска ИИ Azure.

QueryKey

Object

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

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

string

Значение ключа API запроса.
name

string

Имя ключа API запроса. Имена запросов являются необязательными, но назначение имени может помочь вам вспомнить, как оно используется.