az apic environment

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

Příkazy pro správu prostředí ve službě API Center

Příkazy

Name	Description	Typ	Stav
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 environment create

Vytvořte nové prostředí nebo aktualizujte existující prostředí.

az apic environment create --environment-id
                           --resource-group
                           --service-name
                           --title
                           --type {development, production, staging, testing}
                           [--custom-properties]
                           [--description]
                           [--onboarding]
                           [--server]

Příklady

Vytvoření prostředí

az apic environment create -g api-center-test -n contosoeuap --environment-id public --title "Public cloud" --type "development"

Povinné parametry

--environment-id

ID prostředí.

--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 prostředí

--type

Typ prostředí.

Přípustné hodnoty: development, production, staging, testing

Volitelné parametry

--custom-properties

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

--description

Popis prostředí

--onboarding

Uveďte dokumentaci k onboardingu související s vaším prostředím, například {developerPortalUri:['https://developer.contoso.com'],instructions:'instructions markdown'} Podpora shorthand-syntaxe, json-file a yaml-file. Zkuste "??" zobrazit více.

--server

Informace o serveru prostředí. 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 environment delete

Odstraňte prostředí.

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

Příklady

Odstranění prostředí

az apic environment delete -g api-center-test -n contosoeuap --environment-id public

Volitelné parametry

--environment-id

ID prostředí.

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

Vypíše kolekci prostředí.

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

Příklady

Seznam prostředí

az apic environment list -g api-center-test -n contosoeuap

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

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

Získejte podrobnosti o prostředí.

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

Příklady

Zobrazení podrobností o prostředí

az apic environment show -g api-center-test -n contosoeuap --environment-id public

Volitelné parametry

--environment-id

ID prostředí.

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

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

Aktualizujte existující prostředí.

az apic environment update [--add]
                           [--custom-properties]
                           [--description]
                           [--environment-id]
                           [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                           [--ids]
                           [--onboarding]
                           [--remove]
                           [--resource-group]
                           [--server]
                           [--service-name]
                           [--set]
                           [--subscription]
                           [--title]
                           [--type {development, production, staging, testing}]

Příklady

Aktualizace prostředí

az apic environment update -g api-center-test -n contosoeuap --environment-id public --title "Public cloud"

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.

--custom-properties

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

--description

Popis.

--environment-id

ID prostředí.

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

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.

--onboarding

{developerPortalUri:['https://developer.contoso.com],instructions:'instructions markdown'} Podporuje zkratkovou syntaxi, json-file a yaml-file. Zkuste "??" zobrazit více.

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

--server

Informace o serveru prostředí. Podpora zkratky syntaxe, json-file a yaml-file Zkuste "??" zobrazit více.

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

--subscription

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

--title

Název prostředí

--type

Typ prostředí.

Přípustné hodnoty: development, production, staging, testing

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.