Freigeben über

az apic api

  • Referenz

Anmerkung

Diese Referenz ist Teil der apic-extension Erweiterung für die Azure CLI (Version 2.57.0 oder höher). Die Erweiterung wird automatisch installiert, wenn Sie zum ersten Mal eine az apic-API Befehl ausführen. Erfahren Sie mehr über Erweiterungen.

Befehle zum Verwalten von APIs im API Center.

Befehle

Name Beschreibung Typ Status
az apic api create

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

 Erweiterung GA
az apic api definition

Befehle zum Verwalten von API-Definitionen im API Center.

 Erweiterung GA
az apic api definition create

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

 Erweiterung GA
az apic api definition delete

Die angegebene API-Definition löschen.

 Erweiterung GA
az apic api definition export-specification

Exportiert die API-Spezifikation.

 Erweiterung GA
az apic api definition import-specification

Importiert die API-Spezifikation.

 Erweiterung GA
az apic api definition list

Listet eine Sammlung von API-Definitionen auf.

 Erweiterung GA
az apic api definition show

Rufen Sie Details der API-Definition ab.

 Erweiterung GA
az apic api definition update

Vorhandene API-Definition aktualisieren.

 Erweiterung GA
az apic api delete

Löscht die angegebene API.

 Erweiterung GA
az apic api deployment

Befehle zum Verwalten von API-Bereitstellungen im API Center.

 Erweiterung GA
az apic api deployment create

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

 Erweiterung GA
az apic api deployment delete

Api-Bereitstellung löschen.

 Erweiterung GA
az apic api deployment list

Listet eine Sammlung von API-Bereitstellungen auf.

 Erweiterung GA
az apic api deployment show

Rufen Sie Details der API-Bereitstellung ab.

 Erweiterung GA
az apic api deployment update

Aktualisieren sie die vorhandene API-Bereitstellung.

 Erweiterung GA
az apic api list

Auflisten einer Sammlung von APIs.

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

 Erweiterung Vorschau
az apic api show

Rufen Sie Details der API ab.

 Erweiterung GA
az apic api update

Vorhandene API aktualisieren.

 Erweiterung GA
az apic api version

Befehle zum Verwalten von API-Versionen im API Center.

 Erweiterung GA
az apic api version create

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

 Erweiterung GA
az apic api version delete

Löscht die angegebene API-Version.

 Erweiterung GA
az apic api version list

Listet eine Sammlung von API-Versionen auf.

 Erweiterung GA
az apic api version show

Rufen Sie Details der API-Version ab.

 Erweiterung GA
az apic api version update

Vorhandene API-Version aktualisieren.

 Erweiterung GA

az apic api create

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

az apic api create --api-id
                   --resource-group
                   --service-name
                   --title
                   --type {graphql, grpc, rest, soap, webhook, websocket}
                   [--contacts]
                   [--custom-properties]
                   [--description]
                   [--external-documentation]
                   [--license]
                   [--summary]

Beispiele

API erstellen

az apic api create -g contoso-resources -n contoso --api-id echo-api --title "Echo API" --type REST

Erstellen einer API mit benutzerdefinierten Eigenschaften

az apic api create -g contoso-resources -n contoso --api-id echo-api --title "Echo API" --type REST --custom-properties '{"public-facing":true}'

Erstellen einer API mit benutzerdefinierten Eigenschaften mithilfe der JSON-Datei

az apic api create -g contoso-resources -n contoso --api-id echo-api --title "Echo API" --type REST --custom-properties '@customProperties.json'

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.

--title

API-Titel.

--type

API-Typ.

Zulässige Werte: graphql, grpc, rest, soap, webhook, websocket

Optionale Parameter

--contacts

Die Kontaktinformationen für die API. Unterstützung von Shorthand-Syntax, JSON-Datei und Yaml-Datei. Probieren Sie "??" aus, um mehr anzuzeigen.

--custom-properties

Die benutzerdefinierten Metadaten, die für API-Katalogentitäten definiert sind. Unterstützen Sie json-file und yaml-file.

--description

Beschreibung der API.

--external-documentation

Zusätzliche, externe Dokumentation für die API. Unterstützung von Shorthand-Syntax, JSON-Datei und Yaml-Datei. Probieren Sie "??" aus, um mehr anzuzeigen.

--license

Die Lizenzinformationen für die API. Unterstützung von Shorthand-Syntax, JSON-Datei und Yaml-Datei. Probieren Sie "??" aus, um mehr anzuzeigen.

--summary

Kurze Beschreibung der API.

Globale Parameter
--debug

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

--help -h

Diese Hilfenachricht anzeigen und beenden.

--only-show-errors

Nur Fehler anzeigen, 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

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.

az apic api delete

Löscht die angegebene API.

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

Beispiele

API löschen

az apic api delete -g contoso-resources -n contoso --api-id echo-api

Optionale Parameter

--api-id

Die ID der API.

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

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

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

--yes -y

Zur Bestätigung nicht auffordern.

Standardwert: False
Globale Parameter
--debug

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

--help -h

Diese Hilfenachricht anzeigen und beenden.

--only-show-errors

Nur Fehler anzeigen, 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

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.

az apic api list

Auflisten einer Sammlung von APIs.

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

Beispiele

Auflisten von APIs

az apic api list -g contoso-resources -n contoso

Auflisten von APIs mit Filter

az apic api list -g contoso-resources -n contoso --filter "kind eq 'rest'"

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

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

--help -h

Diese Hilfenachricht anzeigen und beenden.

--only-show-errors

Nur Fehler anzeigen, 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

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.

az apic api register

Vorschau

Dieser Befehl befindet sich in der Vorschau und in der Entwicklung. Referenz- und Supportebenen: https://aka.ms/CLI_refstatus

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.

az apic api register --api-location
                     --resource-group
                     --service-name
                     [--environment-id]

Beispiele

Registrieren Sie die API, indem Sie die Spezifikationsdatei angeben.

az apic api register -g api-center-test -n contosoeuap --api-location "examples/cli-examples/spec-examples/openai.json" --environment-id public
az apic api register -g api-center-test -n contosoeuap --api-location "examples/cli-examples/spec-examples/openai.yml" --environment-id public

Registrieren Sie die API, indem Sie die Spezifikations-URL angeben.

az apic api register -g api-center-test -n contosoeuap --api-location "https://petstore.swagger.io/v2/swagger.json" --environment-id public
az apic api register -g api-center-test -n contosoeuap --api-location "https://petstore.swagger.io/v2/swagger.yaml" --environment-id public

Erforderliche Parameter

--api-location -l

Speicherort der Spezifikationsdatei.

--resource-group -g

Ressourcengruppenname.

--service-name -n

APICenter-Katalog oder Dienstname.

Optionale Parameter

--environment-id

Id der zuvor erstellten Umgebung.

Globale Parameter
--debug

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

--help -h

Diese Hilfenachricht anzeigen und beenden.

--only-show-errors

Nur Fehler anzeigen, 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

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.

az apic api show

Rufen Sie Details der API ab.

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

Beispiele

API-Details anzeigen

az apic api show -g contoso-resources -n contoso --api-id echo-api

Optionale Parameter

--api-id

Die ID der API.

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

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

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

Globale Parameter
--debug

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

--help -h

Diese Hilfenachricht anzeigen und beenden.

--only-show-errors

Nur Fehler anzeigen, 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

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.

az apic api update

Vorhandene API aktualisieren.

az apic api update [--add]
                   [--api-id]
                   [--contacts]
                   [--custom-properties]
                   [--description]
                   [--external-documentation]
                   [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                   [--ids]
                   [--license]
                   [--remove]
                   [--resource-group]
                   [--service-name]
                   [--set]
                   [--subscription]
                   [--summary]
                   [--title]
                   [--type {graphql, grpc, rest, soap, webhook, websocket}]

Beispiele

Update-API

az apic api update -g contoso-resources -n contoso --api-id echo-api --summary "Basic REST API service"

Aktualisieren benutzerdefinierter Eigenschaften

az apic api update -g contoso-resources -n contoso --api-id echo-api --custom-properties '{"public-facing":true}'

Aktualisieren von benutzerdefinierten Eigenschaften mithilfe der JSON-Datei

az apic api update -g contoso-resources -n contoso --api-id echo-api --custom-properties '@customProperities.json'

Aktualisieren einzelner benutzerdefinierter Metadaten

az apic api update -g contoso-resources -n contoso --api-id echo-api --set customProperties.internal=false

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.

--contacts

Die Kontaktinformationen für die API. Unterstützung von Shorthand-Syntax, JSON-Datei und Yaml-Datei. Probieren Sie "??" aus, um mehr anzuzeigen.

--custom-properties

Die benutzerdefinierten Metadaten, die für API-Katalogentitäten definiert sind. Unterstützen Sie json-file und yaml-file.

--description

Beschreibung der API.

--external-documentation

Zusätzliche, externe Dokumentation für die API. Unterstützung von Shorthand-Syntax, JSON-Datei und Yaml-Datei. Probieren Sie "??" aus, um mehr anzuzeigen.

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

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.

--license

Die Lizenzinformationen für die API. Unterstützung von Shorthand-Syntax, JSON-Datei und Yaml-Datei. Probieren Sie "??" aus, um mehr anzuzeigen.

--remove

Entfernen sie eine Eigenschaft oder ein Element aus einer Liste. Beispiel: --remove property.list <indexToRemove> ODER --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=<value>.

--subscription

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

--summary

Kurze Beschreibung der API.

--title

API-Titel.

--type

API-Typ.

Zulässige Werte: graphql, grpc, rest, soap, webhook, websocket
Globale Parameter
--debug

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

--help -h

Diese Hilfenachricht anzeigen und beenden.

--only-show-errors

Nur Fehler anzeigen, 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

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.