Query Keys - Create

Servicio:

Search Management

Versión de la API:

2025-05-01

Genera una nueva clave de consulta para el servicio de búsqueda especificado. Puede crear hasta 50 claves de consulta por servicio.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
name	path	True	string	Nombre de la nueva clave de API de consulta.
resourceGroupName	path	True	string	Nombre del grupo de recursos dentro de la suscripción actual. Puede obtener este valor desde la API de Azure Resource Manager o el portal.
searchServiceName	path	True	string pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$	Nombre del servicio Azure AI Search asociado al grupo de recursos especificado.
subscriptionId	path	True	string	Identificador único de una suscripción de Microsoft Azure. Puede obtener este valor desde la API de Azure Resource Manager o el portal.
api-version	query	True	string	Versión de la API que se va a usar para cada solicitud.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
x-ms-client-request-id		string (uuid)	Valor GUID generado por el cliente que identifica esta solicitud. Si se especifica, se incluirá en la información de respuesta como una manera de realizar un seguimiento de la solicitud.

Respuestas

Nombre	Tipo	Description
200 OK	QueryKey	La clave de consulta se creó correctamente y se encuentra en la respuesta. Puede usar la clave de consulta como valor del parámetro "api-key" en la API REST del servicio Azure AI Search o el SDK para realizar operaciones de solo lectura en los índices de búsqueda, como consultar y buscar documentos por identificador.
Other Status Codes	CloudError	HTTP 404 (no encontrado): no se encontró la suscripción, el grupo de recursos o el servicio de búsqueda. HTTP 409 (Conflicto): la suscripción especificada está deshabilitada.

Seguridad

azure_auth

Especifica un flujo de concesión implícito, como se admite en la plataforma de identidad de Microsoft.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

SearchCreateQueryKey

Solicitud de ejemplo

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-05-01

Respuesta de muestra

status code:

200

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

Definiciones

Nombre	Description
CloudError	Contiene información sobre un error de API.
CloudErrorBody	Describe un error de API determinado con un código de error y un mensaje.
QueryKey	Describe una clave de API para un servicio de Azure AI Search determinado que transmite permisos de solo lectura en la colección de documentos de un índice.

CloudError

Objeto

Contiene información sobre un error de API.

Nombre	Tipo	Description
error	CloudErrorBody	Describe un error de API determinado con un código de error y un mensaje.
message	string	Una breve descripción del error que indica lo que salió mal (para obtener detalles o información de depuración, consulte la propiedad "error.message").

CloudErrorBody

Objeto

Describe un error de API determinado con un código de error y un mensaje.

Nombre	Tipo	Description
code	string	Código de error que describe la condición de error más precisamente que un código de estado HTTP. Se puede usar para controlar mediante programación casos de error específicos.
details	CloudErrorBody[]	Contiene errores anidados relacionados con este error.
message	string	Mensaje que describe el error con detalle y proporciona información de depuración.
target	string	Destino del error concreto (por ejemplo, el nombre de la propiedad en error).

QueryKey

Objeto

Describe una clave de API para un servicio de Azure AI Search determinado que transmite permisos de solo lectura en la colección de documentos de un índice.

Nombre	Tipo	Description
key	string	Valor de la clave de API de consulta.
name	string	Nombre de la clave de API de consulta. Los nombres de consulta son opcionales, pero asignar un nombre puede ayudarle a recordar cómo se usa.