Schnellstartanleitung: Erstellen einer neuen Azure API Managementinstanz mithilfe der Azure CLI
GILT FÜR: Verbrauch | Developer | Basic | Standard | Premium
In dieser Schnellstartanleitung werden die Schritte zum Erstellen einer neuen API Managementinstanz mit Azure CLI-Befehlen beschrieben. Nach dem Erstellen einer Instanz können Sie die Azure CLI für allgemeine Verwaltungsaufgaben wie das Importieren von APIs in Ihrer API-Verwaltungsinstanz verwenden.
Azure API Management unterstützt Organisationen beim Veröffentlichen von APIs für externe, Partner- und interne Entwickler, um das volle Potenzial von Daten und Diensten nutzen zu können. API Management bietet die Kernkompetenzen zur Sicherstellung eines erfolgreichen API-Programms in Form von Entwicklerengagement, geschäftlichen Erkenntnissen, Analysen, Sicherheit und Schutz. Mit API Management können Sie moderne API-Gateways für vorhandene Back-End-Dienste, die an einem beliebigen Ort gehostet werden, erstellen und verwalten.
Wenn Sie kein Azure-Abonnement haben, erstellen Sie ein kostenloses Azure-Konto, bevor Sie beginnen.
Voraussetzungen
Verwenden Sie die Bash-Umgebung in Azure Cloud Shell. Weitere Informationen finden Sie unter Schnellstart für Bash in Azure Cloud Shell.
Wenn Sie CLI-Referenzbefehle lieber lokal ausführen, installieren Sie die Azure CLI. Wenn Sie Windows oder macOS ausführen, sollten Sie die Azure CLI in einem Docker-Container ausführen. Weitere Informationen finden Sie unter Ausführen der Azure CLI in einem Docker-Container.
Wenn Sie eine lokale Installation verwenden, melden Sie sich mithilfe des Befehls az login bei der Azure CLI an. Führen Sie die in Ihrem Terminal angezeigten Schritte aus, um den Authentifizierungsprozess abzuschließen. Informationen zu anderen Anmeldeoptionen finden Sie unter Anmelden mit der Azure CLI.
Installieren Sie die Azure CLI-Erweiterung beim ersten Einsatz, wenn Sie dazu aufgefordert werden. Weitere Informationen zu Erweiterungen finden Sie unter Verwenden von Erweiterungen mit der Azure CLI.
Führen Sie az version aus, um die installierte Version und die abhängigen Bibliotheken zu ermitteln. Führen Sie az upgrade aus, um das Upgrade auf die aktuelle Version durchzuführen.
- Für diesen Artikel ist mindestens Version 2.11.1 der Azure CLI erforderlich. Bei Verwendung von Azure Cloud Shell ist die aktuelle Version bereits installiert.
Erstellen einer Ressourcengruppe
Azure API Management-Instanzen müssen wie alle Azure-Ressourcen in einer Ressourcengruppe bereitgestellt werden. Mit Ressourcengruppen können Sie verwandte Azure-Ressourcen organisieren und verwalten.
Erstellen Sie zunächst mit dem folgenden az group create-Befehl eine Ressourcengruppe namens myResourceGroup am Standort „USA, Mitte“:
az group create --name myResourceGroup --location centralus
Erstellen einer API Management-Instanz
Da Sie nun über eine Ressourcengruppe verfügen, können Sie eine API Managementinstanz erstellen. Erstellen Sie eine solche Instanz mithilfe des az apim create-Befehls, und geben Sie einen Dienstname sowie Details zum Herausgeber an. Der Dienstname muss in Azure eindeutig sein.
Im folgenden Beispiel wird myapim als Dienstname verwendet. Ersetzen Sie diesen Namen durch einen eindeutigen Wert. Aktualisieren Sie außerdem den Namen der Organisation des Herausgebers der API sowie die E-Mail-Adresse, um Benachrichtigungen zu erhalten.
az apim create --name myapim --resource-group myResourceGroup \
--publisher-name Contoso --publisher-email admin@contoso.com \
--no-wait
Standardmäßig erstellt der Befehl die Instanz im Developer-Tarif, wobei es sich um eine günstige Option zum Bewerten von Azure API Management handelt. Dieser Tarif ist nicht für die Produktion bestimmt. Weitere Informationen zum Skalieren der API Management-Tarife finden Sie unter Upgrade and scale an API Management instance (Upgraden und Skalieren einer API Management-Instanz).
Tipp
Es dauert in der Regel zwischen 30 und 40 Minuten, einen API Management-Dienst mit diesem Tarif zu erstellen und zu aktivieren. Der vorherige Befehl nutzt die --no-wait-Option, sodass der Befehl sofort etwas zurückgibt, während der Dienst erstellt wird.
Überprüfen Sie den Bereitstellungsstatus, indem Sie den az apim show-Befehl ausführen:
az apim show --name myapim --resource-group myResourceGroup --output table
Zunächst sieht die Ausgabe in etwa wie folgt aus und weist den Activating-Status auf:
NAME RESOURCE GROUP LOCATION GATEWAY ADDR PUBLIC IP PRIVATE IP STATUS TIER UNITS
----------- ---------------- ---------- -------------- ----------- ------------ ---------- --------- -------
myapim myResourceGroup Central US Activating Developer 1
Nach der Aktivierung lautet der Status Online, und die Dienstinstanz verfügt über eine Gatewayadresse und eine öffentliche IP-Adresse. Zu diesem Zeitpunkt machen diese Adressen keine Inhalte verfügbar. Zum Beispiel:
NAME RESOURCE GROUP LOCATION GATEWAY ADDR PUBLIC IP PRIVATE IP STATUS TIER UNITS
----------- ---------------- ---------- --------------------------------- ------------ ------------ -------- --------- -------
myapim myResourceGroup Central US https://myapim.azure-api.net 203.0.113.1 Online Developer 1
Sobald Ihre API Management-Dienstinstanz online ist, können Sie sie verwenden. Beginnen Sie mit dem Tutorial Importieren und Veröffentlichen Ihrer ersten API.
Bereinigen von Ressourcen
Sie können den Befehl az group delete verwenden, um die Ressourcengruppe und die API Management-Dienstinstanz zu entfernen, wenn diese nicht benötigt werden.
az group delete --name myResourceGroup