Schnellstart: Erstellen einer neuen Azure API Management-Instanz mithilfe der Azure CLI

GILT FÜR: Verbrauch | Developer | Basic | Standard | Premium

In dieser Schnellstartanleitung werden die Schritte zum Erstellen einer neuen API-Verwaltungsinstanz mithilfe von 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 hilft Organisationen, APIs für externe, Partner und interne Entwickler zu veröffentlichen, um das Potenzial ihrer Daten und Dienste zu entsperren. 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 nicht über ein Azure-Konto verfügen, erstellen Sie ein kostenloses Konto , bevor Sie beginnen.

Voraussetzungen

• Verwenden Sie die Bash-Umgebung in Azure Cloud Shell. Weitere Informationen finden Sie unter "Erste Schritte mit Azure Cloud Shell".

  

• Wenn Sie CLI-Referenzbefehle lieber lokal ausführen möchten, installieren Sie die Azure CLI. Wenn Sie mit Windows oder macOS arbeiten, 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. Um den Authentifizierungsprozess abzuschließen, führen Sie die schritte aus, die in Ihrem Terminal angezeigt werden. Weitere Anmeldeoptionen finden Sie unter Authentifizieren bei Azure mithilfe der Azure CLI.

  • Wenn Sie dazu aufgefordert werden, installieren Sie die Azure CLI-Erweiterung bei der ersten Verwendung. Weitere Informationen zu Erweiterungen finden Sie unter Verwenden und Verwalten 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 auf die neueste Version zu aktualisieren.

• Dieser Artikel erfordert Version 2.11.1 oder höher der Azure CLI. Wenn Sie Azure Cloud Shell verwenden, ist die neueste Version bereits installiert.

Erstellen einer Ressourcengruppe

Azure API Management-Instanzen, wie alle Azure-Ressourcen, müssen in einer Ressourcengruppe bereitgestellt werden. Mit Ressourcengruppen können Sie verwandte Azure-Ressourcen organisieren und verwalten.

Erstellen Sie zunächst eine Ressourcengruppe namens myResourceGroup in der Region Zentral-USA mit dem folgenden Befehl az group create:

az group create --name myResourceGroup --location centralus

Erstellen einer API Management-Instanz

Nachdem Sie nun über eine Ressourcengruppe verfügen, können Sie eine API-Verwaltungsinstanz erstellen. Erstellen Sie einen mithilfe des Befehls "az apim create " und geben Sie einen Dienstnamen und Publisherdetails an. Der Dienstname muss innerhalb von Azure eindeutig sein.

Im folgenden Beispiel wird myapim für den Dienstnamen verwendet. Aktualisieren Sie den Namen auf einen eindeutigen Wert. Aktualisieren Sie außerdem den Namen der Organisation des API-Herausgebers, und um Benachrichtigungen zu erhalten, aktualisieren Sie die E-Mail-Adresse.

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 auf der Entwicklerebene, eine wirtschaftliche Option zum Auswerten der Azure-API-Verwaltung. 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 kann zwischen 30 und 40 Minuten dauern, bis ein API-Verwaltungsdienst in dieser Ebene erstellt und aktiviert wird. Der vorherige Befehl verwendet die --no-wait Option, sodass der Befehl während der Erstellung des Diensts sofort zurückgegeben wird.

Überprüfen Sie den Status der Bereitstellung, indem Sie den Befehl "az apim show" ausführen:

az apim show --name myapim --resource-group myResourceGroup --output table

Anfangs ähnelt die Ausgabe folgendem, wobei der Activating Status angezeigt wird:

NAME         RESOURCE GROUP    LOCATION    GATEWAY ADDR    PUBLIC IP    PRIVATE IP    STATUS      TIER       UNITS
-----------  ----------------  ----------  --------------  -----------  ------------  ----------  ---------  -------
myapim       myResourceGroup   Central US                                             Activating  Developer  1

Nach der Aktivierung ist Online der Status und die Dienstinstanz verfügt über eine Gatewayadresse und eine öffentliche IP-Adresse. Bis jetzt stellen diese Adressen keine Inhalte bereit. 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-Verwaltungsdienstinstanz zu entfernen, wenn sie nicht benötigt werden.

az group delete --name myResourceGroup

Nächste Schritte

Importieren und Veröffentlichen Ihrer ersten API