Lister les index (API REST Recherche Azure AI)
L’opération List Indexes retourne une liste des index actuellement dans votre service Search Azure AI.
GET https://[service name].search.windows.net/indexes?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
Code d’état : « 200 OK » est retourné pour une réponse réussie.
Exemples
{
"value": [
{
"name": "Books",
"fields": [
{"name": "ISBN", ...},
...
]
},
{
"name": "Games",
...
},
...
]
}
Vous pouvez filtrer la réponse uniquement en fonction des propriétés qui vous intéressent. Par exemple, si vous voulez uniquement une liste des noms d'index, utilisez l'option de requête OData $select :
GET /indexes?api-version=2020-06-30&$select=name
Dans ce cas, la réponse de l'exemple ci-dessus apparaît comme suit :
{
"value": [
{"name": "Books"},
{"name": "Games"},
...
]
}
Cette technique est utile pour économiser de la bande passante si votre service de recherche contient un grand nombre d'index.