az apim api

Referenz

Verwalten sie azure API Management API's.

Befehle

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

Bearbeiten

Erstellen Sie eine API Management 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 grundlegende 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.

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

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

--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. Es kann nicht mehr als 2000 Zeichen lang sein.

--subscription-key-header-name

Gibt den Namen des Abonnementschlüssels an.

--subscription-key-query-param-name

Gibt den Parameternamen 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

Wenn true, erfordert die API einen Abonnementschlüssel für Anforderungen.

Zulässige Werte: false, true

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.

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

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

Erforderliche Parameter

--api-id

API-Bezeichner. Muss in der aktuellen API Management Dienstinstanz 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 Management Dienstinstanz.

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

--yes -y

Nicht zur Bestätigung auffordern

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.

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

az apim api import --path
                   --resource-group
                   --service-name
                   --specification-format {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 Management-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: OpenApi, OpenApiJson, Swagger, Wadl, Wsdl

Optionale Parameter

--api-id

API-Bezeichner. Muss in der aktuellen API Management Dienstinstanz 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 bereitgestellt wird, wird standardmäßige Revision 1 erstellt.

--api-type

Der Typ der API.

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

--api-version

Beschreibt die Version der API. Wenn Sie eine Version zu einer nicht versionierten API hinzufügen, wird eine Originalversion automatisch 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

--protocols

Beschreibt, auf welchen Protokollen(ein oder mehrere) 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. Es kann nicht mehr als 2000 Zeichen lang sein.

--soap-api-type

Der Typ der API, wenn das Dateiformat WSDL ist.

--specification-path

Dateipfad, der zum Importieren der API angegeben ist.

--specification-url

Url angegeben, um die API zu importieren.

--subscription-key-header-name

Gibt den Namen des Abonnementschlüssels an.

--subscription-key-query-param-name

Gibt den Parameternamen des Abonnementschlüssels an.

--subscription-required

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

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

Liste API Management API's auf.

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

Optionale Parameter

--filter-display-name

Filter von APIs nach displayName.

--skip

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

--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 Management-API anzeigen.

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

Erforderliche Parameter

--api-id

API-Bezeichner. Muss in der aktuellen API Management Dienstinstanz 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 Management Dienstinstanz.

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.

--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 einer API Management-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 grundlegende 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.

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

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

--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 Zeichenfolgen literale beibehalten, anstatt zu versuchen, in JSON zu konvertieren.

--if-match

ETag der Entität. Beim Erstellen einer Entität nicht erforderlich, aber beim Aktualisieren einer Entität erforderlich.

--no-wait

Nicht auf den Abschluss lang andauernder Vorgänge warten

--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 OR --remove propertyToRemove.

--service-url

Absolute URL des Back-End-Diensts, der diese API implementiert. Es kann nicht mehr als 2000 Zeichen lang sein.

--set

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

--subscription-key-header-name

Gibt den Namen des Abonnementschlüssels an.

--subscription-key-query-param-name

Gibt den Parameternamen des Abonnementschlüssels an.

--subscription-required

Wenn true, erfordert die API einen Abonnementschlüssel für Anforderungen.

Zulässige Werte: false, true

--tags

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

--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 Wartenstatus, 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 Wartenstatus, bis eine Bedingung einer APIm-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 Management Dienstinstanz eindeutig sein. Die nicht aktuelle Überarbeitung hat ;rev=n als Suffix, wobei n die Revisionsnummer ist.

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

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.

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

Befehle

az apim api create

Beispiele

Erforderliche Parameter

Optionale Parameter

az apim api delete

Erforderliche Parameter

Optionale Parameter

az apim api import

Beispiele

Erforderliche Parameter

Optionale Parameter

az apim api list

Erforderliche Parameter

Optionale Parameter

az apim api show

Erforderliche Parameter

az apim api update

Beispiele

Erforderliche Parameter

Optionale Parameter

az apim api wait

Beispiele

Erforderliche Parameter

Optionale Parameter

Feedback