az apic

Note

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. Erfahren Sie mehr über Erweiterungen.

Verwalten von Azure API Center-Diensten.

Befehle

Name	Beschreibung	Typ	Status
az apic api	Befehle zum Verwalten von APIs im API Center.	Extension	GA
az apic api-analysis	Verwalten von Azure API Center-Dienst-API-Analysefeatures.	Extension	Preview
az apic api-analysis create	Erstellen Sie neue oder aktualisiert vorhandene API-Analysekonfigurationen.	Extension	Preview
az apic api-analysis delete	Löscht die API-Analysekonfiguration.	Extension	Preview
az apic api-analysis export-ruleset	Exportiert das API-Analyseregelnet.	Extension	Preview
az apic api-analysis import-ruleset	Importiert das API-Analyseregelnet.	Extension	Preview
az apic api-analysis list	Api-Analysekonfigurationen auflisten.	Extension	Preview
az apic api-analysis show	Rufen Sie Details der API-Analysekonfiguration ab.	Extension	Preview
az apic api-analysis update	Aktualisieren Sie neue oder aktualisierte vorhandene API-Analysekonfigurationen.	Extension	Preview
az apic api create	Registrieren Sie eine neue API, oder aktualisieren Sie eine vorhandene API.	Extension	GA
az apic api definition	Befehle zum Verwalten von API-Definitionen im API Center.	Extension	GA
az apic api definition create	Erstellen Sie eine neue API-Definition, oder aktualisieren Sie eine vorhandene API-Definition.	Extension	GA
az apic api definition delete	Die angegebene API-Definition löschen.	Extension	GA
az apic api definition export-specification	Exportiert die API-Spezifikation.	Extension	GA
az apic api definition import-specification	Importiert die API-Spezifikation.	Extension	GA
az apic api definition list	Listet eine Sammlung von API-Definitionen auf.	Extension	GA
az apic api definition show	Rufen Sie Details der API-Definition ab.	Extension	GA
az apic api definition update	Vorhandene API-Definition aktualisieren.	Extension	GA
az apic api delete	Löscht die angegebene API.	Extension	GA
az apic api deployment	Befehle zum Verwalten von API-Bereitstellungen im API Center.	Extension	GA
az apic api deployment create	Erstellen Sie eine neue API-Bereitstellung, oder aktualisieren Sie eine vorhandene API-Bereitstellung.	Extension	GA
az apic api deployment delete	Api-Bereitstellung löschen.	Extension	GA
az apic api deployment list	Listet eine Sammlung von API-Bereitstellungen auf.	Extension	GA
az apic api deployment show	Rufen Sie Details der API-Bereitstellung ab.	Extension	GA
az apic api deployment update	Aktualisieren sie die vorhandene API-Bereitstellung.	Extension	GA
az apic api list	Auflisten einer Sammlung von APIs.	Extension	GA
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.	Extension	Preview
az apic api show	Rufen Sie Details der API ab.	Extension	GA
az apic api update	Vorhandene API aktualisieren.	Extension	GA
az apic api version	Befehle zum Verwalten von API-Versionen im API Center.	Extension	GA
az apic api version create	Erstellen Sie eine neue API-Version, oder aktualisieren Sie eine vorhandene API-Version.	Extension	GA
az apic api version delete	Löscht die angegebene API-Version.	Extension	GA
az apic api version list	Listet eine Sammlung von API-Versionen auf.	Extension	GA
az apic api version show	Rufen Sie Details der API-Version ab.	Extension	GA
az apic api version update	Vorhandene API-Version aktualisieren.	Extension	GA
az apic create	Erstellt eine Instanz oder aktualisiert eine vorhandene Instanz eines Azure API Center-Diensts.	Extension	GA
az apic delete	Löscht eine Instanz eines Azure API Center-Diensts.	Extension	GA
az apic environment	Befehle zum Verwalten von Umgebungen im API Center.	Extension	GA
az apic environment create	Erstellen Sie eine neue Umgebung, oder aktualisieren Sie eine vorhandene Umgebung.	Extension	GA
az apic environment delete	Die Umgebung löschen.	Extension	GA
az apic environment list	Listet eine Sammlung von Umgebungen auf.	Extension	GA
az apic environment show	Rufen Sie Details zur Umgebung ab.	Extension	GA
az apic environment update	Vorhandene Umgebung aktualisieren.	Extension	GA
az apic integration	Verwaltet Integrationen im Azure API Center.	Extension	GA
az apic integration create	Verwalten von Azure API Center-Diensten.	Extension	GA
az apic integration create apim	Fügen Sie Azure APIM als API-Quelle hinzu.	Extension	GA
az apic integration create aws	Fügen Sie amazon API Gateway als API-Quelle hinzu.	Extension	GA
az apic integration delete	Löscht die angegebene API-Quelle.	Extension	GA
az apic integration list	Listet eine Sammlung von API-Quellen auf.	Extension	GA
az apic integration show	Rufen Sie Details der API-Quelle ab.	Extension	GA
az apic list	Listet Azure API Center-Dienste in einem Azure-Abonnement auf.	Extension	GA
az apic metadata	Befehle zum Verwalten von Metadatenschemas im API Center.	Extension	GA
az apic metadata create	Erstellen Sie ein neues Metadatenschema, oder aktualisieren Sie ein vorhandenes Metadatenschema.	Extension	GA
az apic metadata delete	Angegebenes Metadatenschema löschen.	Extension	GA
az apic metadata export	Exportiert das Metadatenschema.	Extension	GA
az apic metadata list	Listet eine Sammlung von Metadatenschemas auf.	Extension	GA
az apic metadata show	Rufen Sie Details zum Metadatenschema ab.	Extension	GA
az apic metadata update	Vorhandenes Metadatenschema aktualisieren.	Extension	GA
az apic show	Details einer Azure API Center-Dienstinstanz anzeigen.	Extension	GA
az apic update	Aktualisieren sie eine Instanz eines Azure API Center-Diensts.	Extension	GA

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 erstellen

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

Erstellen eines Diensts mit System zugewiesener Identität (Beispiel)

az apic create -g contoso-resources -n contoso -l eastus --identity '{type:systemassigned}'

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

Die folgenden Parameter sind optional, aber je nach Kontext kann mindestens ein Parameter erforderlich sein, damit der Befehl erfolgreich ausgeführt werden kann.

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

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft	Wert
Standardwert:	False

--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft	Wert
Standardwert:	False

--output -o

Ausgabeformat.

Eigenschaft	Wert
Standardwert:	json
Zulässige Werte:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft	Wert
Standardwert:	False

az apic delete

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

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

Beispiele

Dienst löschen

az apic delete -n contoso -g contoso-resources

Optionale Parameter

Die folgenden Parameter sind optional, aber je nach Kontext kann mindestens ein Parameter erforderlich sein, damit der Befehl erfolgreich ausgeführt werden kann.

--ids

Mindestens eine Ressourcen-IDs (durch Leerzeichen getrennt). Dabei sollte es sich um eine vollständige Ressourcen-ID mit allen Informationen der Argumente "Ressourcen-ID" sein. Sie sollten entweder --ids oder andere Argumente für die Ressourcen-ID angeben.

Eigenschaft	Wert
Parametergruppe:	Resource Id Arguments

--name -n

Der Name des API Center-Diensts.

Eigenschaft	Wert
Parametergruppe:	Resource Id Arguments

--resource-group -g

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

Eigenschaft	Wert
Parametergruppe:	Resource Id Arguments

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

Eigenschaft	Wert
Parametergruppe:	Resource Id Arguments

--yes -y

Zur Bestätigung nicht auffordern.

Eigenschaft	Wert
Standardwert:	False

Globale Parameter

--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft	Wert
Standardwert:	False

--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft	Wert
Standardwert:	False

--output -o

Ausgabeformat.

Eigenschaft	Wert
Standardwert:	json
Zulässige Werte:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft	Wert
Standardwert:	False

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

Die folgenden Parameter sind optional, aber je nach Kontext kann mindestens ein Parameter erforderlich sein, damit der Befehl erfolgreich ausgeführt werden kann.

--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 in --next-token Argument eines nachfolgenden Befehls an.

Eigenschaft	Wert
Parametergruppe:	Pagination Arguments

--next-token

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

Eigenschaft	Wert
Parametergruppe:	Pagination Arguments

--resource-group -g

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

Globale Parameter

--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft	Wert
Standardwert:	False

--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft	Wert
Standardwert:	False

--output -o

Ausgabeformat.

Eigenschaft	Wert
Standardwert:	json
Zulässige Werte:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft	Wert
Standardwert:	False

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

Die folgenden Parameter sind optional, aber je nach Kontext kann mindestens ein Parameter erforderlich sein, damit der Befehl erfolgreich ausgeführt werden kann.

--ids

Mindestens eine Ressourcen-IDs (durch Leerzeichen getrennt). Dabei sollte es sich um eine vollständige Ressourcen-ID mit allen Informationen der Argumente "Ressourcen-ID" sein. Sie sollten entweder --ids oder andere Argumente für die Ressourcen-ID angeben.

Eigenschaft	Wert
Parametergruppe:	Resource Id Arguments

--name -n

Der Name des API Center-Diensts.

Eigenschaft	Wert
Parametergruppe:	Resource Id Arguments

--resource-group -g

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

Eigenschaft	Wert
Parametergruppe:	Resource Id Arguments

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

Eigenschaft	Wert
Parametergruppe:	Resource Id Arguments

Globale Parameter

--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft	Wert
Standardwert:	False

--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft	Wert
Standardwert:	False

--output -o

Ausgabeformat.

Eigenschaft	Wert
Standardwert:	json
Zulässige Werte:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft	Wert
Standardwert:	False

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

Updatedienst mit System zugewiesener Identität (Beispiel)

az apic update -g contoso-resources -n contoso --identity '{type:systemassigned}'

Optionale Parameter

Die folgenden Parameter sind optional, aber je nach Kontext kann mindestens ein Parameter erforderlich sein, damit der Befehl erfolgreich ausgeführt werden kann.

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

Eigenschaft	Wert
Parametergruppe:	Generic Update Arguments

--force-string

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

Eigenschaft	Wert
Parametergruppe:	Generic Update Arguments
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

Mindestens eine Ressourcen-IDs (durch Leerzeichen getrennt). Dabei sollte es sich um eine vollständige Ressourcen-ID mit allen Informationen der Argumente "Ressourcen-ID" sein. Sie sollten entweder --ids oder andere Argumente für die Ressourcen-ID angeben.

Eigenschaft	Wert
Parametergruppe:	Resource Id Arguments

--name -n

Der Name des API Center-Diensts.

Eigenschaft	Wert
Parametergruppe:	Resource Id Arguments

--remove

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

Eigenschaft	Wert
Parametergruppe:	Generic Update Arguments

--resource-group -g

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

Eigenschaft	Wert
Parametergruppe:	Resource Id Arguments

--set

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

Eigenschaft	Wert
Parametergruppe:	Generic Update Arguments

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

Eigenschaft	Wert
Parametergruppe:	Resource Id Arguments

--tags

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

Globale Parameter

--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft	Wert
Standardwert:	False

--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft	Wert
Standardwert:	False

--output -o

Ausgabeformat.

Eigenschaft	Wert
Standardwert:	json
Zulässige Werte:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft	Wert
Standardwert:	False