Referens för REST API för hantering (Azure AI Search)

  • Artikel

Rest-API:er för hantering av Azure AI-Search (kallades tidigare Azure Cognitive Search) ger programmatisk åtkomst till administrativa åtgärder:

  • Skapa, uppdatera och ta bort en söktjänst
  • Hämta söktjänstinformation
  • Skapa, återskapa eller hämta api-keys (fråge- eller administratörsnycklar)
  • Lägga till eller ta bort repliker och partitioner (justera kapaciteten)
  • Konfigurera en söktjänst för att använda en privat slutpunkt
  • Aktivera eller inaktivera rollbaserad åtkomstkontroll i Azure

För dataplansuppgifter, till exempel att skapa och köra frågor mot ett index, använder du rest-API:erna för Search Service i stället.

Så här arbetar du med REST-API:er för hantering

För att fullständigt administrera din tjänst programmatiskt arbetar du med två API:er: Management REST API för Azure AI Search dokumenterat här, plus det vanliga REST-API:et för Azure Resource Manager.

RESOURCE MANAGER-API:et används för allmänna åtgärder som inte är tjänstspecifika, till exempel frågekörning mot prenumerationsdata, lista geoplatser och så vidare. Alla Resource Manager API-anrop autentiseras med hjälp av Microsoft Entra ID. Du måste ha medlemskap och en rolltilldelning i en Microsoft Entra klientorganisation för att kunna göra Resource Manager API-anrop.

Versionshanterade API-dokument

REST API-dokument är nu versionshanterade. När du öppnar en API-referenssida väljer du API-versionen från listrutefiltret.

Skärmbild av versionsväljaren.

Behörigheter och åtkomstkontroll

Administrationsrättigheter förmedlas via inbyggda roller i Microsoft Entra ID:

  • Ägar- eller deltagartilldelningar krävs för de flesta uppgifter.
  • Läsarrollen har begränsad åtkomst till tjänstinformation (GET-åtgärder, förutom API-nycklar som kräver ägar- eller deltagarbehörighet).

Mer information finns i Rollbaserad åtkomstkontroll i Azure AI Search.

Bästa praxis är att tilldela roller till grupper i stället för enskilda användare. En Azure-prenumerationsägare eller global administratör hanterar dessa tilldelningar. Mer information finns i Tilldela Microsoft Entra roller till grupper.

Ansluta till hanteringsslutpunkten

När du konfigurerar anslutningen börjar du med Resource Manager-slutpunkten https://management.azure.com och lägger sedan till prenumerations-ID, provider (Microsoft.Search) och API-version. Åtgärder anges i brödtexten i begäran.

En fullständigt angiven slutpunkt har följande komponenter:

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

Följande klienter används ofta för att anropa REST-API:er för hantering:

Client Instruktioner och exempel
Azure PowerShell med hjälp av modulen Az.Search Hantera Azure AI-Search med hjälp av Azure PowerShell
Kommandoradsgränssnitt för Azure (CLI) Hantera Azure AI-Search med hjälp av Azure CLI
Visual Studio Code med REST-klienten Hantera Azure AI-Search med hjälp av REST

Du kan också hantera en söktjänst med hjälp av Azure Portal.

Hanterings-API:er i andra SDK:er

REST-API:erna är grundläggande för Azure AI-Search, och eventuella ändringar i programmeringsmodellen återspeglas först i REST-API:erna.

Alternativen omfattar följande Azure-SDK:er, som uppdateras separat enligt separata versionsscheman:

Se även