Freigeben über

az apim api

  • Referenz

Verwalten sie die Azure API-Verwaltungs-API.

Befehle

Name Beschreibung Typ Status
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 api create

Bearbeiten

Erstellen Sie eine API-Verwaltungs-API.

az apim api create --api-id
                   --display-name
                   --path
                   --resource-group
                   --service-name
                   [--api-type {graphql, http, soap, websocket}]
                   [--authorization-scope]
                   [--authorization-server-id]
                   [--bearer-token-sending-methods]
                   [--description]
                   [--no-wait]
                   [--open-id-provider-id]
                   [--protocols {http, https, ws, wss}]
                   [--service-url]
                   [--subscription-key-header-name]
                   [--subscription-key-query-param-name]
                   [--subscription-key-required]
                   [--subscription-required {false, true}]

Beispiele

Erstellen Sie eine einfache API.

az apim api create --service-name MyApim -g MyResourceGroup --api-id MyApi --path '/myapi' --display-name 'My API'

Erforderliche Parameter

--api-id

Eindeutiger Name der zu erstellenden API.

API-Revisionsbezeichner. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein. Die nicht aktuelle Überarbeitung hat ; rev=n als Suffix, wobei n die Revisionsnummer ist.

--display-name

Anzeigename der zu erstellenden API.

--path

Pfad zur API.

--resource-group -g

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

--service-name -n

Der Name der API-Verwaltungsdienstinstanz.

Optionale Parameter

--api-type

Der Typ der API.

Zulässige Werte: graphql, http, soap, websocket
--authorization-scope

Gibt den OAuth-Operationsbereich an.

--authorization-server-id

Gibt die OAuth-Autorisierungsserver-ID an.

--bearer-token-sending-methods

Gibt die Sendemethoden für Bearertoken an.

--description

Beschreibung der API. Kann HTML-Formatierungstags umfassen.

--no-wait

Nicht auf den Abschluss lang andauernder Vorgänge warten

Standardwert: False
--open-id-provider-id

Gibt die OpenID in der Authentifizierungseinstellung an.

--protocols

Beschreibt, über welche Protokolle die Vorgänge in dieser API aufgerufen werden können.

Zulässige Werte: http, https, ws, wss
--service-url

Absolute URL des Back-End-Diensts, der diese API implementiert. Maximal 2000 Zeichen lang.

--subscription-key-header-name

Gibt den Kopfzeilennamen des Abonnementschlüssels an.

--subscription-key-query-param-name

Gibt den Namen des Abfragezeichenfolgenparameters des Abonnementschlüssels an.

--subscription-key-required

Gibt an, ob der Abonnementschlüssel während des Aufrufs dieser API erforderlich ist, true – API ist nur in geschlossene Produkte enthalten, false - API ist allein in geöffneten Produkten enthalten, NULL - es gibt eine Mischung aus Produkten.

--subscription-required

Bei "true" erfordert die API einen Abonnementschlüssel für Anforderungen.

Zulässige Werte: false, true
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 api delete

Bearbeiten

Löschen Sie eine API-Verwaltungs-API.

az apim api delete --api-id
                   --resource-group
                   --service-name
                   [--delete-revisions]
                   [--if-match]
                   [--no-wait]
                   [--yes]

Erforderliche Parameter

--api-id

API-ID. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein. Die nicht aktuelle Überarbeitung hat ; rev=n als Suffix, wobei n die Revisionsnummer ist.

--resource-group -g

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

--service-name -n

Der Name der API-Verwaltungsdienstinstanz.

Optionale Parameter

--delete-revisions

Löschen Sie alle Überarbeitungen der API.

--if-match

ETag der Entität.

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

Bearbeiten

Exportieren sie eine API-Verwaltungs-API.

az apim api export --api-id
                   --ef {OpenApiJsonFile, OpenApiJsonUrl, OpenApiYamlFile, OpenApiYamlUrl, SwaggerFile, SwaggerUrl, WadlFile, WadlUrl, WsdlFile, WsdlUrl}
                   --resource-group
                   --service-name
                   [--file-path]

Beispiele

Exportieren Sie eine API-Verwaltungs-API in eine Datei oder gibt eine Antwort zurück, die einen Link zum Export enthält.

az apim api export -g MyResourceGroup --service-name MyApim --api-id MyApi --export-format OpenApiJson --file-path path

Erforderliche Parameter

--api-id

API-ID. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein. Die nicht aktuelle Überarbeitung hat ; rev=n als Suffix, wobei n die Revisionsnummer ist. Regex-Muster: ^[^*#&+:<>?] +$.

--ef --export-format

Geben Sie das Format der exportierenden API an.

Zulässige Werte: OpenApiJsonFile, OpenApiJsonUrl, OpenApiYamlFile, OpenApiYamlUrl, SwaggerFile, SwaggerUrl, WadlFile, WadlUrl, WsdlFile, WsdlUrl
--resource-group -g

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

--service-name -n

Der Name der API-Verwaltungsdienstinstanz.

Optionale Parameter

--file-path -f

Der zum Exportieren der API angegebene Dateipfad.

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

Bearbeiten

Importieren sie eine API-Verwaltungs-API.

az apim api import --path
                   --resource-group
                   --service-name
                   --specification-format {GraphQL, OpenApi, OpenApiJson, Swagger, Wadl, Wsdl}
                   [--api-id]
                   [--api-revision]
                   [--api-type {graphql, http, soap, websocket}]
                   [--api-version]
                   [--api-version-set-id]
                   [--description]
                   [--display-name]
                   [--no-wait]
                   [--protocols {http, https, ws, wss}]
                   [--service-url]
                   [--soap-api-type]
                   [--specification-path]
                   [--specification-url]
                   [--subscription-key-header-name]
                   [--subscription-key-query-param-name]
                   [--subscription-required {false, true}]
                   [--wsdl-endpoint-name]
                   [--wsdl-service-name]

Beispiele

Importieren einer API-Verwaltungs-API aus einer Datei oder einer URL

az apim api import -g MyResourceGroup --service-name MyApim --path MyApi --specification-url https://MySpecificationURL --specification-format OpenApiJson

Erforderliche Parameter

--path

Erforderlich. Relative URL, die diese API und all ihre Ressourcenpfade in der Instanz des API Management-Diensts eindeutig identifiziert.

--resource-group -g

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

--service-name -n

Der Name der API-Verwaltungsdienstinstanz.

--specification-format

Geben Sie das Format der importierten API an.

Zulässige Werte: GraphQL, OpenApi, OpenApiJson, Swagger, Wadl, Wsdl

Optionale Parameter

--api-id

API-ID. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein. Die nicht aktuelle Überarbeitung hat ; rev=n als Suffix, wobei n die Revisionsnummer ist.

--api-revision

Beschreibt die Überarbeitung der API. Wenn kein Wert angegeben wird, wird die Standardrevision 1 erstellt.

--api-type

Der Typ der API.

Zulässige Werte: graphql, http, soap, websocket
--api-version

Beschreibt die Version der API. Wenn Sie einer nicht versionsgesteuerten API eine Version hinzufügen, wird automatisch eine Originalversion erstellt und reagiert auf die Standard-URL.

--api-version-set-id

Beschreibt den Versionssatz, der mit der API verwendet werden soll.

--description

Beschreibung der API. Kann HTML-Formatierungstags umfassen.

--display-name

Anzeigename dieser API.

--no-wait

Nicht auf den Abschluss lang andauernder Vorgänge warten

Standardwert: False
--protocols

Beschreibt, welche Protokolle(ein oder mehrere) Vorgänge in dieser API aufgerufen werden können.

Zulässige Werte: http, https, ws, wss
--service-url

Absolute URL des Back-End-Diensts, der diese API implementiert. Maximal 2000 Zeichen lang.

--soap-api-type

Der Typ der API, wenn das Dateiformat WSDL ist.

--specification-path

Der zum Importieren der API angegebene Dateipfad.

--specification-url

Url angegeben, um die API zu importieren.

--subscription-key-header-name

Gibt den Kopfzeilennamen des Abonnementschlüssels an.

--subscription-key-query-param-name

Gibt den Namen des Abfragezeichenfolgenparameters des Abonnementschlüssels an.

--subscription-required

Bei "true" erfordert die API einen Abonnementschlüssel für Anforderungen.

Zulässige Werte: false, true
--wsdl-endpoint-name

Lokaler Name des zu importierenden WSDL-Endpunkts (Port).

--wsdl-service-name

Lokaler Name des zu importierenden WSDL-Diensts.

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

Bearbeiten

Api-Verwaltungs-API auflisten.

az apim api list --resource-group
                 --service-name
                 [--filter-display-name]
                 [--skip]
                 [--top]

Erforderliche Parameter

--resource-group -g

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

--service-name -n

Der Name der API-Verwaltungsdienstinstanz.

Optionale Parameter

--filter-display-name

Filter von APIs nach displayName.

--skip

Anzahl der zu überspringenden Datensätze.

--top

Die Anzahl der zurückzugebenden Datensätze.

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

Bearbeiten

Details einer API-Verwaltungs-API anzeigen.

az apim api show --api-id
                 --resource-group
                 --service-name

Erforderliche Parameter

--api-id

API-ID. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein. Die nicht aktuelle Überarbeitung hat ; rev=n als Suffix, wobei n die Revisionsnummer ist.

--resource-group -g

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

--service-name

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

Bearbeiten

Aktualisieren sie eine API-Verwaltungs-API.

az apim api update --api-id
                   --resource-group
                   --service-name
                   [--add]
                   [--api-type {graphql, http, soap, websocket}]
                   [--description]
                   [--display-name]
                   [--force-string]
                   [--if-match]
                   [--no-wait]
                   [--path]
                   [--protocols {http, https, ws, wss}]
                   [--remove]
                   [--service-url]
                   [--set]
                   [--subscription-key-header-name]
                   [--subscription-key-query-param-name]
                   [--subscription-required {false, true}]
                   [--tags]

Beispiele

Erstellen Sie eine einfache API.

az apim api update --service-name MyApim -g MyResourceGroup --api-id MyApi --description foo

Erforderliche Parameter

--api-id

Eindeutiger Name der zu erstellenden API.

API-Revisionsbezeichner. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein. Die nicht aktuelle Überarbeitung hat ; rev=n als Suffix, wobei n die Revisionsnummer ist.

--resource-group -g

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

--service-name -n

Der Name der API-Verwaltungsdienstinstanz.

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: []
--api-type

Der Typ der API.

Zulässige Werte: graphql, http, soap, websocket
--description

Beschreibung der API. Kann HTML-Formatierungstags umfassen.

--display-name

API-Name. Muss 1 bis 300 Zeichen lang sein.

--force-string

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

Standardwert: False
--if-match

ETag der Entität. Beim Erstellen einer Entität nicht erforderlich, aber beim Aktualisieren einer Entität erforderlich. Der Standardwert ist None.

--no-wait

Nicht auf den Abschluss lang andauernder Vorgänge warten

Standardwert: False
--path

Erforderlich. Relative URL, die diese API und all ihre Ressourcenpfade in der Instanz des API Management-Diensts eindeutig identifiziert.

--protocols

Beschreibt, über welche Protokolle die Vorgänge in dieser API aufgerufen werden können.

Zulässige Werte: http, https, ws, wss
--remove

Entfernen sie eine Eigenschaft oder ein Element aus einer Liste. Beispiel: --remove property.list <indexToRemove> ODER --remove propertyToRemove.

Standardwert: []
--service-url

Absolute URL des Back-End-Diensts, der diese API implementiert. Maximal 2000 Zeichen lang.

--set

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

Standardwert: []
--subscription-key-header-name

Gibt den Kopfzeilennamen des Abonnementschlüssels an.

--subscription-key-query-param-name

Gibt den Namen des Abfragezeichenfolgenparameters des Abonnementschlüssels an.

--subscription-required

Bei "true" erfordert die API einen Abonnementschlüssel für Anforderungen.

Zulässige Werte: false, true
--tags

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

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

Bearbeiten

Platzieren Sie die CLI in einem Wartezustand, bis eine Bedingung einer API erfüllt ist.

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

Beispiele

Platzieren Sie die CLI in einem Wartezustand, bis eine Bedingung einer API erfüllt ist. (automatisch generiert)

az apim api wait --created --api-id MyApi --name MyApim --resource-group MyResourceGroup

Erforderliche Parameter

--api-id

API-Revisionsbezeichner. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein. Die nicht aktuelle Überarbeitung hat ; rev=n als Suffix, wobei n die Revisionsnummer ist. Erforderlich.

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