Compartir a través de

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

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

  • Crear, actualizar y eliminar un servicio de búsqueda
  • Recuperar información del servicio de búsqueda
  • Crear, regenerar o recuperar api-keys (claves de consulta o 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

Para las tareas del plano de datos, como la creación y consulta de un índice, use las API de REST del servicio de búsqueda en su lugar.

Cómo trabajar con las API de REST de administración

Para administrar completamente el servicio mediante programación, trabaje con dos API: la API de REST de administración de Azure AI Search documentada aquí, además de la API de 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 a la API de Resource Manager se autentican mediante el identificador de Microsoft Entra. Debe tener pertenencia y una asignación de roles en un inquilino de Microsoft Entra para realizar llamadas a la API de Resource Manager.

Documentos de API con versiones

Los documentos de la API de REST 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 de 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 obtener más información, consulte Control de acceso basado en rol en Azure AI Search.

Una práctica recomendada es asignar roles a grupos en lugar de usuarios individuales. Un propietario de 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, a continuación, agregue el identificador de suscripción, el proveedor (Microsoft.Search) y la versión de 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 usan normalmente para llamar a las API de REST de administración:

Cliente 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
Visual Studio Code con el cliente REST Administración de Azure AI Search mediante REST

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

API de administración en otros SDK

Las API de REST son fundamentales para Azure AI Search y cualquier cambio en el modelo de programación se refleja primero en las API de REST.

Las alternativas incluyen los siguientes SDK de Azure, que se actualizan de forma independiente en programaciones de lanzamiento independientes:

Consulte también

  • Last updated on