Feedback

az apim

  • Referenz

Verwalten von Azure-API Management-Diensten.

Befehle

az apim api

Verwalten sie azure API Management API's.
az apim api create

Erstellen Sie eine API Management API.
az apim api delete

Löschen Sie eine API Management-API.
az apim api import

Importieren Sie eine API Management-API.
az apim api list

Liste API Management API's auf.
az apim api operation

Verwalten von Azure API Management API-Vorgängen.
az apim api operation create

Erstellt einen neuen Vorgang in der API.
az apim api operation delete

Löscht den angegebenen Vorgang aus der API
az apim api operation list

Listet eine Auflistung der Vorgänge für die angegebene API auf.
az apim api operation show

Ruft die Details des API-Vorgangs ab, der durch den Bezeichner angegeben wird.
az apim api operation update

Aktualisierungen die Details des Vorgangs in der API, die durch den Bezeichner angegeben wird.
az apim api release

Verwalten der Azure API Management API Release.
az apim api release create

Erstellt ein neues Release für die API
az apim api release delete

Löscht die angegebene Version in der API.
az apim api release list

Listet alle Releases einer API auf.
az apim api release show

Gibt die Details einer API-Version zurück.
az apim api release update

Aktualisierungen die Details der Veröffentlichung der API, die durch den Bezeichner angegeben wird.
az apim api revision

Verwalten von Azure API Management API-Revision.
az apim api revision create

Erstellen Sie die API-Überarbeitung.
az apim api revision list

Listet alle Revisionen einer API auf
az apim api schema

Verwalten des Azure API Management-API-Schemas.
az apim api schema create

Erstellen Sie ein API Management API-Schema.
az apim api schema delete

Löschen eines API Management API-Schemas.
az apim api schema get-etag

Rufen Sie das Etag eines API Management API-Schemas ab.
az apim api schema list

Listen API Management API-Schemas auf.
az apim api schema show

Details eines API Management API-Schemas anzeigen.
az apim api schema wait

Platzieren Sie die CLI in einem Wartenstatus, bis eine Bedingung eines APIM-API-Schemas erfüllt ist.
az apim api show

Details einer API Management-API anzeigen.
az apim api update

Aktualisieren einer API Management-API.
az apim api versionset

Verwalten von Azure API Management API-Versionssatz.
az apim api versionset create

Erstellt einen API-Versionssatz.
az apim api versionset delete

Löscht die angegebene API-Versionsgruppe
az apim api versionset list

Listet eine Auflistung von API-Versionsgruppen in der angegebenen Dienstinstanz auf
az apim api versionset show

Ruft die Details des API-Versionssatzes ab, der durch den Bezeichner angegeben wird.
az apim api versionset update

Aktualisierungen die Details des api VersionSets, das durch den Bezeichner angegeben wird.
az apim api wait

Platzieren Sie die CLI in einem Wartenstatus, bis eine Bedingung einer API erfüllt ist.
az apim apply-network-updates

Aktualisieren Sie die API Management Ressource, die im virtuellen Netzwerk ausgeführt wird, um die aktualisierten Netzwerkeinstellungen zu auswählen.
az apim backup

Erstellt eine Sicherung des API Management-Diensts für das angegebene Azure Storage-Konto. Dies ist lang ausgeführter Vorgang und kann mehrere Minuten dauern, bis der Vorgang abgeschlossen ist.
az apim check-name

Überprüft, ob ein Dienstname verwendet werden kann.
az apim create

Erstellen einer API Management-Dienstinstanz
az apim delete

Löscht einen API Management Dienst.
az apim deletedservice

Verwalten von weich gelöschten Azure-API Management-Diensten.
az apim deletedservice list

Listet alle instanzen der soft-gelöschten API-Verwaltungsdienste auf, die für das angegebene Abonnement verfügbar sind.
az apim deletedservice purge

Löschen Sie soft-gelöschte API-Verwaltungsdienstinstanz (löscht sie ohne Option zum Rückgängigmachen).
az apim deletedservice show

Rufen Sie soft-gelöschte API-Verwaltungsdienstinstanzen ab, die für den Namen verfügbar sind.
az apim list

Liste API Management Dienstinstanzen auf.
az apim nv

Verwalten von Azure API Management benannten Werten.
az apim nv create

Erstellen Sie einen API Management benannten Wert.
az apim nv delete

Löschen Sie einen API Management benannten Wert.
az apim nv list

Liste API Management benannten Werten auf.
az apim nv show

Details eines API Management benannten Werts anzeigen.
az apim nv show-secret

Ruft den geheimen Schlüssel eines API Management benannten Werts ab.
az apim nv update

Aktualisieren eines API Management benannten Werts.
az apim nv wait

Platzieren Sie die CLI in einem Wartezeitstatus, bis eine Bedingung eines apim benannten Werts erfüllt ist.
az apim product

Verwalten von Azure API Management Produkt.
az apim product api

Verwalten sie die APIs des Azure API Management Produkts.
az apim product api add

Fügen Sie dem angegebenen Produkt eine API hinzu.
az apim product api check

Überprüft, ob die API-Entität, die durch Bezeichner angegeben ist, der Product-Entität zugeordnet ist.
az apim product api delete

Löscht die angegebene API aus dem angegebenen Produkt
az apim product api list

Listet eine Auflistung von APIs auf, die einem Produkt zugeordnet sind
az apim product create

Erstellt ein Produkt.
az apim product delete

Löscht das Produkt
az apim product list

Listet eine Auflistung der Produkte in der angegebenen Dienstinstanz auf
az apim product show

Ruft die Details des durch den Bezeichner angegebenen Produkts ab.
az apim product update

Aktualisieren sie vorhandene Produktdetails.
az apim product wait

Platzieren Sie die CLI in einem Wartenstatus, bis eine Bedingung eines APIM-Produkts erfüllt ist.
az apim restore

Stellt eine Sicherung eines API Management Diensts, der mithilfe des ApiManagementService_Backup-Vorgangs des aktuellen Diensts erstellt wurde, wiederhergestellt. Dies ist ein lang ausgeführter Vorgang und kann mehrere Minuten dauern, bis der Vorgang abgeschlossen ist.
az apim show

Details einer API Management Dienstinstanz anzeigen.
az apim update

Aktualisieren einer API Management Dienstinstanz.
az apim wait

Platzieren Sie die CLI in einem Wartenstatus, bis eine Bedingung eines APIm erfüllt ist.

az apim apply-network-updates

Bearbeiten

Aktualisieren Sie die API Management Ressource, die im virtuellen Netzwerk ausgeführt wird, um die aktualisierten Netzwerkeinstellungen zu auswählen.

az apim apply-network-updates --name
                              --resource-group
                              [--location]
                              [--no-wait]

Beispiele

Aktualisieren der virtuellen Netzwerkeinstellungen der API Management Dienstinstanz

az apim apply-network-updates --name MyApim -g MyResourceGroup

Erforderliche Parameter

--name -n

Der Name der API-Verwaltungsdienstinstanz.

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

Optionale Parameter

--location -l

Der Standort. Werte aus: az account list-locations. Sie können den standardmäßig verwendeten Standort mit az configure --defaults location=<location> konfigurieren.

--no-wait

Nicht auf den Abschluss lang andauernder Vorgänge warten

az apim backup

Bearbeiten

Erstellt eine Sicherung des API Management-Diensts für das angegebene Azure Storage-Konto. Dies ist lang ausgeführter Vorgang und kann mehrere Minuten dauern, bis der Vorgang abgeschlossen ist.

az apim backup --backup-name
               --container-name
               --name
               --resource-group
               --storage-account-key
               --storage-account-name
               [--no-wait]

Beispiele

Erstellen einer Sicherung der API Management Dienstinstanz

az apim backup --name MyApim -g MyResourceGroup --backup-name myBackup              --storage-account-name mystorageaccount --storage-account-container backups              --storage-account-key Ay2ZbdxLnD4OJPT29F6jLPkB6KynOzx85YCObhrw==

Erforderliche Parameter

--backup-name

Der Name der zu erstellenden Sicherungsdatei.

--container-name --storage-account-container

Der Name des Speicherkontocontainers, der zum Platzieren der Sicherung verwendet wird.

--name -n

Der Name der API-Verwaltungsdienstinstanz.

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

--storage-account-key

Der Zugriffsschlüssel des Speicherkontos, das zum Platzieren der Sicherung verwendet wird.

--storage-account-name

Der Name des Speicherkontos, das zum Platzieren der Sicherung verwendet wird.

Optionale Parameter

--no-wait

Nicht auf den Abschluss lang andauernder Vorgänge warten

az apim check-name

Bearbeiten

Überprüft, ob ein Dienstname verwendet werden kann.

az apim check-name --name

Erforderliche Parameter

--name -n

Der Name der API-Verwaltungsdienstinstanz.

az apim create

Bearbeiten

Erstellen einer API Management-Dienstinstanz

az apim create --name
               --publisher-email
               --publisher-name
               --resource-group
               [--enable-client-certificate {false, true}]
               [--enable-managed-identity {false, true}]
               [--location]
               [--no-wait]
               [--sku-capacity]
               [--sku-name {Basic, Consumption, Developer, Isolated, Premium, Standard}]
               [--tags]
               [--virtual-network {External, Internal, None}]

Beispiele

Erstellen Sie einen Entwicklerebenen-API Management Dienst.

az apim create --name MyApim -g MyResourceGroup -l eastus --publisher-email email@mydomain.com --publisher-name Microsoft

Erstellen Sie eine Nutzungsstufe API Management Dienst.

az apim create --name MyApim -g MyResourceGroup -l eastus --sku-name Consumption --enable-client-certificate \
    --publisher-email email@mydomain.com --publisher-name Microsoft

Erforderliche Parameter

--name -n

Eindeutiger Name der zu erstellenden Dienstinstanz.

--publisher-email

Die E-Mail-Adresse, um alle Systembenachrichtigungen zu erhalten.

--publisher-name

Der Name Ihrer Organisation für die Verwendung im Entwicklerportal und E-Mail-Benachrichtigungen.

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

Optionale Parameter

--enable-client-certificate

Erzwingt ein Clientzertifikat, das für jede Anforderung an das Gateway angezeigt werden soll und ermöglicht auch die Möglichkeit, das Zertifikat in der Richtlinie auf dem Gateway zu authentifizieren.

Zulässige Werte: false, true
--enable-managed-identity

Erstellen Sie eine verwaltete Identität für den API Management-Dienst, um auf andere Azure-Ressourcen zuzugreifen.

Zulässige Werte: false, true
--location -l

Der Standort. Werte aus: az account list-locations. Sie können den standardmäßig verwendeten Standort mit az configure --defaults location=<location> konfigurieren.

--no-wait

Nicht auf den Abschluss lang andauernder Vorgänge warten

--sku-capacity

Die Anzahl der bereitgestellten Einheiten der SKU.

Standardwert: 1
--sku-name

Die Sku der API-Verwaltungsinstanz.

Zulässige Werte: Basic, Consumption, Developer, Isolated, Premium, Standard
Standardwert: Developer
--tags

Leergetrennte Tags: key[=value] [key[=value] ...]. Verwenden Sie "", um vorhandene Tags zu löschen.

--virtual-network -v

Der virtuelle Netzwerktyp.

Zulässige Werte: External, Internal, None
Standardwert: None

az apim delete

Bearbeiten

Löscht einen API Management Dienst.

az apim delete --name
               --resource-group
               [--no-wait]
               [--yes]

Beispiele

Löschen Sie einen API Management Dienst.

az apim delete -n MyApim -g MyResourceGroup

Erforderliche Parameter

--name -n

Der Name der API-Verwaltungsdienstinstanz.

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

Optionale Parameter

--no-wait

Nicht auf den Abschluss lang andauernder Vorgänge warten

--yes -y

Nicht zur Bestätigung auffordern

az apim list

Bearbeiten

Liste API Management Dienstinstanzen auf.

az apim list [--resource-group]

Optionale Parameter

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

az apim restore

Bearbeiten

Stellt eine Sicherung eines API Management Diensts, der mithilfe des ApiManagementService_Backup-Vorgangs des aktuellen Diensts erstellt wurde, wiederhergestellt. Dies ist ein lang ausgeführter Vorgang und kann mehrere Minuten dauern, bis der Vorgang abgeschlossen ist.

az apim restore --backup-name
                --container-name
                --name
                --resource-group
                --storage-account-key
                --storage-account-name
                [--no-wait]

Beispiele

Wiederherstellen einer Sicherung der API Management Dienstinstanz

az apim restore --name MyApim -g MyResourceGroup --backup-name myBackup              --storage-account-name mystorageaccount --storage-account-container backups              --storage-account-key Ay2ZbdxLnD4OJPT29F6jLPkB6KynOzx85YCObhrw==

Erforderliche Parameter

--backup-name

Der Name der Sicherungsdatei, die wiederhergestellt werden soll.

--container-name --storage-account-container

Der Name des Speicherkontocontainers, der zum Abrufen der Sicherung verwendet wird.

--name -n

Der Name der API-Verwaltungsdienstinstanz.

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

--storage-account-key

Der Zugriffsschlüssel des Speicherkontos, das zum Abrufen der Sicherung verwendet wird.

--storage-account-name

Der Name des Speicherkontos, das zum Abrufen der Sicherung verwendet wird.

Optionale Parameter

--no-wait

Nicht auf den Abschluss lang andauernder Vorgänge warten

az apim show

Bearbeiten

Details einer API Management Dienstinstanz anzeigen.

az apim show --name
             --resource-group

Erforderliche Parameter

--name -n

Der Name der API-Verwaltungsdienstinstanz.

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

az apim update

Bearbeiten

Aktualisieren einer API Management Dienstinstanz.

az apim update --name
               --resource-group
               [--add]
               [--enable-client-certificate {false, true}]
               [--enable-managed-identity {false, true}]
               [--force-string]
               [--no-wait]
               [--publisher-email]
               [--publisher-name]
               [--remove]
               [--set]
               [--sku-capacity]
               [--sku-name {Basic, Consumption, Developer, Isolated, Premium, Standard}]
               [--tags]
               [--virtual-network {External, Internal, None}]

Erforderliche Parameter

--name -n

Der Name der API-Verwaltungsdienstinstanz.

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

Optionale Parameter

--add

Fügen Sie einem Objekt eine Liste von Objekten hinzu, indem Sie ein Pfad- und Schlüsselwertpaar angeben. Beispiel: --add property.listProperty <key=value, string or JSON string>.

--enable-client-certificate

Erzwingt ein Clientzertifikat, das für jede Anforderung an das Gateway angezeigt werden soll und ermöglicht auch die Möglichkeit, das Zertifikat in der Richtlinie auf dem Gateway zu authentifizieren.

Zulässige Werte: false, true
--enable-managed-identity

Erstellen Sie eine verwaltete Identität für den API Management-Dienst, um auf andere Azure-Ressourcen zuzugreifen.

Zulässige Werte: false, true
--force-string

Wenn Sie "set" oder "add" verwenden, behalten Sie Zeichenfolgen literale beibehalten, anstatt zu versuchen, in JSON zu konvertieren.

--no-wait

Nicht auf den Abschluss lang andauernder Vorgänge warten

--publisher-email

Die E-Mail-Adresse, um alle Systembenachrichtigungen zu erhalten.

--publisher-name

Der Name Ihrer Organisation für die Verwendung im Entwicklerportal und E-Mail-Benachrichtigungen.

--remove

Entfernen Sie eine Eigenschaft oder ein Element aus einer Liste. Beispiel: --remove property.list OR --remove propertyToRemove.

--set

Aktualisieren Sie ein Objekt, indem Sie einen Eigenschaftenpfad und einen wert angeben, der festgelegt werden soll. Beispiel: --set-property1.property2=.

--sku-capacity

Die Anzahl der bereitgestellten Einheiten der SKU.

--sku-name

Die Sku der API-Verwaltungsinstanz.

Zulässige Werte: Basic, Consumption, Developer, Isolated, Premium, Standard
--tags

Leergetrennte Tags: key[=value] [key[=value] ...]. Verwenden Sie "", um vorhandene Tags zu löschen.

--virtual-network -v

Der virtuelle Netzwerktyp.

Zulässige Werte: External, Internal, None

az apim wait

Bearbeiten

Platzieren Sie die CLI in einem Wartenstatus, bis eine Bedingung eines APIm erfüllt ist.

az apim wait --name
             --resource-group
             [--created]
             [--custom]
             [--deleted]
             [--exists]
             [--interval]
             [--timeout]
             [--updated]

Beispiele

Platzieren Sie die CLI in einem Wartenstatus, bis eine Bedingung eines APIm erfüllt ist. (automatisch generiert)

az apim wait --created --name MyApim --resource-group MyResourceGroup

Erforderliche Parameter

--name -n

Der Name der API-Verwaltungsdienstinstanz.

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

Optionale Parameter

--created

Warten Sie, bis Sie mit "provisioningState" unter "Erfolgreich" erstellt wurden.

--custom

Warten Sie, bis die Bedingung eine benutzerdefinierte JMESPath-Abfrage erfüllt. Beispiel: provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Warten Sie, bis sie gelöscht wurde.

--exists

Warten Sie, bis die Ressource vorhanden ist.

--interval

Abfrageintervall in Sekunden.

Standardwert: 30
--timeout

Maximale Wartezeit in Sekunden.

Standardwert: 3600
--updated

Warten Sie, bis sie mit provisioningState unter "Erfolgreich" aktualisiert wurde.