az apic

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

Verwalten von Azure API Center-Diensten.

Befehle

Name Beschreibung Typ Status
az apic api

Befehle zum Verwalten von APIs im API Center.

 Erweiterung Allgemein verfügbar
az apic api create

Registrieren Sie eine neue API, oder aktualisieren Sie eine vorhandene API.

 Erweiterung Allgemein verfügbar
az apic api definition

Befehle zum Verwalten von API-Definitionen im API Center.

 Erweiterung Allgemein verfügbar
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 delete

Löscht die angegebene API.

 Erweiterung Allgemein verfügbar
az apic api deployment

Befehle zum Verwalten von API-Bereitstellungen im API Center.

 Erweiterung Allgemein verfügbar
az apic api deployment create

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

 Erweiterung Allgemein verfügbar
az apic api deployment delete

Api-Bereitstellung löschen.

 Erweiterung Allgemein verfügbar
az apic api deployment list

Listet eine Sammlung von API-Bereitstellungen auf.

 Erweiterung Allgemein verfügbar
az apic api deployment show

Rufen Sie Details der API-Bereitstellung ab.

 Erweiterung Allgemein verfügbar
az apic api deployment update

Aktualisieren sie die vorhandene API-Bereitstellung.

 Erweiterung Allgemein verfügbar
az apic api list

Auflisten einer Sammlung von APIs.

 Erweiterung Allgemein verfügbar
az apic api register

Registriert eine neue API mit Version, Definition und zugehörigen Bereitstellungen mithilfe der Spezifikationsdatei als Wahrheitsquelle. Derzeit unterstützen wir nur das OpenAPI JSON/YAML-Format.

 Erweiterung Vorschau
az apic api show

Rufen Sie Details der API ab.

 Erweiterung Allgemein verfügbar
az apic api update

Vorhandene API aktualisieren.

 Erweiterung Allgemein verfügbar
az apic api version

Befehle zum Verwalten von API-Versionen im API Center.

 Erweiterung Allgemein verfügbar
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 create

Erstellt eine Instanz oder aktualisiert eine vorhandene Instanz eines Azure API Center-Diensts.

 Erweiterung Allgemein verfügbar
az apic delete

Löscht eine Instanz eines Azure API Center-Diensts.

 Erweiterung Allgemein verfügbar
az apic environment

Befehle zum Verwalten von Umgebungen im API Center.

 Erweiterung Allgemein verfügbar
az apic environment create

Erstellen Sie eine neue Umgebung, oder aktualisieren Sie eine vorhandene Umgebung.

 Erweiterung Allgemein verfügbar
az apic environment delete

Die Umgebung löschen.

 Erweiterung Allgemein verfügbar
az apic environment list

Listet eine Sammlung von Umgebungen auf.

 Erweiterung Allgemein verfügbar
az apic environment show

Rufen Sie Details zur Umgebung ab.

 Erweiterung Allgemein verfügbar
az apic environment update

Vorhandene Umgebung aktualisieren.

 Erweiterung Allgemein verfügbar
az apic import-from-apim

Importiert APIs aus einer Azure-API-Verwaltungsdienstinstanz.

 Erweiterung Allgemein verfügbar
az apic list

Listet Azure API Center-Dienste in einem Azure-Abonnement auf.

 Erweiterung Allgemein verfügbar
az apic metadata

Befehle zum Verwalten von Metadatenschemas im API Center.

 Erweiterung Allgemein verfügbar
az apic metadata create

Erstellen Sie ein neues Metadatenschema, oder aktualisieren Sie ein vorhandenes Metadatenschema.

 Erweiterung Allgemein verfügbar
az apic metadata delete

Angegebenes Metadatenschema löschen.

 Erweiterung Allgemein verfügbar
az apic metadata export

Exportiert das Metadatenschema.

 Erweiterung Allgemein verfügbar
az apic metadata list

Listet eine Sammlung von Metadatenschemas auf.

 Erweiterung Allgemein verfügbar
az apic metadata show

Rufen Sie Details zum Metadatenschema ab.

 Erweiterung Allgemein verfügbar
az apic metadata update

Vorhandenes Metadatenschema aktualisieren.

 Erweiterung Allgemein verfügbar
az apic show

Details einer Azure API Center-Dienstinstanz anzeigen.

 Erweiterung Allgemein verfügbar
az apic update

Aktualisieren sie eine Instanz eines Azure API Center-Diensts.

 Erweiterung Allgemein verfügbar

az apic create

Erstellt eine Instanz oder aktualisiert eine vorhandene Instanz eines Azure API Center-Diensts.

az apic create --name
               --resource-group
               [--identity]
               [--location]
               [--tags]

Beispiele

Dienstbeispiel 1 erstellen

az apic create -g contoso-resources -n contoso -l eastus

Dienstbeispiel 2 erstellen

az apic create --resource-group contoso-resources --name contoso --location eastus

Erforderliche Parameter

--name -n

Der Name des API Center-Diensts.

--resource-group -g

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

Optionale Parameter

--identity

Die verwalteten Dienstidentitäten, die dieser Ressource zugewiesen sind. Unterstützung von Shorthand-Syntax, JSON-Datei und Yaml-Datei. Probieren Sie "??" aus, um mehr anzuzeigen.

--location -l

Der geografische Standort, an dem sich die Ressource befindet, wenn nicht angegeben, wird der Standort der Ressourcengruppe verwendet.

--tags

Ressourcentags. Unterstützung von Shorthand-Syntax, JSON-Datei und Yaml-Datei. Probieren Sie "??" aus, um mehr anzuzeigen.

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 delete

Löscht eine Instanz eines Azure API Center-Diensts.

az apic delete [--ids]
               [--name]
               [--resource-group]
               [--subscription]
               [--yes]

Beispiele

Suchdienst löschen

az apic delete -n contoso -g contoso-resources

Optionale Parameter

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

--name -n

Der Name des API Center-Diensts.

--resource-group -g

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

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

--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 import-from-apim

Importiert APIs aus einer Azure-API-Verwaltungsdienstinstanz.

az apic import-from-apim --apim-apis
                         --apim-name
                         [--apim-resource-group]
                         [--apim-subscription]
                         [--ids]
                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                         [--resource-group]
                         [--service-name]
                         [--subscription]

Beispiele

Alle APIs aus APIM in derselben Ressourcengruppe importieren

az apic import-from-apim -g api-center-test --service-name contoso-apic --apim-name contoso-apim --apim-apis *

Importieren ausgewählter APIs aus APIM in derselben Ressourcengruppe

az apic import-from-apim -g api-center-test --service-name contoso-apic --apim-name contoso-apim --apim-apis [echo,foo]

Importieren aller APIs aus APIM in einem anderen Abonnement und einer anderen Ressourcengruppe

az apic import-from-apim -g api-center-test --service-name contoso-apic --apim-subscription 00000000-0000-0000-0000-000000000000 --apim-resource-group apim-rg --apim-name contoso-apim --apim-apis *

Erforderliche Parameter

--apim-apis

Die zu importierenden APIs. Unterstützung von Shorthand-Syntax, JSON-Datei und Yaml-Datei. Probieren Sie "??" aus, um mehr anzuzeigen.

--apim-name

Der Name der Quell-APIM-Instanz.

Optionale Parameter

--apim-resource-group

Die Ressourcengruppe der Quell-APIM-Instanz.

--apim-subscription

Die Abonnement-ID der Quell-APIM-Instanz.

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

--no-wait

Nicht auf den Abschluss lang andauernder Vorgänge warten

Zulässige Werte: 0, 1, f, false, n, no, t, true, y, yes
--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.

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 list

Listet Azure API Center-Dienste in einem Azure-Abonnement auf.

Es gibt ein bekanntes Problem, bei dem alle Ressourcen unter einem Abonnement nicht aufgeführt werden. Bitte listen Sie Ressourcen nach Ressourcengruppe auf.

az apic list [--max-items]
             [--next-token]
             [--resource-group]

Beispiele

Dienste in Ressourcengruppe auflisten

az apic list -g contoso-resources

Optionale Parameter

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

--resource-group -g

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

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 show

Details einer Azure API Center-Dienstinstanz anzeigen.

az apic show [--ids]
             [--name]
             [--resource-group]
             [--subscription]

Beispiele

Dienstdetails anzeigen

az apic show -g contoso-resources -n contoso

Optionale Parameter

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

--name -n

Der Name des API Center-Diensts.

--resource-group -g

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

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

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 update

Aktualisieren sie eine Instanz eines Azure API Center-Diensts.

az apic update [--add]
               [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
               [--identity]
               [--ids]
               [--name]
               [--remove]
               [--resource-group]
               [--set]
               [--subscription]
               [--tags]

Beispiele

Aktualisieren von Dienstdetails

az apic update -g contoso-resources -n contoso

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

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

Die verwalteten Dienstidentitäten, die dieser Ressource zugewiesen sind. Unterstützung von Shorthand-Syntax, JSON-Datei und Yaml-Datei. Probieren Sie "??" aus, um mehr anzuzeigen.

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

--name -n

Der Name des API Center-Diensts.

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

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

--tags

Ressourcentags. Unterstützung von Shorthand-Syntax, JSON-Datei und Yaml-Datei. Probieren Sie "??" aus, um mehr anzuzeigen.

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.