az spring api-portal

Riferimento

Nota

Questo riferimento fa parte dell'estensione spring per l'interfaccia della riga di comando di Azure (versione 2.56.0 o successiva). L'estensione installerà automaticamente la prima volta che si esegue un comando az spring api-portal. Altre sulle estensioni.

(Solo livello Enterprise) Comandi per gestire il portale api in Azure Spring Apps.

Comandi

Nome	Descrizione	Tipo	Status
az spring api-portal clear	Cancellare tutte le impostazioni del portale API.	Estensione	GA
az spring api-portal create	Creare il portale API.	Estensione	GA
az spring api-portal custom-domain	Comandi per gestire domini personalizzati per il portale API.	Estensione	GA
az spring api-portal custom-domain bind	Associare un dominio personalizzato al portale api.	Estensione	GA
az spring api-portal custom-domain list	Elencare tutti i domini personalizzati del portale API.	Estensione	GA
az spring api-portal custom-domain show	Mostra i dettagli di un dominio personalizzato.	Estensione	GA
az spring api-portal custom-domain unbind	Annullare l'associazione di un dominio personalizzato del portale API.	Estensione	GA
az spring api-portal custom-domain update	Aggiornare un dominio personalizzato del portale API.	Estensione	GA
az spring api-portal delete	Eliminare il portale API.	Estensione	GA
az spring api-portal show	Visualizzare le impostazioni, lo stato del provisioning e lo stato di runtime del portale API.	Estensione	GA
az spring api-portal update	Aggiornare le proprietà di un portale API esistente.	Estensione	GA

az spring api-portal clear

Cancellare tutte le impostazioni del portale API.

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

Parametri necessari

--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito usando az configure --defaults group=<name>.

--service -s

Il nome dell'istanza di Azure Spring Apps consente di configurare il servizio predefinito usando az configure --defaults spring=<name>.

Parametri globali

--debug

Aumentare il livello di dettaglio della registrazione per visualizzare tutti i log di debug.

--help -h

Mostra questo messaggio della Guida e esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

--output -o

Formato di output.

Valori accettati: json, jsonc, none, table, tsv, yaml, yamlc

Valore predefinito: json

--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

--verbose

Aumentare il livello di dettaglio della registrazione. Usare --debug per i log di debug completi.

az spring api-portal create

Creare il portale API.

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

Esempio

Creare il portale API.

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

Parametri necessari

--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito usando az configure --defaults group=<name>.

--service -s

Il nome dell'istanza di Azure Spring Apps consente di configurare il servizio predefinito usando az configure --defaults spring=<name>.

Parametri facoltativi

--instance-count

Numero di istanza.

Parametri globali

--debug

Aumentare il livello di dettaglio della registrazione per visualizzare tutti i log di debug.

--help -h

Mostra questo messaggio della Guida e esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

--output -o

Formato di output.

Valori accettati: json, jsonc, none, table, tsv, yaml, yamlc

Valore predefinito: json

--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

--verbose

Aumentare il livello di dettaglio della registrazione. Usare --debug per i log di debug completi.

az spring api-portal delete

Eliminare il portale API.

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

Parametri necessari

--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito usando az configure --defaults group=<name>.

--service -s

Il nome dell'istanza di Azure Spring Apps consente di configurare il servizio predefinito usando az configure --defaults spring=<name>.

Parametri facoltativi

--yes -y

Non richiedere conferma.

Valore predefinito: False

Parametri globali

--debug

Aumentare il livello di dettaglio della registrazione per visualizzare tutti i log di debug.

--help -h

Mostra questo messaggio della Guida e esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

--output -o

Formato di output.

Valori accettati: json, jsonc, none, table, tsv, yaml, yamlc

Valore predefinito: json

--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

--verbose

Aumentare il livello di dettaglio della registrazione. Usare --debug per i log di debug completi.

az spring api-portal show

Visualizzare le impostazioni, lo stato del provisioning e lo stato di runtime del portale API.

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

Parametri necessari

--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito usando az configure --defaults group=<name>.

--service -s

Il nome dell'istanza di Azure Spring Apps consente di configurare il servizio predefinito usando az configure --defaults spring=<name>.

Parametri globali

--debug

Aumentare il livello di dettaglio della registrazione per visualizzare tutti i log di debug.

--help -h

Mostra questo messaggio della Guida e esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

--output -o

Formato di output.

Valori accettati: json, jsonc, none, table, tsv, yaml, yamlc

Valore predefinito: json

--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

--verbose

Aumentare il livello di dettaglio della registrazione. Usare --debug per i log di debug completi.

az spring api-portal update

Aggiornare le proprietà di un portale API esistente.

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]

Esempio

Aggiornare la proprietà del portale API.

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

Parametri necessari

--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito usando az configure --defaults group=<name>.

--service -s

Il nome dell'istanza di Azure Spring Apps consente di configurare il servizio predefinito usando az configure --defaults spring=<name>.

Parametri facoltativi

--assign-endpoint

Se true, assegnare l'URL dell'endpoint per l'accesso diretto.

Valori accettati: false, true

--client-id

Identificatore pubblico per l'applicazione.

--client-secret

Segreto noto solo all'applicazione e al server di autorizzazione.

--enable-api-try-out

Provare l'API inviando richieste e visualizzando le risposte nel portale API.

Valori accettati: false, true

--https-only

Se true, accedere all'endpoint tramite https.

Valori accettati: false, true

--instance-count

Numero di istanza.

--issuer-uri

URI dell'identificatore dell'autorità di certificazione.

--scope

L'elenco delimitato da virgole delle applicazioni di azioni specifiche può essere consentito per conto di un utente.

Parametri globali

--debug

Aumentare il livello di dettaglio della registrazione per visualizzare tutti i log di debug.

--help -h

Mostra questo messaggio della Guida e esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

--output -o

Formato di output.

Valori accettati: json, jsonc, none, table, tsv, yaml, yamlc

Valore predefinito: json

--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

--verbose

Aumentare il livello di dettaglio della registrazione. Usare --debug per i log di debug completi.

Condividi tramite

az spring api-portal

Comandi

az spring api-portal clear

Parametri necessari

az spring api-portal create

Esempio

Parametri necessari

Parametri facoltativi

az spring api-portal delete

Parametri necessari

Parametri facoltativi

az spring api-portal show

Parametri necessari

az spring api-portal update

Esempio

Parametri necessari

Parametri facoltativi

Risorse aggiuntive