REST-API-Referenz für die Verwaltung (Azure KI-Suche)

Die Verwaltungs-REST-APIs von Azure KI-Suche (früher als Azure Cognitive Search bezeichnet) bieten programmgesteuerten Zugriff auf Verwaltungsvorgänge:

  • Erstellen, Aktualisieren und Löschen eines Suchdiensts
  • Abrufen von Suchdienstinformationen
  • Erstellen, Regenerieren oder Abrufen api-keys (Abfrage- oder Administratorschlüssel)
  • Hinzufügen oder Entfernen von Replikaten und Partitionen (Anpassen der Kapazität)
  • Konfigurieren eines Suchdiensts für die Verwendung eines privaten Endpunkts
  • Aktivieren oder Deaktivieren der rollenbasierten Zugriffssteuerung in Azure

Verwenden Sie für Aufgaben auf Datenebene, z. B. das Erstellen und Abfragen eines Indexes, stattdessen die REST-APIs des Suchdiensts .

Arbeiten mit den Verwaltungs-REST-APIs

Um Ihren Dienst vollständig programmgesteuert zu verwalten, arbeiten Sie mit zwei APIs: der Verwaltungs-REST-API von Azure KI-Suche, die hier dokumentiert ist, sowie der allgemeinen Azure Resource Manager-REST-API.

Die Resource Manager-API wird für allgemeine Vorgänge verwendet, die nicht dienstspezifisch sind, z. B. das Abfragen von Abonnementdaten, das Auflisten von geografischen Standorten usw. Alle Resource Manager-API-Aufrufe werden mithilfe der Microsoft Entra ID authentifiziert. Sie müssen über eine Mitgliedschaft und eine Rollenzuweisung in einem Microsoft Entra Mandanten verfügen, um Resource Manager-API-Aufrufe ausführen zu können.

Versionsierte API-Dokumente

REST-API-Dokumente sind versioniert. Wenn Sie eine API-Referenzseite öffnen, wird oberhalb des Inhaltsverzeichnisses eine Versionsauswahl angezeigt. Der Selektor wird verfügbar, wenn Sie eine Seite aus dem Ordner Reference > Resource Manager auswählen.

Screenshot der Versionsauswahl.

Berechtigungen und Zugriffssteuerung

Administrationsrechte werden über integrierte Rollen in Microsoft Entra ID vermittelt:

  • Für die meisten Aufgaben sind Besitzer- oder Mitwirkenden-Zuweisungen erforderlich.
  • Die Rolle "Leser " hat eingeschränkten Zugriff auf Dienstinformationen (GET-Vorgänge, mit Ausnahme von API-Schlüsseln, für die die Berechtigungen "Besitzer" oder "Mitwirkender" erforderlich sind).

Weitere Informationen finden Sie unter Rollenbasierte Zugriffssteuerung in Azure KI-Suche.

Eine bewährte Methode besteht darin, Rollen Gruppen und nicht einzelnen Benutzern zuzuweisen. Diese Zuweisungen werden von einem Azure-Abonnementbesitzer oder globalen Administrator verwaltet. Weitere Informationen finden Sie unter Zuweisen von Microsoft Entra-Rollen zu Gruppen.

Herstellen einer Verbindung mit dem Verwaltungsendpunkt

Beginnen Sie beim Einrichten der Verbindung mit dem Resource Manager-Endpunkt https://management.azure.com , und fügen Sie dann die Abonnement-ID, den Anbieter (Microsoft.Search) und die API-Version hinzu. Vorgänge werden im Text der Anforderung angegeben.

Ein vollständig angegebener Endpunkt verfügt über die folgenden Komponenten:

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

Die folgenden Clients werden häufig zum Aufrufen der Verwaltungs-REST-APIs verwendet:

Kunde Anleitungen und Beispiele
Azure PowerShell mit dem Az.Search-Modul Verwalten der Azure KI-Suche mit Azure PowerShell
Azure-Befehlszeilenschnittstelle (Command-Line Interface, CLI). Verwalten der Azure KI-Suche mit der Azure CLI
Visual Studio Code mit dem REST-Client Verwalten der Azure KI-Suche mithilfe von REST

Sie können einen Suchdienst auch über das Azure-Portal verwalten.

Verwaltungs-APIs in anderen SDKs

Die REST-APIs sind die Grundlage für Azure KI-Suche, und alle Änderungen am Programmiermodell werden zuerst in den REST-APIs widergespiegelt.

Zu den Alternativen gehören die folgenden Azure SDKs, die unabhängig voneinander nach separaten Veröffentlichungszeitplänen aktualisiert werden:

Siehe auch

  • Last updated on