Referencia de la API REST de administración (Azure AI Búsqueda)
Las API rest de administración de Azure AI Búsqueda (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 información del servicio de búsqueda
- Creación, regeneración o recuperación
api-keys(consulta o claves de administrador) - 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 en su lugar las API rest del servicio Búsqueda.
Cómo trabajar con las API REST de administración
Para administrar completamente el servicio mediante programación, trabaja con dos API: la API REST de administración de Azure AI Búsqueda documentada 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. Todas las llamadas API de Resource Manager se autentican mediante Microsoft Entra ID. Debe tener pertenencia y una asignación de roles en un inquilino de Microsoft Entra para realizar llamadas API de Resource Manager.
Documentos de API con versiones
Ahora se han versionado los documentos de la API REST. Al abrir una página de referencia de API, seleccione la versión de API en el filtro desplegable.
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 roles en Azure AI Búsqueda.
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 de Resource Manager https://management.azure.com 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 completamente 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 suelen usar para llamar a las API rest de administración:
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 Búsqueda 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 versión independientes:
- Biblioteca cliente de administración de microsoft Azure AI Búsqueda para .NET
- SDK de Microsoft Azure para Python
- Biblioteca cliente de Azure Búsqueda Management para JavaScript
- Biblioteca cliente de Azure AI Búsqueda de Azure Resource Manager para Java