Query Keys - Create

Служба:: Search Management

Версия API:: 2025-02-01-preview

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

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
name	path	True	string	Имя нового ключа API запроса.
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	QueryKey	Ключ запроса был успешно создан и находится в ответе. Ключ запроса можно использовать в качестве значения параметра 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	олицетворения учетной записи пользователя

Примеры

SearchCreateQueryKey

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

HTTP

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/createQueryKey/An API key granting read-only access to the documents collection of an index.?api-version=2025-02-01-preview

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

Код состояния:: 200

{
  "name": "An API key granting read-only access to the documents collection of an index.",
  "key": "<a query API key>"
}

Определения

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

CloudError

Объект

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

Имя	Тип	Описание
error	CloudErrorBody	Описывает определенную ошибку API с кодом ошибки и сообщением.
message	string	Краткое описание ошибки, которая указывает на то, что пошло не так (для получения сведений или отладки см. свойство error.message).

CloudErrorBody

Объект

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

Имя	Тип	Описание
code	string	Код ошибки, описывающий условие ошибки точнее, чем код состояния HTTP. Можно использовать для программной обработки конкретных случаев ошибок.
details	CloudErrorBody[]	Содержит вложенные ошибки, связанные с этой ошибкой.
message	string	Сообщение, описывающее ошибку подробно и предоставляющее сведения об отладке.
target	string	Целевой объект конкретной ошибки (например, имя свойства в ошибке).

QueryKey

Объект

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

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