az apic api definition
Hinweis
Diese Referenz ist Teil der APIC-Erweiterungserweiterung für die Azure CLI (Version 2.57.0 oder höher). Die Erweiterung wird automatisch installiert, wenn Sie einen az apic-API-Definitionsbefehl zum ersten Mal ausführen. Weitere Informationen zu Erweiterungen
Befehle zum Verwalten von API-Definitionen im API Center.
Befehle
| Name | Beschreibung | Typ | Status |
|---|---|---|---|
| az apic api definition create |
Erstellen Sie eine neue API-Definition, oder aktualisieren Sie eine vorhandene API-Definition. |
Erweiterung | Allgemein verfügbar |
| az apic api definition delete |
Die angegebene API-Definition löschen. |
Erweiterung | Allgemein verfügbar |
| az apic api definition export-specification |
Exportiert die API-Spezifikation. |
Erweiterung | Allgemein verfügbar |
| az apic api definition import-specification |
Importiert die API-Spezifikation. |
Erweiterung | Allgemein verfügbar |
| az apic api definition list |
Listet eine Sammlung von API-Definitionen auf. |
Erweiterung | Allgemein verfügbar |
| az apic api definition show |
Rufen Sie Details der API-Definition ab. |
Erweiterung | Allgemein verfügbar |
| az apic api definition update |
Vorhandene API-Definition aktualisieren. |
Erweiterung | Allgemein verfügbar |
az apic api definition create
Erstellen Sie eine neue API-Definition, oder aktualisieren Sie eine vorhandene API-Definition.
az apic api definition create --api-id
--definition-id
--resource-group
--service-name
--title
--version-id
[--description]Beispiele
API-Definition erstellen
az apic api definition create -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id "openapi" --title "OpenAPI"Erforderliche Parameter
Die ID der API.
Die ID der API-Definition.
Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.
Der Name des Azure API Center-Diensts.
API-Version.
Die ID der API-Version.
Optionale Parameter
API-Definitionsbeschreibung.
Globale Parameter
Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.
Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.
Nur Fehler anzeigen und Warnungen unterdrücken.
Ausgabeformat.
JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.
Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.
Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.
az apic api definition delete
Die angegebene API-Definition löschen.
az apic api definition delete [--api-id]
[--definition-id]
[--ids]
[--resource-group]
[--service-name]
[--subscription]
[--version-id]
[--yes]Beispiele
API-Definition löschen
az apic api definition delete -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id "openapi"Optionale Parameter
Die ID der API.
Die ID der API-Definition.
Eine oder mehrere Ressourcen-IDs (durch Leerzeichen getrennt). Dabei sollte es sich um eine vollständige Ressourcen-ID mit allen Informationen der „Ressource id“-Argumente handeln. Sie sollten entweder „--ids“ oder andere „Resource Id“-Argumente angeben.
Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.
Der Name des Azure API Center-Diensts.
Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.
Die ID der API-Version.
Nicht zur Bestätigung auffordern
Globale Parameter
Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.
Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.
Nur Fehler anzeigen und Warnungen unterdrücken.
Ausgabeformat.
JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.
Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.
Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.
az apic api definition export-specification
Exportiert die API-Spezifikation.
az apic api definition export-specification --file-name
[--api-id]
[--definition-id]
[--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--service-name]
[--subscription]
[--version-id]Beispiele
Exportspezifikation
az apic api definition export-specification -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id default --file-name filename.jsonErforderliche Parameter
Name der Datei, in die die Spezifikation exportiert werden soll.
Optionale Parameter
Die ID der API.
Die ID der API-Definition.
Eine oder mehrere Ressourcen-IDs (durch Leerzeichen getrennt). Dabei sollte es sich um eine vollständige Ressourcen-ID mit allen Informationen der „Ressource id“-Argumente handeln. Sie sollten entweder „--ids“ oder andere „Resource Id“-Argumente angeben.
Nicht auf den Abschluss lang andauernder Vorgänge warten
Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.
Der Name des Azure API Center-Diensts.
Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.
Die ID der API-Version.
Globale Parameter
Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.
Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.
Nur Fehler anzeigen und Warnungen unterdrücken.
Ausgabeformat.
JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.
Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.
Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.
az apic api definition import-specification
Importiert die API-Spezifikation.
az apic api definition import-specification --format {inline, link}
--specification
--value
[--api-id]
[--definition-id]
[--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--service-name]
[--subscription]
[--version-id]Beispiele
Importspezifikation (Beispiel 1)
az apic api definition import-specification -g api-center-test -n contosoeuap --api-id echo-api-2 --version-id 2023-08-01 --definition-id openapi3 --format "inline" --value '{"openapi":"3.0.1","info":{"title":"httpbin.org","description":"API Management facade for a very handy and free online HTTP tool.","version":"1.0"}}' --specification '{"name":"openapi","version":"3.0.0"}'Importspezifikation (Beispiel 2)
az apic api definition import-specification -g api-center-test -n contoso --api-id echo-api --version-id 2023-11-01 --definition-id openapi --format "link" --value 'https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/examples/v3.0/petstore.json' --specification '{"name":"openapi","version":"3.0.0"}'Erforderliche Parameter
Format der API-Spezifikationsquelle.
API-Spezifikationsdetails. Unterstützung von Shorthand-Syntax, JSON-Datei und Yaml-Datei. Probieren Sie "??" aus, um mehr anzuzeigen.
Wert der API-Spezifikationsquelle.
Optionale Parameter
Die ID der API.
Die ID der API-Definition.
Eine oder mehrere Ressourcen-IDs (durch Leerzeichen getrennt). Dabei sollte es sich um eine vollständige Ressourcen-ID mit allen Informationen der „Ressource id“-Argumente handeln. Sie sollten entweder „--ids“ oder andere „Resource Id“-Argumente angeben.
Nicht auf den Abschluss lang andauernder Vorgänge warten
Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.
Der Name des Azure API Center-Diensts.
Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.
Die ID der API-Version.
Globale Parameter
Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.
Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.
Nur Fehler anzeigen und Warnungen unterdrücken.
Ausgabeformat.
JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.
Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.
Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.
az apic api definition list
Listet eine Sammlung von API-Definitionen auf.
az apic api definition list --api-id
--resource-group
--service-name
--version-id
[--filter]
[--max-items]
[--next-token]Beispiele
API-Definitionen auflisten
az apic api definition list -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01Erforderliche Parameter
Die ID der API.
Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.
Der Name des Azure API Center-Diensts.
Die ID der API-Version.
Optionale Parameter
OData-Filterparameter.
Die Gesamtanzahl der Elemente, die in der Ausgabe des Befehls zurückgegeben werden sollen. Wenn die Gesamtanzahl der verfügbaren Elemente größer als der angegebene Wert ist, wird ein Token in der Ausgabe des Befehls bereitgestellt. Um die Paginierung fortzusetzen, geben Sie den Tokenwert im --next-token Argument eines nachfolgenden Befehls an.
Token, das angibt, wo die Paginierung beginnen soll. Dies ist der Tokenwert aus einer zuvor abgeschnittenen Antwort.
Globale Parameter
Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.
Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.
Nur Fehler anzeigen und Warnungen unterdrücken.
Ausgabeformat.
JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.
Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.
Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.
az apic api definition show
Rufen Sie Details der API-Definition ab.
az apic api definition show [--api-id]
[--definition-id]
[--ids]
[--resource-group]
[--service-name]
[--subscription]
[--version-id]Beispiele
API-Definitionsdetails anzeigen
az apic api definition show -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id "openapi"Optionale Parameter
Die ID der API.
Die ID der API-Definition.
Eine oder mehrere Ressourcen-IDs (durch Leerzeichen getrennt). Dabei sollte es sich um eine vollständige Ressourcen-ID mit allen Informationen der „Ressource id“-Argumente handeln. Sie sollten entweder „--ids“ oder andere „Resource Id“-Argumente angeben.
Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.
Der Name des Azure API Center-Diensts.
Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.
Die ID der API-Version.
Globale Parameter
Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.
Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.
Nur Fehler anzeigen und Warnungen unterdrücken.
Ausgabeformat.
JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.
Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.
Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.
az apic api definition update
Vorhandene API-Definition aktualisieren.
az apic api definition update [--add]
[--api-id]
[--definition-id]
[--description]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--remove]
[--resource-group]
[--service-name]
[--set]
[--subscription]
[--title]
[--version-id]Beispiele
API-Definition aktualisieren
az apic api definition update -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id "openapi" --title "OpenAPI"Optionale Parameter
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>.
Die ID der API.
Die ID der API-Definition.
API-Definitionsbeschreibung.
Wenn Sie "set" oder "add" verwenden, behalten Sie Zeichenfolgenliterale bei, anstatt zu versuchen, in JSON zu konvertieren.
Eine oder mehrere Ressourcen-IDs (durch Leerzeichen getrennt). Dabei sollte es sich um eine vollständige Ressourcen-ID mit allen Informationen der „Ressource id“-Argumente handeln. Sie sollten entweder „--ids“ oder andere „Resource Id“-Argumente angeben.
Entfernen sie eine Eigenschaft oder ein Element aus einer Liste. Beispiel: --remove property.list OR --remove propertyToRemove.
Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.
Der Name des Azure API Center-Diensts.
Aktualisieren Sie ein Objekt, indem Sie einen festzulegenden Eigenschaftspfad und -wert angeben. Beispiel: --set property1.property2=.
Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.
API-Versionstitel.
Die ID der API-Version.
Globale Parameter
Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.
Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.
Nur Fehler anzeigen und Warnungen unterdrücken.
Ausgabeformat.
JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.
Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.
Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.
