Freigeben über

az apim api schema

  • Referenz

Verwalten sie die Schemas der Azure API-Verwaltungs-API.

Befehle

Name Beschreibung Typ Status
az apim api schema create

Erstellen Sie ein API-Verwaltungs-API-Schema.

 Kernspeicher Allgemein verfügbar
az apim api schema delete

Löschen Eines API-Verwaltungs-API-Schemas.

 Kernspeicher Allgemein verfügbar
az apim api schema get-etag

Abrufen eines Etags eines API-Verwaltungs-API-Schemas.

 Kernspeicher Allgemein verfügbar
az apim api schema list

Api-Verwaltungs-API-Schemas auflisten.

 Kernspeicher Allgemein verfügbar
az apim api schema show

Details eines API-Verwaltungs-API-Schemas anzeigen.

 Kernspeicher Allgemein verfügbar
az apim api schema wait

Platzieren Sie die CLI in einem Wartezustand, bis eine Bedingung eines APIM-API-Schemas erfüllt ist.

 Kernspeicher Allgemein verfügbar

az apim api schema create

Bearbeiten

Erstellen Sie ein API-Verwaltungs-API-Schema.

az apim api schema create --api-id
                          --resource-group
                          --schema-id
                          --schema-type
                          --service-name
                          [--no-wait]
                          [--resource-type]
                          [--schema-content]
                          [--schema-name]
                          [--schema-path]

Beispiele

Erstellen Sie ein API-Schema.

az apim api schema create --service-name MyApim -g MyResourceGroup --api-id MyApi --schema-id schemaId --schema-type schemaType --schema-path schemaFilePath

Erforderliche Parameter

--api-id

Eindeutiger Name der API, für die das Schema erstellt werden muss.

API-Revisionsbezeichner. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein. Die nicht aktuelle Überarbeitung hat ; rev=n als Suffix, wobei n die Revisionsnummer ist.

--resource-group -g

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

--schema-id

Eindeutiger Name des zu erstellenden API-Schemas.

Schemabezeichner. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein.

--schema-type

Schematyp (z. B. application/json, application/vnd.ms-azure-apim.graphql.schema).

Muss ein gültiger Medientyp sein, der in einem Content-Type-Header verwendet wird, wie in RFC 2616 definiert. Medientyp des Schemadokuments.

--service-name -n

Der Name der API-Verwaltungsdienstinstanz.

Optionale Parameter

--no-wait

Nicht auf den Abschluss lang andauernder Vorgänge warten

Standardwert: False
--resource-type

Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts".

--schema-content

Json-Escapezeichenfolge, die das Dokument definiert, das das Schema darstellt.

Geben Sie entweder --schema-path oder --schema-content nicht beides an.

--schema-name

Der Name der Schemaressource.

--schema-path

Dateipfad, der zum Importieren des Schemas der API angegeben wurde.

Geben Sie entweder --schema-path oder --schema-content nicht beides an.

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 apim api schema delete

Bearbeiten

Löschen Eines API-Verwaltungs-API-Schemas.

az apim api schema delete --api-id
                          --resource-group
                          --schema-id
                          --service-name
                          [--if-match]
                          [--no-wait]
                          [--yes]

Beispiele

löschen Sie ein API-Schema.

az apim api schema delete --service-name MyApim -g MyResourceGroup --api-id MyApi --schema-id schemaId

Erforderliche Parameter

--api-id

API-ID. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein. Die nicht aktuelle Überarbeitung hat ; rev=n als Suffix, wobei n die Revisionsnummer ist.

--resource-group -g

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

--schema-id

Schemabezeichner. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein. Die nicht aktuelle Überarbeitung hat ; rev=n als Suffix, wobei n die Revisionsnummer ist.

--service-name -n

Der Name der API-Verwaltungsdienstinstanz.

Optionale Parameter

--if-match

ETag der Entität.

--no-wait

Nicht auf den Abschluss lang andauernder Vorgänge warten

Standardwert: False
--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 apim api schema get-etag

Bearbeiten

Abrufen eines Etags eines API-Verwaltungs-API-Schemas.

az apim api schema get-etag --api-id
                            --resource-group
                            --schema-id
                            --service-name

Beispiele

abrufen eines Schemaentitätstags.

az apim api schema get-etag --service-name MyApim -g MyResourceGroup --api-id MyApi --schema-id schemaId

Erforderliche Parameter

--api-id

API-ID. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein. Die nicht aktuelle Überarbeitung hat ; rev=n als Suffix, wobei n die Revisionsnummer ist.

--resource-group -g

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

--schema-id

Schemabezeichner. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein. Die nicht aktuelle Überarbeitung hat ; rev=n als Suffix, wobei n die Revisionsnummer ist.

--service-name -n

Der Name der API-Verwaltungsdienstinstanz.

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 apim api schema list

Bearbeiten

Api-Verwaltungs-API-Schemas auflisten.

az apim api schema list --api-id
                        --resource-group
                        --service-name
                        [--filter-display-name]
                        [--skip]
                        [--top]

Beispiele

Dient zum Abrufen einer Liste der Schemas, die einer API-ID zugeordnet sind.

az apim api schema list --service-name MyApim -g MyResourceGroup --api-id MyApi

Erforderliche Parameter

--api-id

API-ID. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein. Die nicht aktuelle Überarbeitung hat ; rev=n als Suffix, wobei n die Revisionsnummer ist.

--resource-group -g

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

--service-name -n

Der Name der API-Verwaltungsdienstinstanz.

Optionale Parameter

--filter-display-name

Filter von APIs nach displayName.

--skip

Anzahl der zu überspringenden Datensätze.

--top

Die Anzahl der zurückzugebenden Datensätze.

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 apim api schema show

Bearbeiten

Details eines API-Verwaltungs-API-Schemas anzeigen.

az apim api schema show --api-id
                        --resource-group
                        --schema-id
                        --service-name

Beispiele

Rufen Sie ein API-Schema ab.

az apim api schema show --service-name MyApim -g MyResourceGroup --api-id MyApi --schema-id schemaId

Erforderliche Parameter

--api-id

API-ID. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein. Die nicht aktuelle Überarbeitung hat ; rev=n als Suffix, wobei n die Revisionsnummer ist.

--resource-group -g

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

--schema-id

Schemabezeichner. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein. Die nicht aktuelle Überarbeitung hat ; rev=n als Suffix, wobei n die Revisionsnummer ist.

--service-name -n

Der Name der API-Verwaltungsdienstinstanz.

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 apim api schema wait

Bearbeiten

Platzieren Sie die CLI in einem Wartezustand, bis eine Bedingung eines APIM-API-Schemas erfüllt ist.

az apim api schema wait --api-id
                        --name
                        --resource-group
                        --schema-id
                        [--created]
                        [--custom]
                        [--deleted]
                        [--exists]
                        [--interval]
                        [--timeout]
                        [--updated]

Beispiele

Platzieren Sie die CLI in einem Wartezustand, bis eine Bedingung eines APIM-API-Schemas erfüllt ist.

az apim api schema wait --created --api-id MyApi --name MyApim --schema-id schemaId -g MyResourceGroup

Erforderliche Parameter

--api-id

API-Revisionsbezeichner. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein. Die nicht aktuelle Überarbeitung hat ; rev=n als Suffix, wobei n die Revisionsnummer ist. Erforderlich.

--name -n

Der Name der API-Verwaltungsdienstinstanz.

--resource-group -g

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

--schema-id

Schema-ID-ID-ID. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein. Erforderlich.

Optionale Parameter

--created

Warten Sie, bis sie mit 'provisioningState' unter 'Succeeded' erstellt wurde.

Standardwert: False
--custom

Warten Sie, bis die Bedingung eine benutzerdefinierte JMESPath-Abfrage erfüllt. Beispiel: provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Warten Sie, bis sie gelöscht wurde.

Standardwert: False
--exists

Warten Sie, bis die Ressource vorhanden ist.

Standardwert: False
--interval

Abrufintervall in Sekunden.

Standardwert: 30
--timeout

Maximale Wartezeit in Sekunden.

Standardwert: 3600
--updated

Warten Sie, bis sie mit provisioningState unter 'Succeeded' aktualisiert wurde.

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.