Partager via


Répertorier les indexeurs (API REST Azure AI Search)

L’opération List Indexers retourne la liste des indexeurs dans votre service Search Azure AI.

GET https://[service name].search.windows.net/indexers?api-version=[api-version]  
  Content-Type: application/json  
  api-key: [admin key]  

Paramètres URI

Paramètre Description
nom du service Obligatoire. Définissez cette valeur sur le nom unique défini par l’utilisateur de votre service de recherche.
api-version Obligatoire. La version stable actuelle est api-version=2020-06-30. Pour plus d’informations, consultez Versions de l’API .

En-têtes de requête

Le tableau suivant décrit les en-têtes de demande obligatoires et facultatifs.

Champs Description
Content-Type Obligatoire. À définir avec la valeur application/json
api-key Facultatif si vous utilisez des rôles Azure et qu’un jeton de porteur est fourni sur la demande, sinon une clé est requise. Une clé API est une chaîne unique générée par le système qui authentifie la demande auprès de votre service de recherche. Les demandes d’obtention d’une définition d’objet doivent inclure un champ api-key défini sur votre clé d’administration (par opposition à une clé de requête). Pour plus d’informations, consultez Se connecter à Azure AI Search à l’aide de l’authentification par clé .

Corps de la demande

Aucun.

response

Pour une requête réussie : « 200 OK ». Voici un exemple de corps de réponse :

{  
      "value" : [  
      {  
        "name" : "myindexer",  
        "description" : "a cool indexer",  
        "dataSourceName" : "ordersds",  
        "targetIndexName" : "orders",  
        ... other indexer properties  
      }]  
    }  

Vous pouvez filtrer la réponse uniquement en fonction des propriétés qui vous intéressent. Par exemple, si vous souhaitez uniquement une liste de noms d’indexeurs, utilisez l’option de requête OData $select :

GET /indexers?api-version=2020-06-30&$select=name  

Dans ce cas, la réponse de l'exemple ci-dessus apparaît comme suit :

{  
      "value" : [ { "name": "myindexer" } ]  
    }  

Cette technique est utile pour économiser de la bande passante si votre service Search contient un grand nombre d'indexeurs.

Notes

Si un indexeur dispose d’une clé de chiffrement, le service de recherche doit avoir accès à la clé de chiffrement pour récupérer les propriétés chiffrées dans la définition de cet indexeur. Sans accès à la clé de chiffrement, un "<encrypted>" espace réservé est retourné à la place des propriétés chiffrées. La restauration de l’accès à la clé permet au service de recherche de récupérer à nouveau la définition complète de l’indexeur.

Voir aussi