az apic

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 . Přečtěte si další informace o rozšířeních.

Správa služeb Azure API Center

Příkazy

Name	Description	Typ	Stav
az apic api	Příkazy pro správu rozhraní API v centru API.	Rozšíření	GA
az apic api create	Zaregistrujte nové rozhraní API nebo aktualizujte existující rozhraní API.	Rozšíření	GA
az apic api definition	Příkazy pro správu definic rozhraní API v centru API.	Rozšíření	GA
az apic api definition create	Vytvořte novou definici rozhraní API nebo aktualizujte existující definici rozhraní API.	Rozšíření	GA
az apic api definition delete	Odstraňte zadanou definici rozhraní API.	Rozšíření	GA
az apic api definition export-specification	Exportuje specifikaci rozhraní API.	Rozšíření	GA
az apic api definition import-specification	Importuje specifikaci rozhraní API.	Rozšíření	GA
az apic api definition list	Vypíše kolekci definic rozhraní API.	Rozšíření	GA
az apic api definition show	Získejte podrobnosti o definici rozhraní API.	Rozšíření	GA
az apic api definition update	Aktualizujte existující definici rozhraní API.	Rozšíření	GA
az apic api delete	Odstranění zadaného rozhraní API	Rozšíření	GA
az apic api deployment	Příkazy pro správu nasazení rozhraní API v centru API.	Rozšíření	GA
az apic api deployment create	Vytvořte nové nasazení rozhraní API nebo aktualizujte existující nasazení rozhraní API.	Rozšíření	GA
az apic api deployment delete	Odstranění nasazení rozhraní API	Rozšíření	GA
az apic api deployment list	Vypíše kolekci nasazení rozhraní API.	Rozšíření	GA
az apic api deployment show	Získejte podrobnosti o nasazení rozhraní API.	Rozšíření	GA
az apic api deployment update	Aktualizujte existující nasazení rozhraní API.	Rozšíření	GA
az apic api list	Vypíše kolekci rozhraní API.	Rozšíření	GA
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.	Rozšíření	Preview
az apic api show	Získejte podrobnosti o rozhraní API.	Rozšíření	GA
az apic api update	Aktualizujte existující rozhraní API.	Rozšíření	GA
az apic api version	Příkazy pro správu verzí rozhraní API v Centru rozhraní API	Rozšíření	GA
az apic api version create	Vytvořte novou verzi rozhraní API nebo aktualizujte existující verzi rozhraní API.	Rozšíření	GA
az apic api version delete	Odstraňte zadanou verzi rozhraní API.	Rozšíření	GA
az apic api version list	Vypíše kolekci verzí rozhraní API.	Rozšíření	GA
az apic api version show	Získejte podrobnosti o verzi rozhraní API.	Rozšíření	GA
az apic api version update	Aktualizujte stávající verzi rozhraní API.	Rozšíření	GA
az apic create	Vytvoří instanci nebo aktualizuje existující instanci služby Azure API Center.	Rozšíření	GA
az apic delete	Odstraní instanci služby Azure API Center.	Rozšíření	GA
az apic environment	Příkazy pro správu prostředí ve službě API Center	Rozšíření	GA
az apic environment create	Vytvořte nové prostředí nebo aktualizujte existující prostředí.	Rozšíření	GA
az apic environment delete	Odstraňte prostředí.	Rozšíření	GA
az apic environment list	Vypíše kolekci prostředí.	Rozšíření	GA
az apic environment show	Získejte podrobnosti o prostředí.	Rozšíření	GA
az apic environment update	Aktualizujte existující prostředí.	Rozšíření	GA
az apic import-from-apim	Importuje rozhraní API z instance služby Azure API Management.	Rozšíření	GA
az apic list	Vypíše služby Azure API Center v rámci předplatného Azure.	Rozšíření	GA
az apic metadata	Příkazy pro správu schémat metadat v Centru rozhraní API	Rozšíření	GA
az apic metadata create	Vytvořte nové schéma metadat nebo aktualizujte existující schéma metadat.	Rozšíření	GA
az apic metadata delete	Odstraňte zadané schéma metadat.	Rozšíření	GA
az apic metadata export	Exportuje schéma metadat.	Rozšíření	GA
az apic metadata list	Vypíše kolekci schémat metadat.	Rozšíření	GA
az apic metadata show	Získejte podrobnosti o schématu metadat.	Rozšíření	GA
az apic metadata update	Aktualizujte existující schéma metadat.	Rozšíření	GA
az apic show	Zobrazení podrobností o instanci služby Azure API Center	Rozšíření	GA
az apic update	Aktualizace instance služby Azure API Center	Rozšíření	GA

az apic create

Vytvoří instanci nebo aktualizuje existující instanci služby Azure API Center.

az apic create --name
               --resource-group
               [--identity]
               [--location]
               [--tags]

Příklady

Vytvoření služby – příklad 1

az apic create -g contoso-resources -n contoso -l eastus

Vytvoření příkladu služby 2

az apic create --resource-group contoso-resources --name contoso --location eastus

Povinné parametry

--name -n

Název služby API Center.

--resource-group -g

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

Volitelné parametry

--identity

Identity spravované služby přiřazené k tomuto prostředku. Podpora zkratky syntaxe, json-file a yaml-file Zkuste "??" zobrazit více.

--location -l

Geografické umístění, ve kterém se prostředek nachází, pokud není zadaný, se použije umístění skupiny prostředků.

--tags

Značky prostředků Podpora zkratky syntaxe, json-file a yaml-file Zkuste "??" zobrazit více.

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

Odstraní instanci služby Azure API Center.

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

Příklady

Odstranit službu

az apic delete -n contoso -g contoso-resources

Volitelné parametry

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

--name -n

Název služby API Center.

--resource-group -g

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

--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ší 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 apic import-from-apim

Importuje rozhraní API z instance služby Azure API Management.

az apic import-from-apim --apim-apis
                         --apim-name
                         [--apim-resource-group]
                         [--apim-subscription]
                         [--ids]
                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                         [--resource-group]
                         [--service-name]
                         [--subscription]

Příklady

Import všech rozhraní API z APIM ve stejné skupině prostředků

az apic import-from-apim -g api-center-test --service-name contoso-apic --apim-name contoso-apim --apim-apis *

Import vybraných rozhraní API z APIM ve stejné skupině prostředků

az apic import-from-apim -g api-center-test --service-name contoso-apic --apim-name contoso-apim --apim-apis [echo,foo]

Import všech rozhraní API z APIM v jiném předplatném a skupině prostředků

az apic import-from-apim -g api-center-test --service-name contoso-apic --apim-subscription 00000000-0000-0000-0000-000000000000 --apim-resource-group apim-rg --apim-name contoso-apim --apim-apis *

Povinné parametry

--apim-apis

Rozhraní API, která se mají importovat. Podpora zkratky syntaxe, json-file a yaml-file Zkuste "??" zobrazit více.

--apim-name

Název zdrojové instance APIM.

Volitelné parametry

--apim-resource-group

Skupina prostředků zdrojové instance APIM.

--apim-subscription

ID předplatného zdrojové instance APIM.

--ids

--no-wait

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

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

--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ší 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 apic list

Vypíše služby Azure API Center v rámci předplatného Azure.

Existuje známý problém, který výpis všech prostředků v rámci předplatného nefunguje. Uveďte prostředky podle skupiny prostředků.

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

Příklady

Výpis služeb ve skupině prostředků

az apic list -g contoso-resources

Volitelné parametry

--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. Chcete-li obnovit 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.

--resource-group -g

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

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

Zobrazení podrobností o instanci služby Azure API Center

az apic show [--ids]
             [--name]
             [--resource-group]
             [--subscription]

Příklady

Zobrazit podrobnosti o službě

az apic show -g contoso-resources -n contoso

Volitelné parametry

--ids

--name -n

Název služby API Center.

--resource-group -g

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

--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ší 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 apic update

Aktualizace instance služby Azure API Center

az apic update [--add]
               [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
               [--identity]
               [--ids]
               [--name]
               [--remove]
               [--resource-group]
               [--set]
               [--subscription]
               [--tags]

Příklady

Aktualizace podrobností o službě

az apic update -g contoso-resources -n contoso

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, řetězec nebo řetězec> JSON.

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

--identity

Identity spravované služby přiřazené k tomuto prostředku. Podpora zkratky syntaxe, json-file a yaml-file Zkuste "??" zobrazit více.

--ids

--name -n

Název služby API Center.

--remove

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

--resource-group -g

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

--set

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

--subscription

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

--tags

Značky prostředků Podpora zkratky syntaxe, json-file a yaml-file Zkuste "??" zobrazit více.

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.

Sdílet prostřednictvím

az apic

Příkazy

az apic create

Příklady

Povinné parametry

Volitelné parametry

az apic delete

Příklady

Volitelné parametry

az apic import-from-apim

Příklady

Povinné parametry

Volitelné parametry

az apic list

Příklady

Volitelné parametry

az apic show

Příklady

Volitelné parametry

az apic update

Příklady

Volitelné parametry

Další materiály