Referencia de la API REST de administración (Azure AI Search)

Las API rest de administración de Azure AI Search (anteriormente conocidas como Azure Cognitive Search) proporcionan acceso mediante programación a las operaciones administrativas:

  • Creación, actualización y eliminación de un servicio de búsqueda
  • Recuperación de la información del servicio de búsqueda
  • Creación, regeneración o recuperación api-keys (consulta o claves de administración)
  • Agregar o quitar réplicas y particiones (ajustar la capacidad)
  • Configuración de un servicio de búsqueda para usar un punto de conexión privado
  • Habilitación o deshabilitación del control de acceso basado en rol de Azure

En el caso de las tareas del plano de datos, como crear y consultar un índice, use las API REST del servicio de búsqueda en su lugar.

Para administrar completamente el servicio mediante programación, trabaja con dos API: la API REST de administración de Azure AI Search que se documenta aquí, además de la API REST común de Azure Resource Manager. La API de Resource Manager se usa para operaciones de uso general que no son específicas del servicio, como consultar datos de suscripción, enumerar ubicaciones geográficas, etc.

Documentación de api con versiones

Los documentos de la API REST ahora tienen versiones. Al abrir una página de referencia de API, seleccione la versión de API en el filtro desplegable.

Captura de pantalla del selector de versiones.

Permisos y control de acceso

Los derechos de administración se transmiten a través de roles integrados en Microsoft Entra ID:

  • Las asignaciones de propietario o colaborador son necesarias para la mayoría de las tareas.
  • El rol lector tiene acceso limitado a la información del servicio (operaciones GET, excepto las claves de API que requieren permisos de propietario o colaborador).

Para más información, consulte Control de acceso basado en rol en Azure AI Search.

Un procedimiento recomendado es asignar roles a grupos en lugar de usuarios individuales. Un propietario de la suscripción de Azure o un administrador global administra estas asignaciones. Para más información, consulte Asignación de roles de Microsoft Entra a distintos grupos.

Conexión al punto de conexión de administración

Al configurar la conexión, comience con el punto de conexión https://management.azure.com de Resource Manager y agregue el identificador de suscripción, el proveedor (Microsoft.Search) y la versión de LA API. Las operaciones se especifican en el cuerpo de la solicitud.

Un punto de conexión totalmente especificado tiene los siguientes componentes:

https://management.azure.com/subscriptions/[subscriptionId]/resourceGroups/[resourceGroupName]/providers/Microsoft.Search/searchServices/[serviceName]?api-version=2020-08-01

Los siguientes clientes se usan normalmente para llamar a las API REST de administración:

Remoto Instrucciones y ejemplos
Azure PowerShell mediante el módulo Az.Search Administración de Azure AI Search mediante Azure PowerShell
Interfaz de la línea de comandos (CLI) de Azure Administración de Azure AI Search mediante la CLI de Azure
Postman Administración de Azure AI Search mediante REST

También puede administrar un servicio de búsqueda mediante el Azure Portal.

API de administración en otros SDK

Las API REST son fundamentales para Azure AI Search y los cambios en el modelo de programación se reflejan primero en las API REST.

Entre las alternativas se incluyen los siguientes SDK de Azure, que se actualizan de forma independiente en programaciones de versiones independientes:

Consulte también