Compartir a través de


Query Keys - List By Search Service

Devuelve la lista de claves de API de consulta para el servicio de búsqueda especificado.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
resourceGroupName
path True

string

Nombre del grupo de recursos dentro de la suscripción actual. Puede obtener este valor en la API del Administrador de recursos o el portal de Azure.

searchServiceName
path True

string

Nombre del servicio de búsqueda asociado al grupo de recursos especificado.

subscriptionId
path True

string

Identificador único de una suscripción de Microsoft Azure. Puede obtener este valor de la API de Azure Resource Manager, las herramientas de línea de comandos o el portal.

api-version
query True

string

La 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

Un 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

ListQueryKeysResult

Todas las claves de consulta del servicio de búsqueda especificado se recuperaron correctamente y se encuentran en la respuesta. Puede usar cualquiera de las claves de consulta como valor del parámetro "api-key" en la API REST del plano de datos o un SDK de Azure para realizar operaciones de solo lectura en la colección de documentos de 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

Microsoft Entra ID flujo de autorización de OAuth2.

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

Ámbitos

Nombre Description
user_impersonation suplantación de su cuenta de usuario

Ejemplos

SearchListQueryKeysBySearchService

Solicitud de ejemplo

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

Respuesta de muestra

{
  "value": [
    {
      "name": "Query key for browser-based clients",
      "key": "<a query API key>"
    },
    {
      "name": "Query key for mobile clients",
      "key": "<another 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.

ListQueryKeysResult

Respuesta que contiene las claves de API de consulta para un servicio de búsqueda determinado.

QueryKey

Describe una clave de API para un servicio de búsqueda determinado que solo tiene permisos para las operaciones de consulta.

CloudError

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.

CloudErrorBody

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 de forma más precisa 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 en detalle y proporciona información de depuración.

target

string

Destino del error determinado (por ejemplo, el nombre de la propiedad en error).

ListQueryKeysResult

Respuesta que contiene las claves de API de consulta para un servicio de búsqueda determinado.

Nombre Tipo Description
nextLink

string

Dirección URL de solicitud que se puede usar para consultar la página siguiente de claves de consulta. Se devuelve cuando el número total de claves de consulta solicitadas supera el tamaño máximo de página.

value

QueryKey[]

Claves de consulta para el servicio de búsqueda.

QueryKey

Describe una clave de API para un servicio de búsqueda determinado que solo tiene permisos para las operaciones de consulta.

Nombre Tipo Description
key

string

Valor de la clave de API de consulta.

name

string

Nombre de la clave de API de consulta; puede estar vacío.