Sdílet prostřednictvím

az apim api schema

  • Reference

Správa schématu rozhraní API služby Azure API Management

Příkazy

Name Description Typ Stav
az apim api schema create

Vytvoření schématu rozhraní API služby API Management

 Základ GA
az apim api schema delete

Odstraňte schéma rozhraní API služby API Management.

 Základ GA
az apim api schema get-etag

Získejte etag schématu rozhraní API služby API Management.

 Základ GA
az apim api schema list

Výpis schématu rozhraní API služby API Management

 Základ GA
az apim api schema show

Zobrazení podrobností schématu rozhraní API služby API Management

 Základ GA
az apim api schema wait

Umístěte rozhraní příkazového řádku do stavu čekání, dokud nebude splněna podmínka schématu rozhraní APIm.

 Základ GA

az apim api schema create

Upravit

Vytvoření schématu rozhraní API služby API Management

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]

Příklady

Vytvoření schématu rozhraní API

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

Povinné parametry

--api-id

Jedinečný název rozhraní API, pro které je potřeba vytvořit schéma.

Identifikátor revize rozhraní API. V aktuální instanci služby API Management musí být jedinečné. Revize, která není aktuální, má ; rev=n jako přípona, kde n je číslo revize.

--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--schema-id

Jedinečný název schématu rozhraní API, které se má vytvořit.

Identifikátor schématu. V aktuální instanci služby API Management musí být jedinečné.

--schema-type

Typ schématu (např. application/json, application/vnd.ms-azure-apim.graphql.schema).

Musí být platný typ média použitý v hlavičce Content-Type, jak je definováno v dokumentu RFC 2616. Typ média dokumentu schématu.

--service-name -n

Název instance služby API Management.

Volitelné parametry

--no-wait

Nečekejte na dokončení dlouhotrvající operace.

Default value: False
--resource-type

Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts.

--schema-content

Řídicí řetězec JSON definující dokument představující schéma.

Zadejte buď --schema-path, nebo --schema-content, nikoli oba.

--schema-name

Název prostředku schématu.

--schema-path

Cesta k souboru zadaná pro import schématu rozhraní API.

Zadejte buď --schema-path, nebo --schema-content, nikoli oba.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az apim api schema delete

Upravit

Odstraňte schéma rozhraní API služby API Management.

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

Příklady

odstranění schématu rozhraní API

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

Povinné parametry

--api-id

Identifikátor rozhraní API. V aktuální instanci služby API Management musí být jedinečné. Revize, která není aktuální, má ; rev=n jako přípona, kde n je číslo revize.

--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--schema-id

Identifikátor schématu. V aktuální instanci služby API Management musí být jedinečné. Revize, která není aktuální, má ; rev=n jako přípona, kde n je číslo revize.

--service-name -n

Název instance služby API Management.

Volitelné parametry

--if-match

ETag of the Entity.

--no-wait

Nečekejte na dokončení dlouhotrvající operace.

Default value: False
--yes -y

Nezotvádejte výzvu k potvrzení.

Default value: False
Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az apim api schema get-etag

Upravit

Získejte etag schématu rozhraní API služby API Management.

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

Příklady

získání značky entity schématu

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

Povinné parametry

--api-id

Identifikátor rozhraní API. V aktuální instanci služby API Management musí být jedinečné. Revize, která není aktuální, má ; rev=n jako přípona, kde n je číslo revize.

--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--schema-id

Identifikátor schématu. V aktuální instanci služby API Management musí být jedinečné. Revize, která není aktuální, má ; rev=n jako přípona, kde n je číslo revize.

--service-name -n

Název instance služby API Management.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az apim api schema list

Upravit

Výpis schématu rozhraní API služby API Management

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

Příklady

Získejte seznam schématu přidružených k ID rozhraní API.

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

Povinné parametry

--api-id

Identifikátor rozhraní API. V aktuální instanci služby API Management musí být jedinečné. Revize, která není aktuální, má ; rev=n jako přípona, kde n je číslo revize.

--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--service-name -n

Název instance služby API Management.

Volitelné parametry

--filter-display-name

Filtr rozhraní API podle displayName

--skip

Počet záznamů, které se mají přeskočit

--top

Počet vrácených záznamů.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az apim api schema show

Upravit

Zobrazení podrobností schématu rozhraní API služby API Management

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

Příklady

Získejte schéma rozhraní API.

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

Povinné parametry

--api-id

Identifikátor rozhraní API. V aktuální instanci služby API Management musí být jedinečné. Revize, která není aktuální, má ; rev=n jako přípona, kde n je číslo revize.

--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--schema-id

Identifikátor schématu. V aktuální instanci služby API Management musí být jedinečné. Revize, která není aktuální, má ; rev=n jako přípona, kde n je číslo revize.

--service-name -n

Název instance služby API Management.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az apim api schema wait

Upravit

Umístěte rozhraní příkazového řádku do stavu čekání, dokud nebude splněna podmínka schématu rozhraní APIm.

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

Příklady

Umístěte rozhraní příkazového řádku do stavu čekání, dokud nebude splněna podmínka schématu rozhraní APIm.

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

Povinné parametry

--api-id

Identifikátor revize rozhraní API. V aktuální instanci služby API Management musí být jedinečné. Revize, která není aktuální, má ; rev=n jako přípona, kde n je číslo revize. Požadováno.

--name -n

Název instance služby API Management.

--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--schema-id

Identifikátor ID schématu. V aktuální instanci služby API Management musí být jedinečné. Požadováno.

Volitelné parametry

--created

Počkejte na vytvoření s 'provisioningState' v 'Succeeded'.

Default value: False
--custom

Počkejte, až podmínka splňuje vlastní dotaz JMESPath. Například provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Počkejte na odstranění.

Default value: False
--exists

Počkejte, až prostředek existuje.

Default value: False
--interval

Interval dotazování v sekundách

Default value: 30
--timeout

Maximální čekání v sekundách.

Default value: 3600
--updated

Počkejte, dokud se neaktualizuje stav zřizování ve stavu Úspěch.

Default value: False
Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.