Dela via

az spring api-portal

  • Referens

Kommentar

Den här referensen är en del av spring-tillägget för Azure CLI (version 2.56.0 eller senare). Tillägget installeras automatiskt första gången du kör kommandot az spring api-portal . Läs mer om tillägg.

(Endast företagsnivå) Kommandon för att hantera API-portalen i Azure Spring Apps.

Kommandon

Name Description Typ Status
az spring api-portal clear

Rensa alla inställningar för API-portalen.

 Anknytning Allmän tillgänglighet
az spring api-portal create

Skapa API-portalen.

 Anknytning Allmän tillgänglighet
az spring api-portal custom-domain

Kommandon för att hantera anpassade domäner för API-portalen.

 Anknytning Allmän tillgänglighet
az spring api-portal custom-domain bind

Binda en anpassad domän med API-portalen.

 Anknytning Allmän tillgänglighet
az spring api-portal custom-domain list

Visa en lista över alla anpassade domäner i API-portalen.

 Anknytning Allmän tillgänglighet
az spring api-portal custom-domain show

Visa information om en anpassad domän.

 Anknytning Allmän tillgänglighet
az spring api-portal custom-domain unbind

Avbindning av en anpassad domän för API-portalen.

 Anknytning Allmän tillgänglighet
az spring api-portal custom-domain update

Uppdatera en anpassad domän i API-portalen.

 Anknytning Allmän tillgänglighet
az spring api-portal delete

Ta bort API-portalen.

 Anknytning Allmän tillgänglighet
az spring api-portal show

Visa inställningar, etableringsstatus och körningsstatus för API-portalen.

 Anknytning Allmän tillgänglighet
az spring api-portal update

Uppdatera en befintlig API-portalegenskaper.

 Anknytning Allmän tillgänglighet

az spring api-portal clear

Rensa alla inställningar för API-portalen.

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

Obligatoriska parametrar

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--service -s

Namnet på Azure Spring Apps-instansen kan du konfigurera standardtjänsten med az configure --defaults spring=.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az spring api-portal create

Skapa API-portalen.

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

Exempel

Skapa API-portalen.

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

Obligatoriska parametrar

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--service -s

Namnet på Azure Spring Apps-instansen kan du konfigurera standardtjänsten med az configure --defaults spring=.

Valfria parametrar

--instance-count

Antal instanser.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az spring api-portal delete

Ta bort API-portalen.

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

Obligatoriska parametrar

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--service -s

Namnet på Azure Spring Apps-instansen kan du konfigurera standardtjänsten med az configure --defaults spring=.

Valfria parametrar

--yes -y

Fråga inte efter bekräftelse.

standardvärde: False
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az spring api-portal show

Visa inställningar, etableringsstatus och körningsstatus för API-portalen.

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

Obligatoriska parametrar

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--service -s

Namnet på Azure Spring Apps-instansen kan du konfigurera standardtjänsten med az configure --defaults spring=.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az spring api-portal update

Uppdatera en befintlig API-portalegenskaper.

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]

Exempel

Uppdatera api-portalegenskapen.

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

Obligatoriska parametrar

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--service -s

Namnet på Azure Spring Apps-instansen kan du konfigurera standardtjänsten med az configure --defaults spring=.

Valfria parametrar

--assign-endpoint

Om det är sant tilldelar du slutpunkts-URL för direkt åtkomst.

accepterade värden: false, true
--client-id

Den offentliga identifieraren för programmet.

--client-secret

Hemligheten som endast är känd för programmet och auktoriseringsservern.

--enable-api-try-out

Prova API:et genom att skicka begäranden och visa svar i API-portalen.

accepterade värden: false, true
--https-only

Om det är sant får du åtkomst till slutpunkten via https.

accepterade värden: false, true
--instance-count

Antal instanser.

--issuer-uri

URI för utfärdaridentifierare.

--scope

Kommaavgränsad lista över de specifika åtgärder som program kan tillåtas utföra för en användares räkning.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.