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

  • Článek

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í, opětovné vygenerování nebo načtení api-keys (klíče pro dotazy nebo 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 vytváření a dotazování indexu, použijte místo toho rozhraní REST API vyhledávací služby .

Pokud chcete službu plně spravovat prostřednictvím kódu programu, pracujete se dvěma rozhraními API: rozhraním REST API pro správu služby Azure AI Search, které je popsané tady, a běžným rozhraním Azure Resource Manager REST API. Rozhraní RESOURCE MANAGER API se používá pro obecné operace, které nejsou specifické pro konkrétní službu, jako je dotazování dat předplatného, výpis geografických umístění atd.

Dokumentace k rozhraní API s verzemi

Dokumentace k rozhraní REST API je teď ve verzích. Když otevřete stránku s referenčními informacemi k rozhraní API, vyberte z rozevíracího filtru verzi rozhraní API.

Snímek obrazovky se voličem verzí

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

Práva pro správu se přenášejí prostřednictvím předdefinovaných rolí v Microsoft Entra ID:

  • U většiny úkolů se vyžaduje přiřazení vlastníka nebo přispěvatele.
  • Role Čtenář má omezený přístup k informacím o službě (operace GET, s výjimkou klíčů rozhraní 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 ve službě 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 najdete 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 Manager a pak přidejte ID předplatného, poskytovatele (Microsoft.Search) a verzi rozhraní API. Operace se zadají v textu požadavku.

Plně zadaný 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

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

Klient Pokyny a příklady
Azure PowerShell pomocí modulu Az.Search Správa služby Azure AI Search pomocí Azure PowerShell
Rozhraní příkazového řádku Azure (CLI) Správa služby Azure AI Search pomocí Azure CLI
Postman Správa Služby Azure AI Search pomocí REST

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

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

Rozhraní REST API jsou pro Azure AI Search základní a všechny změny programovacího modelu se nejprve projeví v rozhraních REST API.

Alternativy zahrnují následující sady Azure SDK, které se nezávisle aktualizují podle samostatných plánů vydávání verzí:

Viz také