Beheer REST API-referentie (Azure AI Zoeken)

De Management REST-API's van Azure AI Zoeken (voorheen bekend als Azure Cognitive Search) bieden programmatische toegang tot beheerbewerkingen:

  • Een zoekservice maken, bijwerken en verwijderen
  • Informatie over de zoekservice ophalen
  • Maken, regenereren of ophalen api-keys (query- of beheerderssleutels)
  • Replica's en partities toevoegen of verwijderen (capaciteit aanpassen)
  • Een zoekservice configureren voor het gebruik van een privé-eindpunt
  • Toegangsbeheer op basis van Azure-rollen in- of uitschakelen

Voor taken op het gegevensvlak, zoals het maken van en query's uitvoeren op een index, gebruikt u in plaats daarvan de REST-API's van de zoekservice .

Werken met de beheer-REST API's

Als u uw service volledig programmatisch wilt beheren, werkt u met twee API's: de Management REST-API van Azure AI Zoeken die hier wordt beschreven, plus de algemene Azure Resource Manager REST API.

De Resource Manager-API wordt gebruikt voor algemene bewerkingen die niet servicespecifiek zijn, zoals het opvragen van abonnementsgegevens, het vermelden van geolocaties, enzovoort. Alle Resource Manager API-aanroepen worden geverifieerd met behulp van Microsoft Entra-ID. U moet lidmaatschap en een roltoewijzing hebben in een Microsoft Entra-tenant om Resource Manager-API-aanroepen te maken.

Api-documenten met versiebeheer

REST API-documenten zijn voorzien van versiebeheer. Wanneer u een API-referentiepagina opent, wordt boven de inhoudsopgave een versiekiezer weergegeven. De selector wordt beschikbaar wanneer je een pagina kiest uit de map Referentie > Resource Manager.

Schermopname van de versiekiezer.

Machtigingen en toegangsbeheer

Beheerrechten worden overgedragen via ingebouwde rollen in Microsoft Entra ID:

  • Voor de meeste taken zijn toewijzingen als eigenaar of inzender vereist.
  • De rol van de lezer heeft beperkte toegang tot servicegegevens (GET-bewerkingen, met uitzondering van API-sleutels, waarvoor machtigingen voor de eigenaar of de inzender zijn vereist).

Zie Toegangsbeheer op basis van rollen in Azure AI Zoeken voor meer informatie.

Een best practice is om rollen toe te wijzen aan groepen in plaats van aan individuele gebruikers. Deze toewijzingen worden beheerd door een eigenaar of globale beheerder van een Azure-abonnement. Zie Microsoft Entra-rollen toewijzen aan groepenvoor meer informatie.

Verbinding maken met het beheereindpunt

Begin bij het instellen van de verbinding met het Resource Manager-eindpunt https://management.azure.com en voeg vervolgens de abonnements-id, provider (Microsoft.Search) en API-versie toe. Bewerkingen worden gespecificeerd in de hoofdtekst van de aanvraag.

Een volledig gespecificeerd eindpunt heeft de volgende onderdelen:

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

De volgende clients worden vaak gebruikt om de REST-API's van het beheer aan te roepen:

Cliënt Instructies en voorbeelden
Azure PowerShell met behulp van de Az.Search-module Azure AI Zoeken beheren met behulp van Azure PowerShell
Azure-opdrachtregelinterface (CLI) Azure AI Zoeken beheren met behulp van de Azure CLI
Visual Studio Code met de REST-client Azure AI Zoeken beheren met REST

U kunt ook een zoekservice beheren met behulp van de Azure Portal.

Beheer-API's in andere SDK's

De REST-API's zijn fundamenteel voor Azure AI Zoeken en eventuele wijzigingen in het programmeermodel worden eerst weergegeven in de REST-API's.

Alternatieven zijn onder meer de volgende Azure-SDK's, die onafhankelijk worden bijgewerkt op afzonderlijke releaseschema's:

Zie ook

  • Last updated on