Informations de référence sur l’API REST de gestion (Azure AI Recherche)

  • Article

Les API REST de gestion d’Azure AI Recherche (anciennement Recherche cognitive Azure) fournissent un accès par programme aux opérations administratives :

  • Créer, mettre à jour et supprimer un service de recherche
  • Récupérer les informations du service de recherche
  • Créer, régénérer ou récupérer api-keys (clés de requête ou d’administration)
  • Ajouter ou supprimer des réplicas et des partitions (ajuster la capacité)
  • Configurer un service de recherche pour utiliser un point de terminaison privé
  • Activer ou désactiver le contrôle d’accès en fonction du rôle Azure

Pour les tâches de plan de données, telles que la création et l’interrogation d’un index, utilisez plutôt les API REST de service Recherche.

Comment utiliser les API REST de gestion

Pour administrer entièrement votre service par programmation, vous utilisez deux API : l’API REST de gestion d’Azure AI Recherche documentée ici, plus l’API REST Azure Resource Manager commune.

L’API Resource Manager est utilisée pour les opérations à usage général qui ne sont pas spécifiques au service, telles que l’interrogation des données d’abonnement, la liste des emplacements géographiques, etc. Tous les appels d’API Resource Manager sont authentifiés à l’aide de Microsoft Entra ID. Vous devez disposer d’une appartenance et d’une attribution de rôle dans un locataire Microsoft Entra pour effectuer Resource Manager appels d’API.

Documentation de l’API versionnée

Les documents de l’API REST sont désormais versionnés. Lorsque vous ouvrez une page de référence d’API, sélectionnez la version de l’API dans le filtre de liste déroulante.

Capture d’écran du sélecteur de version.

Autorisations et contrôle d’accès

Les droits d’administration sont transmis via des rôles intégrés dans Microsoft Entra ID :

  • Les affectations de propriétaire ou de contributeur sont requises pour la plupart des tâches.
  • Le rôle Lecteur a un accès limité aux informations de service (opérations GET, à l’exception des clés API, qui nécessitent des autorisations propriétaire ou contributeur).

Pour plus d’informations, consultez Contrôle d’accès en fonction du rôle dans Azure AI Recherche.

Une bonne pratique consiste à attribuer des rôles à des groupes plutôt qu’à des utilisateurs individuels. Un propriétaire d’abonnement Azure ou un administrateur général gère ces affectations. Pour plus d’informations, consultez Attribuer des rôles Microsoft Entra à des groupes.

Se connecter au point de terminaison de gestion

Lors de la configuration de la connexion, commencez par le point de terminaison https://management.azure.com Resource Manager, puis ajoutez l’ID d’abonnement, le fournisseur (Microsoft.Search) et la version de l’API. Les opérations sont spécifiées dans le corps de la demande.

Un point de terminaison entièrement spécifié comporte les composants suivants :

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

Les clients suivants sont couramment utilisés pour appeler les API REST de gestion :

Client Instructions et exemples
Azure PowerShell à l’aide du module Az.Recherche Gérer les Recherche Azure AI à l’aide de Azure PowerShell
Azure CLI Gérer les Recherche Azure AI à l’aide d’Azure CLI
Visual Studio Code avec le client REST Gérer les Recherche Azure AI à l’aide de REST

Vous pouvez également gérer un service de recherche à l’aide du Portail Azure.

API de gestion dans d’autres kits SDK

Les API REST sont fondamentales pour Azure AI Recherche, et toutes les modifications apportées au modèle de programmation sont d’abord reflétées dans les API REST.

Les alternatives incluent les KITS de développement logiciel (SDK) Azure suivants, qui sont mis à jour indépendamment selon des planifications de publication distinctes :

Voir aussi