az apim

Referenz

Verwalten von Azure-API-Verwaltungsdiensten.

Befehle

Name	Beschreibung	Typ	Status
az apim api	Verwalten sie die Azure API-Verwaltungs-API.	Core	Allgemein verfügbar
az apim api create	Erstellen Sie eine API-Verwaltungs-API.	Core	Allgemein verfügbar
az apim api delete	Löschen Sie eine API-Verwaltungs-API.	Core	Allgemein verfügbar
az apim api export	Exportieren sie eine API-Verwaltungs-API.	Core	Allgemein verfügbar
az apim api import	Importieren sie eine API-Verwaltungs-API.	Core	Allgemein verfügbar
az apim api list	Api-Verwaltungs-API auflisten.	Core	Allgemein verfügbar
az apim api operation	Verwalten von Azure-API-Verwaltungs-API-Vorgängen	Core	Allgemein verfügbar
az apim api operation create	Erstellt einen neuen Vorgang in der API.	Core	Allgemein verfügbar
az apim api operation delete	Löscht den angegebenen Vorgang aus der API	Core	Allgemein verfügbar
az apim api operation list	Listet eine Auflistung der Vorgänge für die angegebene API auf.	Core	Allgemein verfügbar
az apim api operation show	Ruft die Details des API-Vorgangs ab, der durch seinen Bezeichner angegeben wird.	Core	Allgemein verfügbar
az apim api operation update	Aktualisiert die Details des Vorgangs in der api, die durch den Bezeichner angegeben wird.	Core	Allgemein verfügbar
az apim api release	Verwalten sie die Azure API Management API Release.	Core	Allgemein verfügbar
az apim api release create	Erstellt ein neues Release für die API	Core	Allgemein verfügbar
az apim api release delete	Löscht die angegebene Version in der API.	Core	Allgemein verfügbar
az apim api release list	Listet alle Releases einer API auf.	Core	Allgemein verfügbar
az apim api release show	Gibt die Details einer API-Version zurück.	Core	Allgemein verfügbar
az apim api release update	Aktualisiert die Details der Veröffentlichung der API, die durch den Bezeichner angegeben wird.	Core	Allgemein verfügbar
az apim api revision	Verwalten sie die Revision der Azure API-Verwaltungs-API.	Core	Allgemein verfügbar
az apim api revision create	Api-Revision erstellen.	Core	Allgemein verfügbar
az apim api revision list	Listet alle Revisionen einer API auf	Core	Allgemein verfügbar
az apim api schema	Verwalten sie die Schemas der Azure API-Verwaltungs-API.	Core	Allgemein verfügbar
az apim api schema create	Erstellen Sie ein API-Verwaltungs-API-Schema.	Core	Allgemein verfügbar
az apim api schema delete	Löschen Eines API-Verwaltungs-API-Schemas.	Core	Allgemein verfügbar
az apim api schema get-etag	Abrufen eines Etags eines API-Verwaltungs-API-Schemas.	Core	Allgemein verfügbar
az apim api schema list	Api-Verwaltungs-API-Schemas auflisten.	Core	Allgemein verfügbar
az apim api schema show	Details eines API-Verwaltungs-API-Schemas anzeigen.	Core	Allgemein verfügbar
az apim api schema wait	Platzieren Sie die CLI in einem Wartezustand, bis eine Bedingung eines APIM-API-Schemas erfüllt ist.	Core	Allgemein verfügbar
az apim api show	Details einer API-Verwaltungs-API anzeigen.	Core	Allgemein verfügbar
az apim api update	Aktualisieren sie eine API-Verwaltungs-API.	Core	Allgemein verfügbar
az apim api versionset	Verwalten sie den Versionssatz der Azure API-Verwaltungs-API.	Core	Allgemein verfügbar
az apim api versionset create	Erstellt einen API-Versionssatz.	Core	Allgemein verfügbar
az apim api versionset delete	Löscht die angegebene API-Versionsgruppe	Core	Allgemein verfügbar
az apim api versionset list	Listet eine Auflistung von API-Versionsgruppen in der angegebenen Dienstinstanz auf	Core	Allgemein verfügbar
az apim api versionset show	Ruft die Details des api-Versionssatzes ab, der durch seinen Bezeichner angegeben ist.	Core	Allgemein verfügbar
az apim api versionset update	Aktualisiert die Details des durch den Bezeichner angegebenen API-Versionssets.	Core	Allgemein verfügbar
az apim api wait	Platzieren Sie die CLI in einem Wartezustand, bis eine Bedingung einer API erfüllt ist.	Core	Allgemein verfügbar
az apim apply-network-updates	Aktualisieren Sie die API-Verwaltungsressource, die im virtuellen Netzwerk ausgeführt wird, um die aktualisierten Netzwerkeinstellungen zu wählen.	Core	Allgemein verfügbar
az apim backup	Erstellt eine Sicherung des API-Verwaltungsdiensts für das angegebene Azure Storage-Konto. Dies ist ein lang ausgeführter Vorgang und kann mehrere Minuten dauern.	Core	Allgemein verfügbar
az apim check-name	Überprüft, ob ein Dienstname zur Verwendung verfügbar ist.	Core	Allgemein verfügbar
az apim create	Erstellen einer API Management-Dienstinstanz	Core	Allgemein verfügbar
az apim delete	Löscht einen API-Verwaltungsdienst.	Core	Allgemein verfügbar
az apim deletedservice	Verwalten sie vorläufig gelöschte Azure-API-Verwaltungsdienste.	Core	Allgemein verfügbar
az apim deletedservice list	Auflisten aller vorläufig gelöschten API-Verwaltungsdiensteinstanzen, die für das rückgängigmachen für das angegebene Abonnement verfügbar sind.	Core	Allgemein verfügbar
az apim deletedservice purge	Löschen sie vorläufig gelöschte API-Verwaltungsdienstinstanz (löscht sie ohne Option zum Rückgängigmachen).	Core	Allgemein verfügbar
az apim deletedservice show	Rufen Sie vorläufig gelöschte API-Verwaltungsdienstinstanzen ab, die für das Rückgängigmachen nach Namen verfügbar sind.	Core	Allgemein verfügbar
az apim graphql	Verwalten sie die GraphQL-API der Azure API Management.	Core	Allgemein verfügbar
az apim graphql resolver	Verwalten sie die Resolver der GraphQL-API für die Azure API-Verwaltung.	Core	Allgemein verfügbar
az apim graphql resolver create	Erstellen Sie einen neuen Resolver in der GraphQL-API, oder aktualisieren Sie eine vorhandene.	Core	Allgemein verfügbar
az apim graphql resolver delete	Löschen Sie den angegebenen Resolver in der GraphQL-API.	Core	Allgemein verfügbar
az apim graphql resolver list	Listet eine Auflistung der Resolver für die angegebene GraphQL-API auf.	Core	Allgemein verfügbar
az apim graphql resolver policy	Verwalten sie die Richtlinien der GraphQL-API zur Verwaltung von Azure API-Auflösungen.	Core	Allgemein verfügbar
az apim graphql resolver policy create	Erstellen oder Aktualisieren der Richtlinienkonfiguration für die GraphQL-API Resolver-Ebene.	Core	Allgemein verfügbar
az apim graphql resolver policy delete	Löschen Sie die Richtlinienkonfiguration im GraphQL-API-Resolver.	Core	Allgemein verfügbar
az apim graphql resolver policy list	Rufen Sie die Liste der Richtlinienkonfiguration auf der GraphQL-API-Resolver-Ebene ab.	Core	Allgemein verfügbar
az apim graphql resolver policy show	Rufen Sie die Richtlinienkonfiguration auf der GraphQL-API-Resolver-Ebene ab.	Core	Allgemein verfügbar
az apim graphql resolver show	Rufen Sie die Details der GraphQL-API Resolver ab, die durch ihren Bezeichner angegeben sind.	Core	Allgemein verfügbar
az apim list	Api-Verwaltungsdienstinstanzen auflisten.	Core	Allgemein verfügbar
az apim nv	Verwalten sie die benannten Werte der Azure-API-Verwaltung.	Core	Allgemein verfügbar
az apim nv create	Erstellen Sie einen benannten Wert für die API-Verwaltung.	Core	Allgemein verfügbar
az apim nv delete	Löschen sie einen benannten Wert für die API-Verwaltung.	Core	Allgemein verfügbar
az apim nv list	Listen-API-Verwaltung benannte Werte.	Core	Allgemein verfügbar
az apim nv show	Details einer API-Verwaltung mit benannten Werten anzeigen.	Core	Allgemein verfügbar
az apim nv show-secret	Ruft den geheimen Schlüssel einer API-Verwaltung benannten Wert ab.	Core	Allgemein verfügbar
az apim nv update	Aktualisieren sie eine API-Verwaltung mit dem Namen "Wert".	Core	Allgemein verfügbar
az apim nv wait	Platzieren Sie die CLI in einem Wartezustand, bis eine Bedingung eines apim benannten Werts erfüllt ist.	Core	Allgemein verfügbar
az apim product	Verwalten sie die Azure-API-Verwaltungsprodukts.	Core	Allgemein verfügbar
az apim product api	Verwalten sie die APIs des Azure API Management-Produkts.	Core	Allgemein verfügbar
az apim product api add	Fügen Sie dem angegebenen Produkt eine API hinzu.	Core	Allgemein verfügbar
az apim product api check	Überprüft, ob die durch den Bezeichner angegebene API-Entität der Produktentität zugeordnet ist.	Core	Allgemein verfügbar
az apim product api delete	Löscht die angegebene API aus dem angegebenen Produkt	Core	Allgemein verfügbar
az apim product api list	Listet eine Auflistung von APIs auf, die einem Produkt zugeordnet sind	Core	Allgemein verfügbar
az apim product create	Erstellt ein Produkt.	Core	Allgemein verfügbar
az apim product delete	Löscht das Produkt	Core	Allgemein verfügbar
az apim product list	Listet eine Auflistung der Produkte in der angegebenen Dienstinstanz auf	Core	Allgemein verfügbar
az apim product show	Ruft die Details des Produkts ab, das durch seinen Bezeichner angegeben ist.	Core	Allgemein verfügbar
az apim product update	Aktualisieren sie vorhandene Produktdetails.	Core	Allgemein verfügbar
az apim product wait	Platzieren Sie die CLI in einem Wartezustand, bis eine Bedingung eines APIM-Produkts erfüllt ist.	Core	Allgemein verfügbar
az apim restore	Stellt eine Sicherung eines API-Verwaltungsdiensts wieder her, der mithilfe des ApiManagementService_Backup Vorgangs für den aktuellen Dienst erstellt wurde. Dies ist ein lange ausgeführter Vorgang und kann mehrere Minuten dauern.	Core	Allgemein verfügbar
az apim show	Details einer API-Verwaltungsdienstinstanz anzeigen.	Core	Allgemein verfügbar
az apim update	Aktualisieren sie eine API-Verwaltungsdienstinstanz.	Core	Allgemein verfügbar
az apim wait	Platzieren Sie die CLI in einem Wartezustand, bis eine Bedingung eines APIM erfüllt ist.	Core	Allgemein verfügbar

az apim apply-network-updates

Bearbeiten

Aktualisieren Sie die API-Verwaltungsressource, die im virtuellen Netzwerk ausgeführt wird, um die aktualisierten Netzwerkeinstellungen zu wählen.

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

Beispiele

Aktualisieren der Einstellungen des virtuellen Netzwerks der API-Verwaltungsdienstinstanz

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

Position. 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

Standardwert: False

Globale Parameter

--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc

Standardwert: json

--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az apim backup

Bearbeiten

Erstellt eine Sicherung des API-Verwaltungsdiensts für das angegebene Azure Storage-Konto. Dies ist ein lang ausgeführter Vorgang und kann mehrere Minuten dauern.

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

Beispiele

Erstellen einer Sicherung der API-Verwaltungsdienstinstanz

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

Standardwert: False

Globale Parameter

--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc

Standardwert: json

--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az apim check-name

Bearbeiten

Überprüft, ob ein Dienstname zur Verwendung verfügbar ist.

az apim check-name --name

Erforderliche Parameter

--name -n

Der Name der API-Verwaltungsdienstinstanz.

Globale Parameter

--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc

Standardwert: json

--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az apim create

Bearbeiten

Erstellen einer API Management-Dienstinstanz

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

Beispiele

Erstellen Sie einen API-Verwaltungsdienst der Entwicklerebene.

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

Erstellen Sie einen Api-Verwaltungsdienst der Verbrauchsebene.

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.

Der Name muss global eindeutig sein, da er als Gatewayhostname wie " https://my-api-servicename.azure-api.netenthalten ist. Weitere Informationen finden Sie unter Beispiele.

--publisher-email

Die E-Mail-Adresse, die alle Systembenachrichtigungen empfängt.

--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

--disable-gateway

Deaktivieren Sie das Gateway in der Masterregion. Nur gültig für einen API-Verwaltungsdienst, der an mehreren Standorten bereitgestellt wird.

Zulässige Werte: false, true

--enable-client-certificate

Erzwingt ein Clientzertifikat, das für jede Anforderung an das Gateway angezeigt wird, und ermöglicht außerdem die Authentifizierung des Zertifikats in der Richtlinie auf dem Gateway.

Zulässige Werte: false, true

--enable-managed-identity

Erstellen Sie eine verwaltete Identität für den API-Verwaltungsdienst, um auf andere Azure-Ressourcen zuzugreifen. Dient nur zur Verwendung des SKU-Diensts für den Verbrauch.

Zulässige Werte: false, true

Standardwert: False

--location -l

Position. 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

Standardwert: False

--public-network-access

Gibt an, ob der Zugriff auf öffentliche Endpunkte für diesen API-Verwaltungsdienst zulässig ist. Bei Festlegung auf "true" sind private Endpunkte die exklusive Zugriffsmethode.

Zulässige Werte: false, true

--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

Durch Leerzeichen getrennte 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

Globale Parameter

--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc

Standardwert: json

--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az apim delete

Bearbeiten

Löscht einen API-Verwaltungsdienst.

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

Beispiele

Löschen Sie einen API-Verwaltungsdienst.

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

Standardwert: False

--yes -y

Nicht zur Bestätigung auffordern

Standardwert: False

Globale Parameter

--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc

Standardwert: json

--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az apim list

Bearbeiten

Api-Verwaltungsdienstinstanzen auflisten.

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.

Globale Parameter

--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc

Standardwert: json

--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az apim restore

Bearbeiten

Stellt eine Sicherung eines API-Verwaltungsdiensts wieder her, der mithilfe des ApiManagementService_Backup Vorgangs für den aktuellen Dienst erstellt wurde. Dies ist ein lange ausgeführter Vorgang und kann mehrere Minuten dauern.

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

Beispiele

Stellt eine Sicherung der API-Verwaltungsdienstinstanz wieder her

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 wiederherzustellenden Sicherungsdatei.

--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, aus dem die Sicherung abgerufen wird.

--storage-account-name

Der Name des Speicherkontos, aus dem die Sicherung abgerufen wird.

Optionale Parameter

--no-wait

Nicht auf den Abschluss lang andauernder Vorgänge warten

Standardwert: False

Globale Parameter

--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc

Standardwert: json

--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az apim show

Bearbeiten

Details einer API-Verwaltungsdienstinstanz 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.

Globale Parameter

--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc

Standardwert: json

--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az apim update

Bearbeiten

Aktualisieren sie eine API-Verwaltungsdienstinstanz.

az apim update --name
               --resource-group
               [--add]
               [--disable-gateway {false, true}]
               [--enable-client-certificate {false, true}]
               [--enable-managed-identity {false, true}]
               [--force-string]
               [--no-wait]
               [--public-network-access {false, true}]
               [--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 einer Liste von Objekten ein Objekt hinzu, indem Sie ein Pfad- und Schlüsselwertpaar angeben. Beispiel: --add property.listProperty <key=value, string or JSON string>.

Standardwert: []

--disable-gateway

Deaktivieren Sie das Gateway in der Masterregion. Nur gültig für einen API-Verwaltungsdienst, der an mehreren Standorten bereitgestellt wird.

Zulässige Werte: false, true

--enable-client-certificate

Erzwingt ein Clientzertifikat, das für jede Anforderung an das Gateway angezeigt wird, und ermöglicht außerdem die Authentifizierung des Zertifikats in der Richtlinie auf dem Gateway.

Zulässige Werte: false, true

--enable-managed-identity

Erstellen Sie eine verwaltete Identität für den API-Verwaltungsdienst, um auf andere Azure-Ressourcen zuzugreifen. Dient nur zur Verwendung des SKU-Diensts für den Verbrauch.

Zulässige Werte: false, true

--force-string

Wenn Sie "set" oder "add" verwenden, behalten Sie Zeichenfolgenliterale bei, anstatt zu versuchen, in JSON zu konvertieren.

Standardwert: False

--no-wait

Nicht auf den Abschluss lang andauernder Vorgänge warten

Standardwert: False

--public-network-access

Gibt an, ob der Zugriff auf öffentliche Endpunkte für diesen API-Verwaltungsdienst zulässig ist. Bei Festlegung auf "true" sind private Endpunkte die exklusive Zugriffsmethode.

Zulässige Werte: false, true

--publisher-email

Die E-Mail-Adresse, die alle Systembenachrichtigungen empfängt.

--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 <indexToRemove> ODER --remove propertyToRemove.

Standardwert: []

--set

Aktualisieren Sie ein Objekt, indem Sie einen festzulegenden Eigenschaftspfad und -wert angeben. Beispiel: --set property1.property2=<value>.

Standardwert: []

--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

Durch Leerzeichen getrennte 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

Globale Parameter

--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc

Standardwert: json

--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az apim wait

Bearbeiten

Platzieren Sie die CLI in einem Wartezustand, 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 Wartezustand, 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 'Succeeded' erstellt wurde.

Standardwert: False

--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.

Standardwert: False

--exists

Warten Sie, bis die Ressource vorhanden ist.

Standardwert: False

--interval

Abrufintervall in Sekunden.

Standardwert: 30

--timeout

Maximale Wartezeit in Sekunden.

Standardwert: 3600

--updated

Warten Sie, bis sie mit provisioningState unter 'Succeeded' aktualisiert wurde.

Standardwert: False

Globale Parameter

--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc

Standardwert: json

--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

Freigeben über

az apim

Befehle

az apim apply-network-updates

Beispiele

Erforderliche Parameter

Optionale Parameter

az apim backup

Beispiele

Erforderliche Parameter

Optionale Parameter

az apim check-name

Erforderliche Parameter

az apim create

Beispiele

Erforderliche Parameter

Optionale Parameter

az apim delete

Beispiele

Erforderliche Parameter

Optionale Parameter

az apim list

Optionale Parameter

az apim restore

Beispiele

Erforderliche Parameter

Optionale Parameter

az apim show

Erforderliche Parameter

az apim update

Erforderliche Parameter

Optionale Parameter

az apim wait

Beispiele

Erforderliche Parameter

Optionale Parameter

Zusätzliche Ressourcen