Share via

az apic api

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

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

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

az apic api create --api-id
                   --resource-group
                   --service
                   --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 -s contoso --api-id echo-api --title "Echo API" --type REST

Erstellen einer API mit benutzerdefinierten Eigenschaften

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

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 --service-name -s

Der Name des API Center-Diensts.

--title

API-Titel.

--type

Art der API.

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

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 delete

Löscht die angegebene API.

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

Beispiele

API löschen

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

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 --service-name -s

Der Name des 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.

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

Auflisten einer Sammlung von APIs.

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

Beispiele

Auflisten von APIs

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

Erforderliche Parameter

--resource-group -g

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

--service --service-name -s

Der Name des 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 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.

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

Beispiele

Registrieren Sie die API, indem Sie die Spezifikationsdatei angeben.

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

Erforderliche Parameter

--api-location -l

Speicherort der Spezifikationsdatei.

--resource-group -g

Ressourcengruppenname

--service -s

APICenter-Katalog oder Dienstname.

Optionale Parameter

--environment-name -e

Name der zuvor erstellten Umgebung.

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 show

Rufen Sie Details der API ab.

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

Beispiele

API-Details anzeigen

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

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 --service-name -s

Der Name des 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 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]
                   [--set]
                   [--subscription]
                   [--summary]
                   [--title]
                   [--type {graphql, grpc, rest, soap, webhook, websocket}]

Beispiele

Update-API

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

Aktualisieren benutzerdefinierter Eigenschaften

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

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

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.

--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 OR --remove propertyToRemove.

--resource-group -g

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

--service --service-name -s

Der Name des 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.

--summary

Kurze Beschreibung der API.

--title

API-Titel.

--type

Art der API.

Zulässige Werte: graphql, grpc, rest, soap, webhook, websocket
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.