Delen via

Naslaginformatie over REST API voor Management (Azure AI Search)

  • Artikel

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

  • Een zoekservice maken, bijwerken en verwijderen
  • Zoekservicegegevens ophalen
  • Maken, opnieuw genereren of ophalen api-keys (query- of beheersleutels)
  • Replica's en partities toevoegen of verwijderen (capaciteit aanpassen)
  • Een zoekservice configureren voor het gebruik van een privĂ©-eindpunt
  • Op rollen gebaseerd toegangsbeheer van Azure in- of uitschakelen

Voor gegevensvlaktaken, zoals het maken van en het uitvoeren van query's op een index, gebruikt u in plaats daarvan de REST API's van Search Service.

Werken met de REST API's voor beheer

Als u uw service programmatisch volledig wilt beheren, werkt u met twee API's: de beheer-REST API van Azure AI Search hier 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 weergeven van geografische locaties, enzovoort. Alle Resource Manager API-aanroepen worden geverifieerd met behulp van Microsoft Entra ID. U moet lidmaatschap en roltoewijzing hebben in een Microsoft Entra tenant om Resource Manager API-aanroepen te kunnen doen.

Api-documenten met versiebeheer

REST API-documenten zijn nu geversied. Wanneer u een API-referentiepagina opent, selecteert u de API-versie in de vervolgkeuzelijst.

Schermopname van de versiekiezer.

Machtigingen en toegangsbeheer

Beheerrechten worden overgebracht via ingebouwde rollen in Microsoft Entra ID:

  • Toewijzingen van eigenaar of inzender zijn vereist voor de meeste taken.
  • De rol Lezer heeft beperkte toegang tot servicegegevens (GET-bewerkingen, met uitzondering van API-sleutels waarvoor de machtigingen Eigenaar of Inzender zijn vereist).

Zie Op rollen gebaseerd toegangsbeheer in Azure AI Search voor meer informatie.

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

Verbinding maken met het beheereindpunt

Wanneer u de verbinding instelt, begint u met het Resource Manager-eindpunt https://management.azure.com en voegt u vervolgens de abonnements-id, provider (Microsoft.Search) en API-versie toe. Bewerkingen worden opgegeven in de hoofdtekst van de aanvraag.

Een volledig opgegeven 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 BEHEER-REST API's aan te roepen:

Client Instructies en voorbeelden
Azure PowerShell met behulp van de Module Az.Search Azure AI-Search beheren met behulp van Azure PowerShell
Azure-opdrachtregelinterface (CLI) Azure AI-Search beheren met behulp van de Azure CLI
Visual Studio Code met de REST-client Azure AI-Search 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 Search en eventuele wijzigingen in het programmeermodel worden eerst doorgevoerd in de REST API's.

Alternatieven zijn onder andere de volgende Azure SDK's, die onafhankelijk worden bijgewerkt volgens afzonderlijke releaseschema's:

Zie ook