az apim

Verwalten von Azure-API-Verwaltungsdiensten.

Befehle

Name	Beschreibung	Typ	Status
az apim api	Verwalten sie die Azure API-Verwaltungs-API.	Core	GA
az apim api create	Erstellen Sie eine API-Verwaltungs-API.	Core	GA
az apim api delete	Löschen Sie eine API-Verwaltungs-API.	Core	GA
az apim api export	Exportieren sie eine API-Verwaltungs-API.	Core	GA
az apim api import	Importieren sie eine API-Verwaltungs-API.	Core	GA
az apim api list	Api-Verwaltungs-API auflisten.	Core	GA
az apim api operation	Verwalten von Azure-API-Verwaltungs-API-Vorgängen	Core	GA
az apim api operation create	Erstellt einen neuen Vorgang in der API.	Core	GA
az apim api operation delete	Löscht den angegebenen Vorgang in der API.	Core	GA
az apim api operation list	Listet eine Auflistung der Vorgänge für die angegebene API auf.	Core	GA
az apim api operation show	Ruft die Details des API-Vorgangs ab, der durch seinen Bezeichner angegeben wird.	Core	GA
az apim api operation update	Aktualisiert die Details des Vorgangs in der api, die durch den Bezeichner angegeben wird.	Core	GA
az apim api release	Verwalten sie die Azure API Management API Release.	Core	GA
az apim api release create	Erstellt eine neue Version für die API.	Core	GA
az apim api release delete	Löscht die angegebene Version in der API.	Core	GA
az apim api release list	Listet alle Versionen einer API auf.	Core	GA
az apim api release show	Gibt die Details einer API-Version zurück.	Core	GA
az apim api release update	Aktualisiert die Details der Veröffentlichung der API, die durch den Bezeichner angegeben wird.	Core	GA
az apim api revision	Verwalten sie die Revision der Azure API-Verwaltungs-API.	Core	GA
az apim api revision create	Api-Revision erstellen.	Core	GA
az apim api revision list	Listet alle Überarbeitungen einer API auf.	Core	GA
az apim api schema	Verwalten sie die Schemas der Azure API-Verwaltungs-API.	Core	GA
az apim api schema create	Erstellen Sie ein API-Verwaltungs-API-Schema.	Core	GA
az apim api schema delete	Löschen Eines API-Verwaltungs-API-Schemas.	Core	GA
az apim api schema get-etag	Abrufen eines Etags eines API-Verwaltungs-API-Schemas.	Core	GA
az apim api schema list	Api-Verwaltungs-API-Schemas auflisten.	Core	GA
az apim api schema show	Details eines API-Verwaltungs-API-Schemas anzeigen.	Core	GA
az apim api schema wait	Platzieren Sie die CLI in einem Wartezustand, bis eine Bedingung eines APIM-API-Schemas erfüllt ist.	Core	GA
az apim api show	Details einer API-Verwaltungs-API anzeigen.	Core	GA
az apim api update	Aktualisieren sie eine API-Verwaltungs-API.	Core	GA
az apim api versionset	Verwalten sie den Versionssatz der Azure API-Verwaltungs-API.	Core	GA
az apim api versionset create	Erstellt einen API-Versionssatz.	Core	GA
az apim api versionset delete	Löscht bestimmte API-Versionssatz.	Core	GA
az apim api versionset list	Listet eine Auflistung von API-Versionssätzen in der angegebenen Dienstinstanz auf.	Core	GA
az apim api versionset show	Ruft die Details des api-Versionssatzes ab, der durch seinen Bezeichner angegeben ist.	Core	GA
az apim api versionset update	Aktualisiert die Details des durch den Bezeichner angegebenen API-Versionssets.	Core	GA
az apim api wait	Platzieren Sie die CLI in einem Wartezustand, bis eine Bedingung einer API erfüllt ist.	Core	GA
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	GA
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	GA
az apim check-name	Überprüft, ob ein Dienstname zur Verwendung verfügbar ist.	Core	GA
az apim create	Erstellen Sie eine API-Verwaltungsdienstinstanz.	Core	GA
az apim delete	Löscht einen API-Verwaltungsdienst.	Core	GA
az apim deletedservice	Verwalten sie vorläufig gelöschte Azure-API-Verwaltungsdienste.	Core	GA
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	GA
az apim deletedservice purge	Löschen sie vorläufig gelöschte API-Verwaltungsdienstinstanz (löscht sie ohne Option zum Rückgängigmachen).	Core	GA
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	GA
az apim graphql	Verwalten sie die GraphQL-API der Azure API Management.	Core	GA
az apim graphql resolver	Verwalten sie die Resolver der GraphQL-API für die Azure API-Verwaltung.	Core	GA
az apim graphql resolver create	Erstellen Sie einen neuen Resolver in der GraphQL-API, oder aktualisieren Sie eine vorhandene.	Core	GA
az apim graphql resolver delete	Löschen Sie den angegebenen Resolver in der GraphQL-API.	Core	GA
az apim graphql resolver list	Listet eine Auflistung der Resolver für die angegebene GraphQL-API auf.	Core	GA
az apim graphql resolver policy	Verwalten sie die Richtlinien der GraphQL-API zur Verwaltung von Azure API-Auflösungen.	Core	GA
az apim graphql resolver policy create	Erstellen oder Aktualisieren der Richtlinienkonfiguration für die GraphQL-API Resolver-Ebene.	Core	GA
az apim graphql resolver policy delete	Löschen Sie die Richtlinienkonfiguration im GraphQL-API-Resolver.	Core	GA
az apim graphql resolver policy list	Rufen Sie die Liste der Richtlinienkonfiguration auf der GraphQL-API-Resolver-Ebene ab.	Core	GA
az apim graphql resolver policy show	Rufen Sie die Richtlinienkonfiguration auf der GraphQL-API-Resolver-Ebene ab.	Core	GA
az apim graphql resolver show	Rufen Sie die Details der GraphQL-API Resolver ab, die durch ihren Bezeichner angegeben sind.	Core	GA
az apim list	Api-Verwaltungsdienstinstanzen auflisten.	Core	GA
az apim nv	Verwalten sie die benannten Werte der Azure-API-Verwaltung.	Core	GA
az apim nv create	Erstellen Sie einen benannten Wert für die API-Verwaltung.	Core	GA
az apim nv delete	Löschen sie einen benannten Wert für die API-Verwaltung.	Core	GA
az apim nv list	Listen-API-Verwaltung benannte Werte.	Core	GA
az apim nv show	Details einer API-Verwaltung mit benannten Werten anzeigen.	Core	GA
az apim nv show-secret	Ruft den geheimen Schlüssel einer API-Verwaltung benannten Wert ab.	Core	GA
az apim nv update	Aktualisieren sie eine API-Verwaltung mit dem Namen "Wert".	Core	GA
az apim nv wait	Platzieren Sie die CLI in einem Wartezustand, bis eine Bedingung eines apim benannten Werts erfüllt ist.	Core	GA
az apim product	Verwalten sie die Azure-API-Verwaltungsprodukts.	Core	GA
az apim product api	Verwalten sie die APIs des Azure API Management-Produkts.	Core	GA
az apim product api add	Fügen Sie dem angegebenen Produkt eine API hinzu.	Core	GA
az apim product api check	Überprüft, ob die durch den Bezeichner angegebene API-Entität der Produktentität zugeordnet ist.	Core	GA
az apim product api delete	Löscht die angegebene API aus dem angegebenen Produkt.	Core	GA
az apim product api list	Listet eine Auflistung der APIs auf, die einem Produkt zugeordnet sind.	Core	GA
az apim product create	Erstellt ein Produkt.	Core	GA
az apim product delete	Delete product.	Core	GA
az apim product list	Listet eine Auflistung von Produkten in der angegebenen Dienstinstanz auf.	Core	GA
az apim product show	Ruft die Details des Produkts ab, das durch seinen Bezeichner angegeben ist.	Core	GA
az apim product update	Aktualisieren sie vorhandene Produktdetails.	Core	GA
az apim product wait	Platzieren Sie die CLI in einem Wartezustand, bis eine Bedingung eines APIM-Produkts erfüllt ist.	Core	GA
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	GA
az apim show	Details einer API-Verwaltungsdienstinstanz anzeigen.	Core	GA
az apim update	Aktualisieren sie eine API-Verwaltungsdienstinstanz.	Core	GA
az apim wait	Platzieren Sie die CLI in einem Wartezustand, bis eine Bedingung eines APIM erfüllt ist.	Core	GA

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--location -l

Location. Werte aus: az account list-locations. Sie können den Standardspeicherort mithilfe von az configure --defaults location=<location>konfigurieren.

--no-wait

Warten Sie nicht, bis der lange ausgeführte Vorgang abgeschlossen ist.

Eigenschaft	Wert
Standardwert:	False

Globale Parameter

--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft	Wert
Standardwert:	False

--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft	Wert
Standardwert:	False

--output -o

Output format.

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

--query

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

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft	Wert
Standardwert:	False

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 --storage-account-container
               --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.

Eigenschaft	Wert
Parameter group:	Storage Arguments

--storage-account-name

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

Eigenschaft	Wert
Parameter group:	Storage Arguments

Optionale Parameter

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--no-wait

Warten Sie nicht, bis der lange ausgeführte Vorgang abgeschlossen ist.

Eigenschaft	Wert
Standardwert:	False

Globale Parameter

--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft	Wert
Standardwert:	False

--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft	Wert
Standardwert:	False

--output -o

Output format.

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

--query

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

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft	Wert
Standardwert:	False

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

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft	Wert
Standardwert:	False

--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft	Wert
Standardwert:	False

--output -o

Output format.

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

--query

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

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft	Wert
Standardwert:	False

az apim create

Bearbeiten

Erstellen Sie eine API-Verwaltungsdienstinstanz.

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.net"eingeschlossen wird. See examples.

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--disable-gateway

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

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

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

Eigenschaft	Wert
Standardwert:	False
Zulässige Werte:	false, true

--location -l

Location. Werte aus: az account list-locations. Sie können den Standardspeicherort mithilfe von az configure --defaults location=<location>konfigurieren.

--no-wait

Warten Sie nicht, bis der lange ausgeführte Vorgang abgeschlossen ist.

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

Eigenschaft	Wert
Zulässige Werte:	false, true

--sku-capacity

Die Anzahl der bereitgestellten Einheiten der SKU.

Eigenschaft	Wert
Standardwert:	1

--sku-name

Die Sku der API-Verwaltungsinstanz.

Eigenschaft	Wert
Standardwert:	Developer
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.

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

Globale Parameter

--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft	Wert
Standardwert:	False

--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft	Wert
Standardwert:	False

--output -o

Output format.

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

--query

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

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft	Wert
Standardwert:	False

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--no-wait

Warten Sie nicht, bis der lange ausgeführte Vorgang abgeschlossen ist.

Eigenschaft	Wert
Standardwert:	False

--yes -y

Zur Bestätigung nicht auffordern.

Eigenschaft	Wert
Standardwert:	False

Globale Parameter

--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft	Wert
Standardwert:	False

--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft	Wert
Standardwert:	False

--output -o

Output format.

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

--query

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

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft	Wert
Standardwert:	False

az apim list

Bearbeiten

Api-Verwaltungsdienstinstanzen auflisten.

az apim list [--resource-group]

Optionale Parameter

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--resource-group -g

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

Globale Parameter

--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft	Wert
Standardwert:	False

--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft	Wert
Standardwert:	False

--output -o

Output format.

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

--query

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

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft	Wert
Standardwert:	False

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 --storage-account-container
                --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.

Eigenschaft	Wert
Parameter group:	Storage Arguments

--storage-account-name

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

Eigenschaft	Wert
Parameter group:	Storage Arguments

Optionale Parameter

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--no-wait

Warten Sie nicht, bis der lange ausgeführte Vorgang abgeschlossen ist.

Eigenschaft	Wert
Standardwert:	False

Globale Parameter

--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft	Wert
Standardwert:	False

--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft	Wert
Standardwert:	False

--output -o

Output format.

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

--query

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

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft	Wert
Standardwert:	False

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

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft	Wert
Standardwert:	False

--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft	Wert
Standardwert:	False

--output -o

Output format.

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

--query

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

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft	Wert
Standardwert:	False

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Eigenschaft	Wert
Parameter group:	Generic Update Arguments
Standardwert:	[]

--disable-gateway

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

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

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

Eigenschaft	Wert
Zulässige Werte:	false, true

--force-string

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

Eigenschaft	Wert
Parameter group:	Generic Update Arguments
Standardwert:	False

--no-wait

Warten Sie nicht, bis der lange ausgeführte Vorgang abgeschlossen ist.

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

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

Eigenschaft	Wert
Parameter group:	Generic Update Arguments
Standardwert:	[]

--set

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

Eigenschaft	Wert
Parameter group:	Generic Update Arguments
Standardwert:	[]

--sku-capacity

Die Anzahl der bereitgestellten Einheiten der SKU.

--sku-name

Die Sku der API-Verwaltungsinstanz.

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

Eigenschaft	Wert
Zulässige Werte:	External, Internal, None

Globale Parameter

--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft	Wert
Standardwert:	False

--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft	Wert
Standardwert:	False

--output -o

Output format.

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

--query

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

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft	Wert
Standardwert:	False

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. (autogenerated)

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--created

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

Eigenschaft	Wert
Parameter group:	Wait Condition Arguments
Standardwert:	False

--custom

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

Eigenschaft	Wert
Parameter group:	Wait Condition Arguments

--deleted

Warten Sie, bis sie gelöscht wurde.

Eigenschaft	Wert
Parameter group:	Wait Condition Arguments
Standardwert:	False

--exists

Warten Sie, bis die Ressource vorhanden ist.

Eigenschaft	Wert
Parameter group:	Wait Condition Arguments
Standardwert:	False

--interval

Abrufintervall in Sekunden.

Eigenschaft	Wert
Parameter group:	Wait Condition Arguments
Standardwert:	30

--timeout

Maximale Wartezeit in Sekunden.

Eigenschaft	Wert
Parameter group:	Wait Condition Arguments
Standardwert:	3600

--updated

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

Eigenschaft	Wert
Parameter group:	Wait Condition Arguments
Standardwert:	False

Globale Parameter

--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft	Wert
Standardwert:	False

--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft	Wert
Standardwert:	False

--output -o

Output format.

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

--query

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

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft	Wert
Standardwert:	False

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

Feedback