Kommentar
Åtkomst till den här sidan kräver auktorisering. Du kan prova att logga in eller ändra kataloger.
Åtkomst till den här sidan kräver auktorisering. Du kan prova att ändra kataloger.
REST-API:erna 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 information om söktjänsten
- 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 så att den använder en privat slutpunkt
- Aktivera eller inaktivera rollbaserad åtkomstkontroll i Azure
För dataplansuppgifter, till exempel att skapa och fråga ett index, använder du REST-API:erna för söktjänsten i stället.
Så här arbetar du med REST-API:er för hantering
Om du vill administrera din tjänst fullständigt programmatiskt arbetar du med två API:er: REST-API:et för hantering av Azure AI Search som dokumenteras här, plus det vanliga Azure Resource Manager REST API.
Resource Manager-API:et används för allmänna åtgärder som inte är tjänstspecifika, till exempel att fråga prenumerationsdata, lista geografiska platser 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 versionshanterade. När du öppnar en API-referenssida väljer du API-versionen i listrutans filter.
Behörigheter och åtkomstkontroll
Administrationsrättigheter förmedlas via inbyggda roller i Microsoft Entra ID:
- Tilldelningar av ägare eller deltagare 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.
Ett bra tips ä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:
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 är följande Azure-SDK:er, som uppdateras oberoende av varandra enligt separata lanseringsscheman:
- Microsoft Azure AI Search-klientbibliotek för hantering av .NET
- Microsoft Azure SDK för Python
- Azure Search Management-klientbibliotek för JavaScript
- Azure Resource Manager Azure AI Search-klientbibliotek för Java