Compartir a través de

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

minLength: 1
maxLength: 90

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
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 (uuid)

Identificador de la suscripción de destino. El valor debe ser un UUID.
api-version
 query True

string

minLength: 1

Versión de la API que se va a usar para esta operación.

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 operación de Azure se completó correctamente.
Other Status Codes

CloudError

Una respuesta de error inesperada.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory.

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

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

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.