Delen via


Indexeerfuncties weergeven (Azure AI Search REST API)

De bewerking Indexeerfuncties weergeven retourneert de lijst met indexeerfuncties in uw Azure AI-Search-service.

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

URI-parameters

Parameter Beschrijving
servicenaam Vereist. Stel deze in op de unieke, door de gebruiker gedefinieerde naam van uw zoekservice.
api-versie Vereist. De huidige stabiele versie is api-version=2020-06-30. Zie API-versies voor meer versies.

Aanvraagheaders

In de volgende tabel worden de vereiste en optionele aanvraagheaders beschreven.

Velden Description
Content-Type Vereist. Stel dit in op application/json
api-sleutel Optioneel als u Azure-rollen gebruikt en er een bearer-token wordt opgegeven voor de aanvraag, anders is een sleutel vereist. Een API-sleutel is een unieke, door het systeem gegenereerde tekenreeks die de aanvraag verifieert bij uw zoekservice. Aanvragen voor een objectdefinitie moeten een api-sleutelveld bevatten dat is ingesteld op uw beheerderssleutel (in plaats van een querysleutel). Zie Verbinding maken met Azure AI Search met behulp van sleutelverificatie voor meer informatie.

Aanvraagbody

Geen.

Antwoord

Voor een geslaagde aanvraag: 200 OK. Hier volgt een voorbeeld van de antwoordtekst:

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

U kunt het antwoord filteren op alleen de eigenschappen waarin u geïnteresseerd bent. Als u bijvoorbeeld alleen een lijst met namen van indexeerfuncties wilt, gebruikt u de optie OData $select query:

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

In dit geval ziet het antwoord uit het bovenstaande voorbeeld er als volgt uit:

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

Dit is een handige techniek om bandbreedte te besparen als uw Search-service veel indexeerfuncties heeft.

Notitie

Als een indexeerfunctie een versleutelingssleutel heeft, moet de zoekservice toegang hebben tot de versleutelingssleutel om versleutelde eigenschappen in de definitie van die indexeerfunctie op te halen. Zonder toegang tot de versleutelingssleutel wordt een "<encrypted>" tijdelijke aanduiding geretourneerd in plaats van de versleutelde eigenschappen. Als u de toegang tot de sleutel herstelt, kan de zoekservice de volledige definitie van de indexeerfunctie opnieuw ophalen.

Zie ook