Sdílet prostřednictvím

Referenční informace k rozhraní REST API pro správu (Azure AI Search)

Rozhraní REST API pro správu služby Azure AI Search (dříve označované jako Azure Cognitive Search) poskytují programový přístup k operacím správy:

  • Vytvoření, aktualizace a odstranění vyhledávací služby
  • Načtení informací o vyhledávací službě
  • Vytvoření, regenerace nebo načtení api-keys (dotaz nebo klíče správce)
  • Přidání nebo odebrání replik a oddílů (úprava kapacity)
  • Konfigurace vyhledávací služby pro použití privátního koncového bodu
  • Povolení nebo zakázání řízení přístupu na základě role v Azure

Pro úlohy roviny dat, jako je vytvoření indexu a dotazování na něj, použijte místo toho rozhraní REST API služby Search .

Jak pracovat s rozhraními REST API pro správu

Abyste mohli službu plně spravovat programově, pracujete se dvěma rozhraními API: rozhraním REST API pro správu, které je popsáno tady, a běžným rozhraním REST API Azure Resource Manager.

Rozhraní API Resource Manageru se používá pro operace pro obecné účely, které nejsou specifické pro službu, jako je dotazování na data předplatného, výpis geografických umístění atd. Všechna volání rozhraní API Resource Manager jsou ověřována pomocí Microsoft Entra ID. Abyste mohli volat rozhraní API Resource Manager, musíte mít členství a přiřazení role v tenantovi Microsoft Entra.

Dokumentace k rozhraní API s verzí

Dokumentace k rozhraní REST API má verzi. Když otevřete referenční stránku rozhraní API, vyberte verzi rozhraní API z rozevíracího filtru.

snímek obrazovky se selektorem verze

Oprávnění a řízení přístupu

Práva správce jsou přenášena prostřednictvím předdefinovaných rolí v Microsoft Entra ID:

  • Přiřazení vlastníka nebo přispěvatele jsou vyžadována pro většinu úkolů.
  • Role Čtenář má omezený přístup k informacím o službě (operace GET, s výjimkou klíčů API, které vyžadují oprávnění vlastníka nebo přispěvatele).

Další informace najdete v tématu Řízení přístupu na základě role v Azure AI Search.

Osvědčeným postupem je přiřazovat role skupinám, nikoli jednotlivým uživatelům. Tato přiřazení spravuje vlastník předplatného Azure nebo globální správce. Další informace naleznete v tématu Přiřazení rolí Microsoft Entra skupinám.

Připojení ke koncovému bodu správy

Při nastavování připojení začněte koncovým bodem https://management.azure.com Resource Manageru a pak přidejte ID předplatného, poskytovatele (Microsoft.Search) a verzi rozhraní API. Operace jsou uvedeny v textu žádosti.

Plně specifikovaný koncový bod má následující komponenty:

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

K volání rozhraní REST API pro správu se běžně používají následující klienti:

Klient Návody a příklady
Azure PowerShell pomocí modulu Az.Search Správa vyhledávání Azure AI pomocí Azure PowerShell
Azure Command-Line rozhraní (CLI) Správa Azure AI Search pomocí Azure CLI
Visual Studio Code s klientem REST Správa Azure AI Search pomocí REST

Vyhledávací službu můžete spravovat také pomocí webu Azure Portal.

Rozhraní API pro správu v jiných sadách SDK

Rozhraní REST API jsou základem služby Azure AI Search a jakékoli změny programovacího modelu se nejprve projeví v rozhraních REST API.

Mezi alternativy patří následující sady Azure SDK, které se nezávisle aktualizují v samostatných plánech vydání:

Viz také

  • Last updated on