Erstellen und Verwalten eines Arbeitsbereichs in Azure API Management
GILT FÜR: Premium
Richten Sie einen Arbeitsbereich ein, damit ein API-Team eigene APIs verwalten und in die Produktion überführen kann, während dem API-Plattformteam die Tools zum Beobachten, Steuern und Verwalten der API Management-Plattform zur Verfügung stehen. Nachdem Sie einen Arbeitsbereich erstellt und Berechtigungen zugewiesen haben, können Arbeitsbereichsmitarbeiter eigene APIs, Produkte, Abonnements und zugehörige Ressourcen erstellen und verwalten.
Hinweis
- Die aktuellen Arbeitsbereichsfunktionen werden in der API Management-REST-API-Version 2023-09-01-preview oder höher unterstützt.
- Informationen zur Preisgestaltung finden Sie unter API Management – Preise.
Führen Sie die Schritte in diesem Artikel für folgende Aktionen aus:
- Erstellen eines API Management-Arbeitsbereichs und eines Arbeitsbereichs-Gateways mithilfe des Azure-Portals
- Optionales Isolieren des Arbeitsbereichs-Gateways in einem virtuellen Azure-Netzwerk
- Zuweisen von Berechtigungen zum Arbeitsbereich
Hinweis
- Derzeit ist das Erstellen eines Arbeitsbereichs-Gateways ein zeitintensiver Vorgang, der bis zu 3 Stunden oder länger dauern kann.
- Wir führen die Möglichkeit ein, mehrere Arbeitsbereiche einem Arbeitsbereichs-Gateway zuzuordnen, um Organisationen dabei zu helfen, APIs mit Arbeitsbereichen zu niedrigeren Kosten zu verwalten. Dieses Feature wird ab Dezember 2024 eingeführt und ist möglicherweise nicht vor Januar für alle geeigneten Dienste verfügbar. Weitere Informationen
Voraussetzungen
- Eine API Management-Instanz. Erstellen Sie ggf. eine in einer unterstützten Ebene.
- Rolle Besitzer oder Mitwirkender für die Ressourcengruppe, in der die API Management-Instanz bereitgestellt wird, oder gleichwertige Berechtigungen zum Erstellen von Ressourcen in der Ressourcengruppe
- (Optional) Ein vorhandenes oder neues virtuelles Azure-Netzwerk und -Subnetz, um den eingehenden und ausgehenden Datenverkehr des Arbeitsbereichs-Gateways zu isolieren. Informationen zu Konfigurationsoptionen und Anforderungen finden Sie unter Netzwerkressourcenanforderungen für die Integration eines Arbeitsbereichs-Gateways in ein virtuelles Netzwerk.
Einen Arbeitsbereich erstellen – Portal
Melden Sie sich beim Azure-Portal an, und navigieren Sie zu Ihrer API Management-Instanz.
Wählen Sie im linken Menü unter APIs die Option Arbeitsbereiche>+ Hinzufügen aus.
Geben Sie auf der Registerkarte Grundlagen einen aussagekräftigen Anzeigenamen, einen Ressourcennamen und eine optionale Beschreibung für den Arbeitsbereich ein. Wählen Sie Weiter aus.
Konfigurieren Sie auf der Registerkarte Gateway Einstellungen für das Arbeitsbereichs-Gateway:
Geben Sie unter Gatewaydetailseinen Gatewaynamen ein, und wählen Sie die Anzahl der Skalierungseinheiten aus. Die Gatewaykosten basieren auf der Anzahl der ausgewählten Einheiten. Weitere Informationen finden Sie unter API Management-Preise.
Wählen Sie unter Netzwerk eine Netzwerkkonfiguration für Ihr Arbeitsbereichs-Gateway aus.
Wichtig
Planen Sie die Netzwerkkonfiguration Ihres Arbeitsbereichs sorgfältig. Sie können die Netzwerkkonfiguration nach dem Erstellen des Arbeitsbereichs nicht mehr ändern.
Wenn Sie eine Netzwerkkonfiguration auswählen, die den privaten eingehenden oder ausgehenden Netzwerkzugriff umfasst, wählen Sie ein virtuelles Netzwerk und ein Subnetz aus, um das Arbeitsbereichs-Gateway zu isolieren, oder erstellen Sie ein neues Netzwerk. Informationen zu den Netzwerkanforderungen finden Sie unter Netzwerkressourcenanforderungen für die Integration eines Arbeitsbereichs-Gateways in ein virtuelles Netzwerk.
Wählen Sie Weiter aus. Wenn die Überprüfung abgeschlossen ist, wählen Sie Erstellen aus.
Die Erstellung des Arbeitsbereichs, des Arbeitsbereichs-Gateways und der zugehörigen Ressourcen kann zwischen einigen Minuten und mehreren Stunden dauern. Um den Bereitstellungsstatus im Azure-Portal nachzuverfolgen, wechseln Sie zur Ressourcengruppe des Gateways. Wählen Sie im linken Menü unter Einstellungen die Option Bereitstellungen aus.
Nach Abschluss der Bereitstellung wird der neue Arbeitsbereich wird in der Liste auf der Seite Arbeitsbereiche angezeigt. Wählen Sie den Arbeitsbereich aus, um seine Einstellungen und Ressourcen zu verwalten.
Hinweis
- Um den Hostnamen der Gatewayruntime und andere Gatewaydetails anzuzeigen, wählen Sie den Arbeitsbereich im Portal aus. Wählen Sie unter Bereitstellung + Infrastruktur die Option Gateways und dann den Namen des Gateways des Arbeitsbereichs aus.
- Während das Arbeitsbereichs-Gateway erstellt wird, sind Runtimeaufrufe der APIs des Arbeitsbereichs nicht erfolgreich.
Benutzer zum Arbeitsbereich zuweisen – Portal
Nachdem Sie einen Arbeitsbereich erstellt haben, weisen Sie Benutzern Berechtigungen zum Verwalten der Ressourcen des Arbeitsbereichs zu. Jedem Arbeitsbereichsbenutzer muss sowohl eine dienstbezogene Arbeitsbereichs-RBAC-Rolle als auch eine arbeitsbereichsbezogene RBAC-Rolle zugewiesen werden, oder ihm müssen gleichwertige Berechtigungen mithilfe benutzerdefinierter Rollen erteilt werden.
Um das Arbeitsbereichs-Gateway zu verwalten, wird empfohlen, Arbeitsbereichsbenutzern zudem eine von Azure bereitgestellte RBAC-Rolle zuzuweisen, die auf das Arbeitsbereichs-Gateway ausgerichtet ist.
Hinweis
Richten Sie zur einfacheren Verwaltung Microsoft Entra ID-Gruppen ein, um Arbeitsbereichsberechtigungen für mehrere Benutzer zuzuweisen.
- Eine Liste der integrierten Arbeitsbereichsrollen finden Sie unter Verwenden der rollenbasierten Zugriffssteuerung in API Management.
- Schritte zum Zuweisen von Rollen finden Sie unter Azure-Rollen über das Azure-Portal zuweisen.
Dienstrolle zuweisen
Melden Sie sich beim Azure-Portal an, und navigieren Sie zu Ihrer API Management-Instanz.
Wählen Sie im linken Menü Zugriffssteuerung (IAM)>+ Hinzufügen aus.
Weisen Sie jedem Mitglied des Arbeitsbereichs eine der folgenden dienstbezogene Rollen zu:
- Arbeitsbereichs-API-Entwickler für API Management-Dienst
- Arbeitsbereichs-API-Produktmanager des API Management-Diensts
Arbeitsbereichsbezogene Rolle zuweisen
Wählen Sie im Menü für Ihre API Management-Instanz unter APIs die Option Arbeitsbereiche und dann den Namen des erstellten Arbeitsbereichs aus.
Wählen Sie im Fenster Arbeitsbereich die Option Zugriffssteuerung (IAM)>+ Hinzufügen aus.
Weisen Sie den Arbeitsbereichsmitgliedern eine der folgenden arbeitsbereichsbezogenen Rollen zu, damit sie Arbeitsbereichs-APIs und andere Ressourcen verwalten können.
- API Management-Arbeitsbereichsleser
- API Management-Arbeitsbereichsmitwirkender
- Arbeitsbereichs-API-Entwickler für API Management
- Arbeitsbereichs-API-Produktmanager für API Management
Zuweisen einer gatewaybezogenen Rolle
Melden Sie sich beim Azure-Portal an, und navigieren Sie zu Ihrer API Management-Instanz.
Wählen Sie im linken Menü unter APIs die Option Arbeitsbereiche und dann den Namen Ihres Arbeitsbereichs aus.
Wählen Sie im linken Menü des Arbeitsbereichs Gateways und dann das Arbeitsbereichsgateway aus.
Wählen Sie im linken Menü Zugriffssteuerung (IAM)>+ Hinzufügen aus.
Weisen Sie den einzelnen Mitgliedern des Arbeitsbereichs eine der folgenden Rollen zu. Es wird mindestens empfohlen, die Rolle Leser zuzuweisen, um die Einstellungen des Gateways anzuzeigen. Besitzer und Mitwirkende können die Einstellungen des Gateways verwalten und u. a. das Gateway skalieren.
- Besitzer
- Mitwirkender
- Leser
Erste Schritte mit Ihrem Arbeitsbereich
Abhängig von Ihrer Rolle im Arbeitsbereich verfügen Benutzer möglicherweise über Berechtigungen zum Erstellen von APIs, Produkten, Abonnements und anderen Ressourcen, oder sie haben schreibgeschützten Zugriff auf einige oder alle Optionen.
Informationen zu den ersten Schritten beim Verwalten, Schützen und Veröffentlichen von APIs in einem Arbeitsbereich finden Sie in der folgenden Anleitung.