Share via

az spring api-portal

  • Reference

Poznámka:

Tento odkaz je součástí rozšíření Spring pro Azure CLI (verze 2.56.0 nebo vyšší). Rozšíření se automaticky nainstaluje při prvním spuštění příkazu az spring api-portal . Přečtěte si další informace o rozšířeních.

(Jenom úroveň Enterprise) Příkazy pro správu portálu API v Azure Spring Apps

Příkazy

Name Description Typ Stav
az spring api-portal clear

Vymažte všechna nastavení portálu API.

 Rozšíření GA
az spring api-portal create

Vytvoření portálu rozhraní API

 Rozšíření GA
az spring api-portal custom-domain

Příkazy pro správu vlastních domén pro portál ROZHRANÍ API

 Rozšíření GA
az spring api-portal custom-domain bind

Vytvoření vazby vlastní domény pomocí portálu rozhraní API

 Rozšíření GA
az spring api-portal custom-domain list

Zobrazí seznam všech vlastních domén portálu API.

 Rozšíření GA
az spring api-portal custom-domain show

Zobrazení podrobností o vlastní doméně

 Rozšíření GA
az spring api-portal custom-domain unbind

Zrušení vazby vlastní domény portálu rozhraní API

 Rozšíření GA
az spring api-portal custom-domain update

Aktualizace vlastní domény portálu API

 Rozšíření GA
az spring api-portal delete

Odstraňte portál rozhraní API.

 Rozšíření GA
az spring api-portal show

Zobrazení nastavení, stavu zřizování a stavu modulu runtime na portálu API

 Rozšíření GA
az spring api-portal update

Aktualizujte existující vlastnosti portálu rozhraní API.

 Rozšíření GA

az spring api-portal clear

Vymažte všechna nastavení portálu API.

az spring api-portal clear --resource-group
                           --service

Povinné parametry

--resource-group -g

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

--service -s

Název instance Azure Spring Apps můžete nakonfigurovat výchozí službu pomocí příkazu az configure --defaults spring=.

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 spring api-portal create

Vytvoření portálu rozhraní API

az spring api-portal create --resource-group
                            --service
                            [--instance-count]

Příklady

Vytvoření portálu rozhraní API

az spring api-portal create -s MyService -g MyResourceGroup --instance-count 1

Povinné parametry

--resource-group -g

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

--service -s

Název instance Azure Spring Apps můžete nakonfigurovat výchozí službu pomocí příkazu az configure --defaults spring=.

Volitelné parametry

--instance-count

Počet instancí

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 spring api-portal delete

Odstraňte portál rozhraní API.

az spring api-portal delete --resource-group
                            --service
                            [--yes]

Povinné parametry

--resource-group -g

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

--service -s

Název instance Azure Spring Apps můžete nakonfigurovat výchozí službu pomocí příkazu az configure --defaults spring=.

Volitelné parametry

--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 spring api-portal show

Zobrazení nastavení, stavu zřizování a stavu modulu runtime na portálu API

az spring api-portal show --resource-group
                          --service

Povinné parametry

--resource-group -g

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

--service -s

Název instance Azure Spring Apps můžete nakonfigurovat výchozí službu pomocí příkazu az configure --defaults spring=.

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 spring api-portal update

Aktualizujte existující vlastnosti portálu rozhraní API.

az spring api-portal update --resource-group
                            --service
                            [--assign-endpoint {false, true}]
                            [--client-id]
                            [--client-secret]
                            [--enable-api-try-out {false, true}]
                            [--https-only {false, true}]
                            [--instance-count]
                            [--issuer-uri]
                            [--scope]

Příklady

Aktualizovat vlastnost portálu rozhraní API

az spring api-portal update -s MyService -g MyResourceGroup --assign-endpoint true --https-only true

Povinné parametry

--resource-group -g

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

--service -s

Název instance Azure Spring Apps můžete nakonfigurovat výchozí službu pomocí příkazu az configure --defaults spring=.

Volitelné parametry

--assign-endpoint

Pokud je pravda, přiřaďte adresu URL koncového bodu pro přímý přístup.

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

Veřejný identifikátor aplikace.

--client-secret

Tajný kód známý pouze pro aplikaci a autorizační server.

--enable-api-try-out

Vyzkoušejte rozhraní API odesláním požadavků a zobrazením odpovědí na portálu API.

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

Pokud ano, přejděte ke koncovému bodu přes https.

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

Počet instancí

--issuer-uri

Identifikátor URI vystavitele.

--scope

Čárkami oddělený seznam konkrétních akcí, které můžou aplikace provádět jménem uživatele.

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.