az apic api

Reference

Poznámka

Tento odkaz je součástí rozšíření apic-extension pro Azure CLI (verze 2.57.0 nebo vyšší). Rozšíření se automaticky nainstaluje při prvním spuštění příkazu az apic api. Další informace o rozšířeních.

Příkazy pro správu rozhraní API v centru API.

Příkazy

Name	Description	Typ	Stav
az apic api create	Zaregistrujte nové rozhraní API nebo aktualizujte existující rozhraní API.	Prodloužení	GHANŠTINA
az apic api definition	Příkazy pro správu definic rozhraní API v centru API.	Prodloužení	GHANŠTINA
az apic api definition create	Vytvořte novou definici rozhraní API nebo aktualizujte existující definici rozhraní API.	Prodloužení	GHANŠTINA
az apic api definition delete	Odstraňte zadanou definici rozhraní API.	Prodloužení	GHANŠTINA
az apic api definition export-specification	Exportuje specifikaci rozhraní API.	Prodloužení	GHANŠTINA
az apic api definition import-specification	Importuje specifikaci rozhraní API.	Prodloužení	GHANŠTINA
az apic api definition list	Vypíše kolekci definic rozhraní API.	Prodloužení	GHANŠTINA
az apic api definition show	Získejte podrobnosti o definici rozhraní API.	Prodloužení	GHANŠTINA
az apic api definition update	Aktualizujte existující definici rozhraní API.	Prodloužení	GHANŠTINA
az apic api delete	Odstranění zadaného rozhraní API	Prodloužení	GHANŠTINA
az apic api deployment	Příkazy pro správu nasazení rozhraní API v centru API.	Prodloužení	GHANŠTINA
az apic api deployment create	Vytvořte nové nasazení rozhraní API nebo aktualizujte existující nasazení rozhraní API.	Prodloužení	GHANŠTINA
az apic api deployment delete	Odstranění nasazení rozhraní API	Prodloužení	GHANŠTINA
az apic api deployment list	Vypíše kolekci nasazení rozhraní API.	Prodloužení	GHANŠTINA
az apic api deployment show	Získejte podrobnosti o nasazení rozhraní API.	Prodloužení	GHANŠTINA
az apic api deployment update	Aktualizujte existující nasazení rozhraní API.	Prodloužení	GHANŠTINA
az apic api list	Vypíše kolekci rozhraní API.	Prodloužení	GHANŠTINA
az apic api register	Zaregistruje nové rozhraní API s verzí, definicí a přidruženými nasazeními pomocí souboru specifikace jako zdroje pravdy. Prozatím podporujeme jenom formát JSON/YAML OpenAPI.	Prodloužení	Náhled
az apic api show	Získejte podrobnosti o rozhraní API.	Prodloužení	GHANŠTINA
az apic api update	Aktualizujte existující rozhraní API.	Prodloužení	GHANŠTINA
az apic api version	Příkazy pro správu verzí rozhraní API v Centru rozhraní API	Prodloužení	GHANŠTINA
az apic api version create	Vytvořte novou verzi rozhraní API nebo aktualizujte existující verzi rozhraní API.	Prodloužení	GHANŠTINA
az apic api version delete	Odstraňte zadanou verzi rozhraní API.	Prodloužení	GHANŠTINA
az apic api version list	Vypíše kolekci verzí rozhraní API.	Prodloužení	GHANŠTINA
az apic api version show	Získejte podrobnosti o verzi rozhraní API.	Prodloužení	GHANŠTINA
az apic api version update	Aktualizujte stávající verzi rozhraní API.	Prodloužení	GHANŠTINA

az apic api create

Zaregistrujte nové rozhraní API nebo aktualizujte existující rozhraní 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]

Příklady

Vytvoření rozhraní API

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

Vytvoření rozhraní API s vlastními vlastnostmi

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

Vytvoření rozhraní API s vlastními vlastnostmi pomocí souboru JSON

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

Povinné parametry

--api-id

ID 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 služby Azure API Center.

--title

Název rozhraní API.

--type

Typ rozhraní API

Přípustné hodnoty: graphql, grpc, rest, soap, webhook, websocket

Volitelné parametry

--contacts

Kontaktní informace pro rozhraní API. Podpora zkratky syntaxe, json-file a yaml-file Zkuste "??" zobrazit více.

--custom-properties

Vlastní metadata definovaná pro entity katalogu rozhraní API. Podpora souborů json a yaml-file

--description

Popis rozhraní API

--external-documentation

Další externí dokumentace k rozhraní API Podpora zkratky syntaxe, json-file a yaml-file Zkuste "??" zobrazit více.

--license

Informace o licenci pro rozhraní API. Podpora zkratky syntaxe, json-file a yaml-file Zkuste "??" zobrazit více.

--summary

Krátký popis 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řípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

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

--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 apic api delete

Odstranění zadaného rozhraní API

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

Příklady

Odstranění rozhraní API

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

Volitelné parametry

--api-id

ID rozhraní API.

--ids

Jedno nebo více ID prostředků (oddělených mezerami) Mělo by se jednat o úplné ID prostředku obsahující všechny informace o argumentech ID prostředku. Měli byste zadat argumenty --ids nebo jiné argumenty ID prostředku.

--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 služby Azure API Center.

--subscription

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

--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ší informace a příklady najdete v http://jmespath.org/.

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

Vypíše kolekci rozhraní API.

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

Příklady

Výpis rozhraní API

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

Výpis rozhraní API s filtrem

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

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 služby Azure API Center.

Volitelné parametry

--filter

Parametr filtru OData.

--max-items

Celkový počet položek, které se mají vrátit ve výstupu příkazu Pokud je celkový počet dostupných položek větší než zadaná hodnota, zobrazí se ve výstupu příkazu token. Pokud chcete pokračovat ve stránkování, zadejte hodnotu tokenu v --next-token argumentu následného příkazu.

--next-token

Token určující, kde se má stránkování spustit. Toto je hodnota tokenu z dříve zkrácené odpovědi.

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ší informace a příklady najdete v http://jmespath.org/.

--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 apic api register

Preview

Tento příkaz je ve verzi Preview a ve vývoji. Referenční úrovně a úrovně podpory: https://aka.ms/CLI_refstatus

Zaregistruje nové rozhraní API s verzí, definicí a přidruženými nasazeními pomocí souboru specifikace jako zdroje pravdy. Prozatím podporujeme jenom formát JSON/YAML OpenAPI.

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

Příklady

Zaregistrujte rozhraní API zadáním souboru specifikace.

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

Zaregistrujte rozhraní API zadáním adresy URL specifikace.

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

Povinné parametry

--api-location -l

Umístění souboru specifikace.

--resource-group -g

Název skupiny prostředků

--service-name -n

Katalog rozhraní APICenter nebo název služby.

Volitelné parametry

--environment-id

ID prostředí vytvořeného dříve.

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ší informace a příklady najdete v http://jmespath.org/.

--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 apic api show

Získejte podrobnosti o rozhraní API.

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

Příklady

Zobrazení podrobností rozhraní API

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

Volitelné parametry

--api-id

ID rozhraní API.

--ids

--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 služby Azure API Center.

--subscription

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

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ší informace a příklady najdete v http://jmespath.org/.

--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 apic api update

Aktualizujte existující rozhraní API.

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

Příklady

Aktualizace rozhraní API

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

Aktualizace vlastních vlastností

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

Aktualizace vlastních vlastností pomocí souboru JSON

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

Aktualizace jednotlivých vlastních metadat

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

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

--api-id

ID rozhraní API.

--contacts

Kontaktní informace pro rozhraní API. Podpora zkratky syntaxe, json-file a yaml-file Zkuste "??" zobrazit více.

--custom-properties

Vlastní metadata definovaná pro entity katalogu rozhraní API. Podpora souborů json a yaml-file

--description

Popis rozhraní API

--external-documentation

Další externí dokumentace k rozhraní API Podpora zkratky syntaxe, json-file a yaml-file Zkuste "??" zobrazit více.

--force-string

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

Přípustné hodnoty: 0, 1, f, false, n, no, t, true, y, yes

--ids

--license

Informace o licenci pro rozhraní API. Podpora zkratky syntaxe, json-file a yaml-file Zkuste "??" zobrazit více.

--remove

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

--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 služby Azure API Center.

--set

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

--subscription

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

--summary

Krátký popis rozhraní API

--title

Název rozhraní API.

--type

Typ rozhraní API

Přípustné hodnoty: graphql, grpc, rest, soap, webhook, websocket

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ší informace a příklady najdete v http://jmespath.org/.

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

Sdílet prostřednictvím

az apic api

Příkazy

az apic api create

Příklady

Povinné parametry

Volitelné parametry

az apic api delete

Příklady

Volitelné parametry

az apic api list

Příklady

Povinné parametry

Volitelné parametry

az apic api register

Příklady

Povinné parametry

Volitelné parametry

az apic api show

Příklady

Volitelné parametry

az apic api update

Příklady

Volitelné parametry

Další materiály