Udostępnij przez

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

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

  • Tworzenie, aktualizowanie i usuwanie usługi wyszukiwania
  • Pobieranie informacji o usłudze wyszukiwania
  • Tworzenie, ponowne generowanie lub pobieranie api-keys (klucze zapytania lub administratora)
  • Dodawanie lub usuwanie replik i partycji (dostosowywanie pojemności)
  • Konfigurowanie usługi wyszukiwania do korzystania z 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 zapytań, zamiast tego użyj interfejsów API REST usługi wyszukiwania .

Jak pracować z interfejsami API REST zarządzania

Aby w pełni programowo administrować usługą, należy korzystać z dwóch interfejsów API: interfejsu API REST zarządzania usługi Azure AI Search udokumentowanego tutaj oraz wspólnego interfejsu 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, takich 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 identyfikatora Microsoft Entra. Aby wykonywać wywołania interfejsu API usługi Resource Manager, musisz mieć członkostwo i przypisanie roli w dzierżawie usługi Microsoft Entra.

Dokumentacja wersji interfejsu API

Dokumentacja interfejsu API REST jest 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 pośrednictwem wbudowanych ról w identyfikatorze 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 grupom, a nie poszczególnym użytkownikom. Właścicielem subskrypcji platformy Azure lub administratorem globalnym 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 zacznij 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ślone 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żywani 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 poleceń Azure Command-Line (CLI) Zarządzanie usługą Azure AI Search przy użyciu interfejsu wiersza polecenia platformy Azure
Program Visual Studio Code z klientem REST Zarządzanie usługą Azure AI Search 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 usługi Azure AI Search, 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 w oddzielnych harmonogramach wydań:

Zobacz także

  • Last updated on