az apim api

  • Reference

Správa rozhraní API služby Azure API Management

Příkazy

Name Description Typ Stav
az apim api create

Vytvořte rozhraní API služby API Management.

 Základ GA
az apim api delete

Odstraňte rozhraní API služby API Management.

 Základ GA
az apim api export

Exportujte rozhraní API služby API Management.

 Základ GA
az apim api import

Importujte rozhraní API služby API Management.

 Základ GA
az apim api list

Uveďte seznam rozhraní API služby API Management.

 Základ GA
az apim api operation

Správa operací rozhraní API služby Azure API Management

 Základ GA
az apim api operation create

Vytvoří novou operaci v rozhraní API.

 Základ GA
az apim api operation delete

Odstraní zadanou operaci v rozhraní API.

 Základ GA
az apim api operation list

Vypíše kolekci operací pro zadané rozhraní API.

 Základ GA
az apim api operation show

Získá podrobnosti operace rozhraní API určené jeho identifikátorem.

 Základ GA
az apim api operation update

Aktualizace podrobnosti operace v rozhraní API určeném jeho identifikátorem.

 Základ GA
az apim api release

Správa verze rozhraní API služby Azure API Management

 Základ GA
az apim api release create

Vytvoří novou verzi pro rozhraní API.

 Základ GA
az apim api release delete

Odstraní zadanou verzi v rozhraní API.

 Základ GA
az apim api release list

Zobrazí seznam všech verzí rozhraní API.

 Základ GA
az apim api release show

Vrátí podrobnosti verze rozhraní API.

 Základ GA
az apim api release update

Aktualizace podrobnosti o vydání rozhraní API určeného jeho identifikátorem.

 Základ GA
az apim api revision

Správa revize rozhraní API služby Azure API Management

 Základ GA
az apim api revision create

Vytvoření revize rozhraní API

 Základ GA
az apim api revision list

Zobrazí seznam všech revizí rozhraní API.

 Základ GA
az apim api schema

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

 Základ GA
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 show

Zobrazení podrobností o rozhraní API služby API Management

 Základ GA
az apim api update

Aktualizujte rozhraní API služby API Management.

 Základ GA
az apim api versionset

Správa sady verzí rozhraní API služby Azure API Management

 Základ GA
az apim api versionset create

Vytvoří sadu verzí rozhraní API.

 Základ GA
az apim api versionset delete

Odstraní konkrétní sadu verzí rozhraní API.

 Základ GA
az apim api versionset list

Vypíše kolekci sad verzí rozhraní API v zadané instanci služby.

 Základ GA
az apim api versionset show

Získá podrobnosti o sadě verzí rozhraní API určené jeho identifikátorem.

 Základ GA
az apim api versionset update

Aktualizace podrobnosti o sadě verzí rozhraní API určené identifikátorem.

 Základ GA
az apim api wait

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

 Základ GA

az apim api create

Upravit

Vytvořte rozhraní API služby API Management.

az apim api create --api-id
                   --display-name
                   --path
                   --resource-group
                   --service-name
                   [--api-type {graphql, http, soap, websocket}]
                   [--authorization-scope]
                   [--authorization-server-id]
                   [--bearer-token-sending-methods]
                   [--description]
                   [--no-wait]
                   [--open-id-provider-id]
                   [--protocols {http, https, ws, wss}]
                   [--service-url]
                   [--subscription-key-header-name]
                   [--subscription-key-query-param-name]
                   [--subscription-key-required]
                   [--subscription-required {false, true}]

Příklady

Vytvořte základní rozhraní API.

az apim api create --service-name MyApim -g MyResourceGroup --api-id MyApi --path '/myapi' --display-name 'My API'

Povinné parametry

--api-id

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

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.

--display-name

Zobrazovaný název rozhraní API, které se má vytvořit.

--path

Cesta k rozhraní API

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

--api-type

Typ rozhraní API.

přijímané hodnoty: graphql, http, soap, websocket
--authorization-scope

Určuje obor operací OAuth.

--authorization-server-id

Určuje ID autorizačního serveru OAuth.

--bearer-token-sending-methods

Určuje metody odesílání nosné tokeny.

--description

Popis rozhraní API Může obsahovat značky formátování HTML.

--no-wait

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

výchozí hodnota: False
--open-id-provider-id

Určuje openid v nastavení ověřování.

--protocols

Popisuje, na kterých protokolech lze vyvolat operace v tomto rozhraní API.

přijímané hodnoty: http, https, ws, wss
--service-url

Absolutní adresa URL back-endové služby, která toto rozhraní API implementuje. Nesmí být delší než 2 000 znaků.

--subscription-key-header-name

Určuje název hlavičky klíče předplatného.

--subscription-key-query-param-name

Určuje název parametru řetězce dotazu klíče předplatného.

--subscription-key-required

Určuje, jestli se klíč předplatného vyžaduje během volání tohoto rozhraní API, true – rozhraní API je zahrnuto pouze do uzavřených produktů, nepravda – rozhraní API je zahrnuto do samotných otevřených produktů, null – existuje kombinace produktů.

--subscription-required

Pokud je pravda, rozhraní API vyžaduje klíč předplatného pro požadavky.

přijímané hodnoty: false, true
výchozí hodnota: 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řijímané hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
výchozí hodnota: 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 delete

Upravit

Odstraňte rozhraní API služby API Management.

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

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

--delete-revisions

Odstraňte všechny revize rozhraní API.

--if-match

ETag of the Entity.

--no-wait

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

výchozí hodnota: False
--yes -y

Nezotvádejte výzvu k potvrzení.

výchozí hodnota: 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řijímané hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
výchozí hodnota: 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 export

Upravit

Exportujte rozhraní API služby API Management.

az apim api export --api-id
                   --ef {OpenApiJsonFile, OpenApiJsonUrl, OpenApiYamlFile, OpenApiYamlUrl, SwaggerFile, SwaggerUrl, WadlFile, WadlUrl, WsdlFile, WsdlUrl}
                   --resource-group
                   --service-name
                   [--file-path]

Příklady

Exportujte rozhraní API služby API Management do souboru nebo vrátí odpověď obsahující odkaz na export.

az apim api export -g MyResourceGroup --service-name MyApim --api-id MyApi --export-format OpenApiJson --file-path path

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. Vzor regulárního výrazu: ^[^*#&+:<>?] +$.

--ef --export-format

Zadejte formát rozhraní API pro export.

přijímané hodnoty: OpenApiJsonFile, OpenApiJsonUrl, OpenApiYamlFile, OpenApiYamlUrl, SwaggerFile, SwaggerUrl, WadlFile, WadlUrl, WsdlFile, WsdlUrl
--resource-group -g

Název skupiny zdrojů. Název nerozlišuje malá a velká písmena.

--service-name -n

Název instance služby API Management.

Volitelné parametry

--file-path -f

Cesta k souboru zadaná k exportu rozhraní API.

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řijímané hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
výchozí hodnota: 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 import

Upravit

Importujte rozhraní API služby API Management.

az apim api import --path
                   --resource-group
                   --service-name
                   --specification-format {GraphQL, OpenApi, OpenApiJson, Swagger, Wadl, Wsdl}
                   [--api-id]
                   [--api-revision]
                   [--api-type {graphql, http, soap, websocket}]
                   [--api-version]
                   [--api-version-set-id]
                   [--description]
                   [--display-name]
                   [--no-wait]
                   [--protocols {http, https, ws, wss}]
                   [--service-url]
                   [--soap-api-type]
                   [--specification-path]
                   [--specification-url]
                   [--subscription-key-header-name]
                   [--subscription-key-query-param-name]
                   [--subscription-required {false, true}]
                   [--wsdl-endpoint-name]
                   [--wsdl-service-name]

Příklady

Import rozhraní API Api Management ze souboru nebo adresy URL

az apim api import -g MyResourceGroup --service-name MyApim --path MyApi --specification-url https://MySpecificationURL --specification-format OpenApiJson

Povinné parametry

--path

Povinný: Relativní adresa URL jednoznačně identifikuje toto rozhraní API a všechny jeho cesty k prostředkům v rámci 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>.

--service-name -n

Název instance služby API Management.

--specification-format

Zadejte formát importovaného rozhraní API.

přijímané hodnoty: GraphQL, OpenApi, OpenApiJson, Swagger, Wadl, Wsdl

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

--api-revision

Popisuje revizi rozhraní API. Pokud není zadána žádná hodnota, vytvoří se výchozí revize 1.

--api-type

Typ rozhraní API.

přijímané hodnoty: graphql, http, soap, websocket
--api-version

Popisuje verzi rozhraní API. Pokud přidáte verzi do rozhraní API bez verzí, automaticky se vytvoří původní verze a odpoví na výchozí adresu URL.

--api-version-set-id

Popisuje sadu verzí, která se má použít s rozhraním API.

--description

Popis rozhraní API Může obsahovat značky formátování HTML.

--display-name

Zobrazovaný název tohoto rozhraní API

--no-wait

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

výchozí hodnota: False
--protocols

Popisuje, na kterých protokolech (jeden nebo více) je možné vyvolat operace v tomto rozhraní API.

přijímané hodnoty: http, https, ws, wss
--service-url

Absolutní adresa URL back-endové služby, která toto rozhraní API implementuje. Nesmí být delší než 2 000 znaků.

--soap-api-type

Typ rozhraní API, pokud je formát souboru WSDL.

--specification-path

Cesta k souboru zadaná pro import rozhraní API.

--specification-url

Adresa URL zadaná pro import rozhraní API.

--subscription-key-header-name

Určuje název hlavičky klíče předplatného.

--subscription-key-query-param-name

Určuje název parametru řetězce dotazu klíče předplatného.

--subscription-required

Pokud je pravda, rozhraní API vyžaduje klíč předplatného pro požadavky.

přijímané hodnoty: false, true
--wsdl-endpoint-name

Místní název koncového bodu WSDL (port), který se má importovat.

--wsdl-service-name

Místní název služby WSDL, která se má importovat.

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řijímané hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
výchozí hodnota: 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 list

Upravit

Uveďte seznam rozhraní API služby API Management.

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

Povinné parametry

--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řijímané hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
výchozí hodnota: 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 show

Upravit

Zobrazení podrobností o rozhraní API služby API Management

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

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á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řijímané hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
výchozí hodnota: 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 update

Upravit

Aktualizujte rozhraní API služby API Management.

az apim api update --api-id
                   --resource-group
                   --service-name
                   [--add]
                   [--api-type {graphql, http, soap, websocket}]
                   [--description]
                   [--display-name]
                   [--force-string]
                   [--if-match]
                   [--no-wait]
                   [--path]
                   [--protocols {http, https, ws, wss}]
                   [--remove]
                   [--service-url]
                   [--set]
                   [--subscription-key-header-name]
                   [--subscription-key-query-param-name]
                   [--subscription-required {false, true}]
                   [--tags]

Příklady

Vytvořte základní rozhraní API.

az apim api update --service-name MyApim -g MyResourceGroup --api-id MyApi --description foo

Povinné parametry

--api-id

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

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

--service-name -n

Název instance služby API Management.

Volitelné parametry

--add

Přidejte objekt do seznamu objektů zadáním párů cest a klíč-hodnota. Příklad: --add property.listProperty <key=value, string or JSON string>.

výchozí hodnota: []
--api-type

Typ rozhraní API.

přijímané hodnoty: graphql, http, soap, websocket
--description

Popis rozhraní API Může obsahovat značky formátování HTML.

--display-name

Název rozhraní API Musí mít délku 1 až 300 znaků.

--force-string

Při použití set nebo add zachovávejte řetězcové literály místo pokusu o převod na JSON.

výchozí hodnota: False
--if-match

ETag of the Entity. Při vytváření entity se nevyžaduje, ale vyžaduje se při aktualizaci entity. Výchozí hodnota je None.

--no-wait

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

výchozí hodnota: False
--path

Povinný: Relativní adresa URL jednoznačně identifikuje toto rozhraní API a všechny jeho cesty k prostředkům v rámci instance služby API Management.

--protocols

Popisuje, na kterých protokolech lze vyvolat operace v tomto rozhraní API.

přijímané hodnoty: http, https, ws, wss
--remove

Odeberte vlastnost nebo prvek ze seznamu. Příklad: --remove property.list <indexToRemove> OR --remove propertyToRemove.

výchozí hodnota: []
--service-url

Absolutní adresa URL back-endové služby, která toto rozhraní API implementuje. Nesmí být delší než 2 000 znaků.

--set

Aktualizujte objekt zadáním cesty vlastnosti a hodnoty, která se má nastavit. Příklad: --set property1.property2=<value>.

výchozí hodnota: []
--subscription-key-header-name

Určuje název hlavičky klíče předplatného.

--subscription-key-query-param-name

Určuje název parametru řetězce dotazu klíče předplatného.

--subscription-required

Pokud je pravda, rozhraní API vyžaduje klíč předplatného pro požadavky.

přijímané hodnoty: false, true
--tags

Značky oddělené mezerami: klíč[=hodnota] [klíč[=hodnota] ...]. K vymazání existujících značek použijte "".

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řijímané hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
výchozí hodnota: 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 wait

Upravit

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

az apim api wait --api-id
                 --name
                 --resource-group
                 [--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 rozhraní APIm. (automaticky vygenerováno)

az apim api wait --created --api-id MyApi --name MyApim --resource-group 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. Povinný:

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

Volitelné parametry

--created

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

výchozí hodnota: 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í.

výchozí hodnota: False
--exists

Počkejte, až prostředek existuje.

výchozí hodnota: False
--interval

Interval dotazování v sekundách

výchozí hodnota: 30
--timeout

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

výchozí hodnota: 3600
--updated

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

výchozí hodnota: 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řijímané hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
výchozí hodnota: 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.