Condividi tramite

az spring gateway

  • 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 gateway . Altre informazioni sulle estensioni.

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

Comandi

Nome Descrizione Tipo Status
az spring gateway clear

Cancellare tutte le impostazioni del gateway.

 Estensione Disponibilità generale
az spring gateway create

Creare Spring Cloud Gateway.

 Estensione Disponibilità generale
az spring gateway custom-domain

Comandi per gestire domini personalizzati per il gateway.

 Estensione Disponibilità generale
az spring gateway custom-domain bind

Associare un dominio personalizzato al gateway.

 Estensione Disponibilità generale
az spring gateway custom-domain list

Elencare tutti i domini personalizzati del gateway.

 Estensione Disponibilità generale
az spring gateway custom-domain show

Mostra i dettagli di un dominio personalizzato.

 Estensione Disponibilità generale
az spring gateway custom-domain unbind

Annullare l'associazione di un dominio personalizzato del gateway.

 Estensione Disponibilità generale
az spring gateway custom-domain update

Aggiornare un dominio personalizzato del gateway.

 Estensione Disponibilità generale
az spring gateway delete

Eliminare Spring Cloud Gateway.

 Estensione Disponibilità generale
az spring gateway restart

Riavviare Spring Cloud Gateway.

 Estensione Disponibilità generale
az spring gateway route-config

Comandi per gestire le configurazioni di route del gateway in Azure Spring Apps.

 Estensione Disponibilità generale
az spring gateway route-config create

Creare una configurazione di route del gateway con regole di routing in formato matrice Json.

 Estensione Disponibilità generale
az spring gateway route-config list

Elencare tutte le configurazioni di route del gateway esistenti.

 Estensione Disponibilità generale
az spring gateway route-config remove

Eliminare una configurazione di route del gateway esistente.

 Estensione Disponibilità generale
az spring gateway route-config show

Ottenere una configurazione di route del gateway esistente.

 Estensione Disponibilità generale
az spring gateway route-config update

Aggiornare una configurazione di route del gateway esistente con le regole di routing del formato di matrice Json.

 Estensione Disponibilità generale
az spring gateway show

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

 Estensione Disponibilità generale
az spring gateway sync-cert

Sincronizzare il certificato del gateway.

 Estensione Disponibilità generale
az spring gateway update

Aggiornare le proprietà di un gateway esistente.

 Estensione Disponibilità generale

az spring gateway clear

Cancellare tutte le impostazioni del gateway.

az spring gateway clear --resource-group
                        --service
                        [--no-wait]

Parametri necessari

--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con 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=.

Parametri facoltativi

--no-wait

Indica che non è necessario attendere il termine dell'operazione a esecuzione prolungata.

Valore predefinito: False
Parametri globali
--debug

Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.

--help -h

Visualizza questo messaggio della guida ed esce.

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

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

az spring gateway create

Creare Spring Cloud Gateway.

az spring gateway create --resource-group
                         --service
                         [--instance-count]

Esempio

Creare Spring Cloud Gateway.

az spring gateway create -s MyService -g MyResourceGroup --instance-count 2

Parametri necessari

--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con 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=.

Parametri facoltativi

--instance-count

Numero di istanza.

Parametri globali
--debug

Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.

--help -h

Visualizza questo messaggio della guida ed esce.

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

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

az spring gateway delete

Eliminare Spring Cloud Gateway.

az spring gateway delete --resource-group
                         --service
                         [--yes]

Parametri necessari

--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con 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=.

Parametri facoltativi

--yes -y

Indica che non è richiesta la conferma.

Valore predefinito: False
Parametri globali
--debug

Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.

--help -h

Visualizza questo messaggio della guida ed esce.

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

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

az spring gateway restart

Riavviare Spring Cloud Gateway.

az spring gateway restart --resource-group
                          --service
                          [--no-wait]
                          [--yes]

Esempio

Riavviare Spring Cloud Gateway.

az spring gateway restart -s MyService -g MyResourceGroup

Parametri necessari

--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con 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=.

Parametri facoltativi

--no-wait

Indica che non è necessario attendere il termine dell'operazione a esecuzione prolungata.

Valore predefinito: False
--yes -y

Indica che non è richiesta la conferma.

Valore predefinito: False
Parametri globali
--debug

Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.

--help -h

Visualizza questo messaggio della guida ed esce.

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

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

az spring gateway show

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

az spring gateway show --resource-group
                       --service

Parametri necessari

--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con 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=.

Parametri globali
--debug

Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.

--help -h

Visualizza questo messaggio della guida ed esce.

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

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

az spring gateway sync-cert

Sincronizzare il certificato del gateway.

az spring gateway sync-cert --resource-group
                            --service
                            [--no-wait]
                            [--yes]

Esempio

Sincronizzare il certificato del gateway.

az spring gateway sync-cert -s MyService -g MyResourceGroup

Parametri necessari

--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con 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=.

Parametri facoltativi

--no-wait

Indica che non è necessario attendere il termine dell'operazione a esecuzione prolungata.

Valore predefinito: False
--yes -y

Indica che non è richiesta la conferma.

Valore predefinito: False
Parametri globali
--debug

Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.

--help -h

Visualizza questo messaggio della guida ed esce.

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

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

az spring gateway update

Aggiornare le proprietà di un gateway esistente.

az spring gateway update --resource-group
                         --service
                         [--addon-configs-file]
                         [--addon-configs-json]
                         [--allow-credentials {false, true}]
                         [--allow-origin-patterns]
                         [--allowed-headers]
                         [--allowed-methods]
                         [--allowed-origins]
                         [--api-description]
                         [--api-doc-location]
                         [--api-title]
                         [--api-version]
                         [--apm-types]
                         [--apms]
                         [--assign-endpoint {false, true}]
                         [--certificate-names]
                         [--client-id]
                         [--client-secret]
                         [--cpu]
                         [--enable-cert-verify {false, true}]
                         [--enable-response-cache {false, true}]
                         [--exposed-headers]
                         [--https-only {false, true}]
                         [--instance-count]
                         [--issuer-uri]
                         [--max-age]
                         [--memory]
                         [--no-wait]
                         [--properties]
                         [--response-cache-scope]
                         [--response-cache-size]
                         [--response-cache-ttl]
                         [--scope]
                         [--secrets]
                         [--server-url]

Esempio

Aggiornare la proprietà del gateway.

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

Abilitare e configurare la cache delle risposte a livello di route e impostare ttl su 5 minuti.

az spring gateway update -s MyService -g MyResourceGroup --enable-response-cache --response-cache-scope Route --response-cache-ttl 5m

Quando la cache delle risposte è abilitata, aggiornare ttl a 3 minuti.

az spring gateway update -s MyService -g MyResourceGroup --response-cache-ttl 3m

Disabilitare la cache delle risposte.

az spring gateway update -s MyService -g MyResourceGroup --enable-response-cache false

Parametri necessari

--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con 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=.

Parametri facoltativi

--addon-configs-file

Percorso del file della stringa JSON delle configurazioni del componente aggiuntivo.

--addon-configs-json

Stringa JSON delle configurazioni del componente aggiuntivo.

--allow-credentials

Indica se le credenziali utente sono supportate nelle richieste tra siti.

Valori accettati: false, true
--allow-origin-patterns --allowed-origin-patterns

Elenco delimitato da virgole di modelli di origine consentiti per effettuare richieste tra siti.

--allowed-headers

Elenco delimitato da virgole di intestazioni consentite nelle richieste tra siti. Il valore * speciale consente alle richieste effettive di inviare qualsiasi intestazione.

--allowed-methods

Elenco delimitato da virgole dei metodi HTTP consentiti nelle richieste tra siti. Il valore * speciale consente tutti i metodi.

--allowed-origins

Elenco delimitato da virgole di origini consentite per effettuare richieste tra siti. Il valore * speciale consente tutti i domini.

--api-description

Descrizione dettagliata delle API disponibili nell'istanza del gateway.

--api-doc-location

Percorso di documentazione aggiuntiva per le API disponibili nell'istanza del gateway.

--api-title

Titolo che descrive il contesto delle API disponibili nell'istanza del gateway.

--api-version

Versione delle API disponibili in questa istanza del gateway.

--apm-types

Elenco separato da spazi di APM integrato con gateway. I valori consentiti sono: ApplicationInsights, AppDynamics, Dynatrace, NewRelic, ElasticAPM.

--apms

Elenco delimitato da spazi dei nomi di riferimento APM in Azure Spring Apps da integrare con il gateway.

--assign-endpoint

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

Valori accettati: false, true
--certificate-names

Elenco delimitato da virgole dei nomi dei certificati in Azure Spring Apps.

--client-id

Identificatore pubblico per l'applicazione.

--client-secret

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

--cpu

Quantità di risorse CPU. Deve essere 500m o il numero di core CPU.

--enable-cert-verify --enable-certificate-verification

Se true, verificherà il certificato nella connessione TLS dal gateway all'app.

Valori accettati: false, true
--enable-response-cache

Abilitare le impostazioni della cache delle risposte in Spring Cloud Gateway.

Valori accettati: false, true
--exposed-headers

Elenco delimitato da virgole di intestazioni di risposta HTTP da esporre per le richieste tra siti.

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

--max-age

Per quanto tempo, in secondi, la risposta di una richiesta di pre-anteprima può essere memorizzata nella cache dai client.

--memory

Quantità di risorse di memoria. Deve essere 512Mi o #Gi, ad esempio 1Gi, 3Gi.

--no-wait

Indica che non è necessario attendere il termine dell'operazione a esecuzione prolungata.

Valore predefinito: False
--properties

Proprietà non sensibili per le variabili di ambiente. Formattare "key[=value]" e separati da spazio.

--response-cache-scope

L'ambito della cache delle risposte, i valori disponibili sono [Route, Istanza].

--response-cache-size

Dimensione massima della cache che determina se la cache deve rimuovere alcune voci. Gli esempi sono [1 GB, 10 MB, 100 KB]. Usare "default" per reimpostare e gateway gestirà questa proprietà.

--response-cache-ttl

Tempo prima della scadenza di una voce memorizzata nella cache. Gli esempi sono [1h, 30m, 50s]. Usare "default" per reimpostare e gateway gestirà questa proprietà.

--scope

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

--secrets

Proprietà sensibili per le variabili di ambiente. Una volta inserito, verrà crittografato e non restituito. Formattare "key[=value]" e separati da spazio.

--server-url

URL di base che i consumer di API useranno per accedere alle API nell'istanza del gateway.

Parametri globali
--debug

Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.

--help -h

Visualizza questo messaggio della guida ed esce.

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

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