Query Keys - Create

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

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

Параметры URI

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

string

Имя нового ключа API запроса.

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

QueryKey

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

Other Status Codes

CloudError

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

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

azure_auth

Поток OAuth2 в Azure Active Directory.

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

Области

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

Примеры

SearchCreateQueryKey

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

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/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-05-01

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

{
  "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 запроса. Имена запросов являются необязательными, но назначение имени может помочь вам вспомнить, как оно используется.