Schnellstart: Erstellen Ihres API Centers – Azure CLI

Artikel
07/08/2024

Richten Sie Ihr API-Center ein, um eine Bestandsaufnahme der APIs Ihrer Organisation zu starten. Das Azure API Center ermöglicht die Nachverfolgung von APIs an einem zentralen Ort für Ermittlung, Wiederverwendung und Governance.

Führen Sie nach dem Erstellen Ihres API-Centers die Schritte in den Tutorials aus, um benutzerdefinierte Metadaten, APIs, Versionen, Definitionen und andere Informationen hinzuzufügen.

Voraussetzungen

Wenn Sie kein Azure-Abonnement haben, erstellen Sie ein kostenloses Azure-Konto, bevor Sie beginnen.
Mindestens eine Zuweisung der Rolle „Mitwirkender“ oder gleichwertige Berechtigungen im Azure-Abonnement.

Für die Azure CLI:
- 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.
Hinweis

Für az apic-Befehle wird die Azure CLI-Erweiterung apic-extension benötigt. Wenn Sie keine az apic-Befehle verwendet haben, kann die Erweiterung dynamisch installiert werden, wenn Sie den ersten az apic-Befehl ausführen. Sie können die Erweiterung auch manuell installieren. Hier finden Si weitere Informationen zu Azure CLI-Erweiterungen.

In den Versionshinweisen finden Sie die neuesten Änderungen und Updates in der apic-extension.

Registrieren des Microsoft.ApiCenter-Anbieters

Wenn dies noch nicht geschehen ist, müssen Sie den Ressourcenanbieter Microsoft.ApiCenter in Ihrem Abonnement registrieren. Sie müssen den Ressourcenanbieter nur einmal registrieren.

Führen Sie den folgenden az provider register-Befehl aus, um den Ressourcenanbieter in Ihrem Abonnement mithilfe der Azure CLI zu registrieren:

az provider register --namespace Microsoft.ApiCenter

Sie können den Registrierungsstatus überprüfen, indem Sie den folgenden az provider show-Befehl ausführen:

az provider show --namespace Microsoft.ApiCenter

Erstellen einer Ressourcengruppe

Azure API Center-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 mit dem Befehl az group create eine Ressourcengruppe. Im folgenden Beispiel wird eine Gruppe mit dem Namen MyGroup am Standort USA, Osten erstellt:

az group create --name MyGroup --location eastus

Erstellen eines API-Centers

Erstellen Sie eine API mit dem Befehl az apic create.

Im folgenden Beispiel wird ein API Center mit dem Namen MyApiCenter in der MyGroup-Ressourcengruppe erstellt. In diesem Beispiel wird das API Center am Standort Europa, Westen bereitgestellt. Ersetzen Sie einen API Center-Namen Ihrer Wahl, und geben Sie einen der verfügbaren Standorte für Ihr API Center ein.

az apic create --name MyApiCenter --resource-group MyGroup --location westeurope

Die Ausgabe des Befehls sieht in etwa wie folgt aus. Standardmäßig wird das API Center im Free-Tarif erstellt.

{
  "dataApiHostname": "myapicenter.data.westeurope.azure-apicenter.ms",
  "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/mygroup/providers/Microsoft.ApiCenter/services/myapicenter",
  "location": "westeurope",
  "name": "myapicenter",
  "resourceGroup": "mygroup",
  "sku": {
    "name": "Free"
  },
  "systemData": {
    "createdAt": "2024-06-22T21:40:35.2541624Z",
    "lastModifiedAt": "2024-06-22T21:40:35.2541624Z"
  },
  "tags": {},
  "type": "Microsoft.ApiCenter/services"
}

Nach der Bereitstellung ist Ihr API-Center einsatzbereit!

Nächste Schritte

Jetzt können Sie mit dem Hinzufügen von Informationen zum Bestand im API-Center beginnen. Um Ihre APIs und andere Informationen zu organisieren, definieren Sie zunächst benutzerdefinierte Metadaten in Ihrem API Center.

Definieren von benutzerdefinierten Metadaten

Freigeben über