Dokumentacja interfejsu API REST zarządzania (azure AI Search)

  • Artykuł

Interfejsy API REST zarządzania Search usługi Azure AI (wcześniej znane jako Azure Cognitive Search) zapewniają dostęp programowy do operacji administracyjnych:

  • Tworzenie, aktualizowanie i usuwanie usługi wyszukiwania
  • Pobieranie informacji o usłudze wyszukiwania
  • Tworzenie, ponowne generowanie lub pobieranie api-keys (zapytanie lub klucze administratora)
  • Dodawanie lub usuwanie replik i partycji (dostosowywanie pojemności)
  • Konfigurowanie usługi wyszukiwania do używania prywatnego punktu końcowego
  • Włączanie lub wyłączanie kontroli dostępu opartej na rolach platformy Azure

W przypadku zadań płaszczyzny danych, takich jak tworzenie indeksu i wykonywanie względem niego zapytań, użyj zamiast tego interfejsów API REST usługi Search Service.

Jak pracować z interfejsami API REST zarządzania

Aby w pełni administrować usługą programowo, pracujesz z dwoma interfejsami API: interfejsem API REST zarządzania usługi Azure AI Search udokumentowanym tutaj oraz typowym interfejsem API REST usługi Azure Resource Manager.

Interfejs API Resource Manager jest używany do operacji ogólnego przeznaczenia, które nie są specyficzne dla usługi, takie jak wykonywanie zapytań dotyczących danych subskrypcji, wyświetlanie listy lokalizacji geograficznych itd. Wszystkie wywołania interfejsu API Resource Manager są uwierzytelniane przy użyciu Tożsamość Microsoft Entra. Aby wykonywać wywołania interfejsu API Resource Manager, musisz mieć członkostwo i przypisanie roli w dzierżawie Microsoft Entra.

Dokumentacja interfejsu API w wersji

Dokumentacja interfejsu API REST jest teraz wersjonowana. Po otwarciu strony dokumentacji interfejsu API wybierz wersję interfejsu API z filtru rozwijanego.

Zrzut ekranu przedstawiający selektor wersji.

Uprawnienia i kontrola dostępu

Prawa administracyjne są przekazywane za pomocą wbudowanych ról w Tożsamość Microsoft Entra:

  • W przypadku większości zadań wymagane są przypisania właściciela lub współautora .
  • Rola czytelnika ma ograniczony dostęp do informacji o usłudze (operacje GET, z wyjątkiem kluczy interfejsu API, które wymagają uprawnień właściciela lub współautora).

Aby uzyskać więcej informacji, zobacz Kontrola dostępu oparta na rolach w usłudze Azure AI Search.

Najlepszym rozwiązaniem jest przypisywanie ról do grup, a nie do poszczególnych użytkowników. Właściciel subskrypcji platformy Azure lub administrator globalny zarządza tymi przypisaniami. Aby uzyskać więcej informacji, zobacz Przypisywanie ról Microsoft Entra do grup.

Nawiązywanie połączenia z punktem końcowym zarządzania

Podczas konfigurowania połączenia rozpocznij od punktu końcowego https://management.azure.com Resource Manager, a następnie dodaj identyfikator subskrypcji, dostawcę (Microsoft.Search) i wersję interfejsu API. Operacje są określane w treści żądania.

W pełni określony punkt końcowy ma następujące składniki:

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

Następujący klienci są często używane do wywoływania interfejsów API REST zarządzania:

Klient Instrukcje i przykłady
Azure PowerShell przy użyciu modułu Az.Search Zarządzanie usługą Azure AI Search przy użyciu Azure PowerShell
Interfejs wiersza polecenia platformy Azure Zarządzanie Search sztucznej inteligencji platformy Azure przy użyciu interfejsu wiersza polecenia platformy Azure
Visual Studio Code z klientem REST Zarządzanie Search usługi Azure AI przy użyciu interfejsu REST

Usługę wyszukiwania można również zarządzać przy użyciu Azure Portal.

Interfejsy API zarządzania w innych zestawach SDK

Interfejsy API REST są podstawowe dla Search sztucznej inteligencji platformy Azure, a wszelkie zmiany w modelu programowania są najpierw odzwierciedlane w interfejsach API REST.

Alternatywy obejmują następujące zestawy SDK platformy Azure, które są niezależnie aktualizowane zgodnie z oddzielnymi harmonogramami wydania:

Zobacz też