az apic api version

  • Referenz

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-Versionsbefehl zum ersten Mal ausführen. Weitere Informationen zu Erweiterungen

Befehle zum Verwalten von API-Versionen im API Center.

Befehle

Name Beschreibung Typ Status
az apic api version create

Erstellen Sie eine neue API-Version, oder aktualisieren Sie eine vorhandene API-Version.

 Erweiterung Allgemein verfügbar
az apic api version delete

Löscht die angegebene API-Version.

 Erweiterung Allgemein verfügbar
az apic api version list

Listet eine Sammlung von API-Versionen auf.

 Erweiterung Allgemein verfügbar
az apic api version show

Rufen Sie Details der API-Version ab.

 Erweiterung Allgemein verfügbar
az apic api version update

Vorhandene API-Version aktualisieren.

 Erweiterung Allgemein verfügbar

az apic api version create

Erstellen Sie eine neue API-Version, oder aktualisieren Sie eine vorhandene API-Version.

az apic api version create --api-id
                           --lifecycle-stage {deprecated, design, development, preview, production, retired, testing}
                           --resource-group
                           --service-name
                           --title
                           --version-id

Beispiele

API-Version erstellen

az apic api version create -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01 --title "2023-01-01" --lifecycle-stage production

Erforderliche Parameter

--api-id

Die ID der API.

--lifecycle-stage

Aktuelle Lebenszyklusstufe der API.

Zulässige Werte: deprecated, design, development, preview, production, retired, testing
--resource-group -g

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

--service-name -n

Der Name des Azure API Center-Diensts.

--title

API-Version.

--version-id

Die ID der API-Version.

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 apic api version delete

Löscht die angegebene API-Version.

az apic api version delete [--api-id]
                           [--ids]
                           [--resource-group]
                           [--service-name]
                           [--subscription]
                           [--version-id]
                           [--yes]

Beispiele

API-Version löschen

az apic api version delete -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01

Optionale Parameter

--api-id

Die ID der API.

--ids

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.

--resource-group -g

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

--service-name -n

Der Name des Azure API Center-Diensts.

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

--version-id

Die ID der API-Version.

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

Listet eine Sammlung von API-Versionen auf.

az apic api version list --api-id
                         --resource-group
                         --service-name
                         [--filter]
                         [--max-items]
                         [--next-token]

Beispiele

Auflisten von API-Versionen

az apic api version list -g api-center-test -n contosoeuap --api-id echo-api

Erforderliche Parameter

--api-id

Die ID der API.

--resource-group -g

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

--service-name -n

Der Name des Azure API Center-Diensts.

Optionale Parameter

--filter

OData-Filterparameter.

--max-items

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.

--next-token

Token, das angibt, wo die Paginierung beginnen soll. Dies ist der Tokenwert aus einer zuvor abgeschnittenen Antwort.

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

Rufen Sie Details der API-Version ab.

az apic api version show [--api-id]
                         [--ids]
                         [--resource-group]
                         [--service-name]
                         [--subscription]
                         [--version-id]

Beispiele

API-Versionsdetails anzeigen

az apic api version show -g api-center-test -n contoso --api-id echo-api --version-id 2023-01-01

Optionale Parameter

--api-id

Die ID der API.

--ids

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.

--resource-group -g

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

--service-name -n

Der Name des Azure API Center-Diensts.

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

--version-id

Die ID der API-Version.

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

Vorhandene API-Version aktualisieren.

az apic api version update [--add]
                           [--api-id]
                           [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                           [--ids]
                           [--lifecycle-stage {deprecated, design, development, preview, production, retired, testing}]
                           [--remove]
                           [--resource-group]
                           [--service-name]
                           [--set]
                           [--subscription]
                           [--title]
                           [--version-id]

Beispiele

Aktualisieren der API-Version

az apic api version update -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01 --title "2023-01-01"

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

--api-id

Die ID der API.

--force-string

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

Zulässige Werte: 0, 1, f, false, n, no, t, true, y, yes
--ids

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.

--lifecycle-stage

Aktuelle Lebenszyklusstufe der API.

Zulässige Werte: deprecated, design, development, preview, production, retired, testing
--remove

Entfernen sie eine Eigenschaft oder ein Element aus einer Liste. Beispiel: --remove property.list OR --remove propertyToRemove.

--resource-group -g

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

--service-name -n

Der Name des Azure API Center-Diensts.

--set

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

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

--title

API-Version.

--version-id

Die ID der API-Version.

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.