az spring gateway

Note

This reference is part of the spring extension for the Azure CLI (version 2.56.0 or higher). Die Erweiterung wird automatisch installiert, wenn Sie ein az spring gateway Befehl zum ersten Mal ausführen. Learn more about extensions.

(Nur Enterprise-Ebene) Befehle zum Verwalten des Gateways in Azure Spring Apps.

Befehle

Name	Beschreibung	Typ	Status
az spring gateway clear	Löschen Sie alle Einstellungen des Gateways.	Extension	GA
az spring gateway create	Erstellen Sie Spring Cloud Gateway.	Extension	GA
az spring gateway custom-domain	Befehle zum Verwalten benutzerdefinierter Domänen für Gateways.	Extension	GA
az spring gateway custom-domain bind	Binden Sie eine benutzerdefinierte Domäne an das Gateway.	Extension	GA
az spring gateway custom-domain list	Listet alle benutzerdefinierten Domänen des Gateways auf.	Extension	GA
az spring gateway custom-domain show	Details einer benutzerdefinierten Domäne anzeigen.	Extension	GA
az spring gateway custom-domain unbind	Aufheben der Verknüpfung einer benutzerdefinierten Domäne des Gateways.	Extension	GA
az spring gateway custom-domain update	Aktualisieren Sie eine benutzerdefinierte Domäne des Gateways.	Extension	GA
az spring gateway delete	Spring Cloud Gateway löschen.	Extension	GA
az spring gateway restart	Starten Sie Spring Cloud Gateway neu.	Extension	GA
az spring gateway route-config	Befehle zum Verwalten von Gatewayroutenkonfigurationen in Azure Spring Apps.	Extension	GA
az spring gateway route-config create	Erstellen Sie eine Gatewayroutenkonfiguration mit Routingregeln im JSON-Arrayformat.	Extension	GA
az spring gateway route-config list	Alle vorhandenen Gatewayroutenkonfigurationen auflisten.	Extension	GA
az spring gateway route-config remove	Löschen Einer vorhandenen Gatewayroutenkonfiguration.	Extension	GA
az spring gateway route-config show	Rufen Sie eine vorhandene Gatewayroutenkonfiguration ab.	Extension	GA
az spring gateway route-config update	Aktualisieren Sie eine vorhandene Gatewayroutenkonfiguration mit Routingregeln im JSON-Arrayformat.	Extension	GA
az spring gateway show	Zeigen Sie die Einstellungen, den Bereitstellungsstatus und den Laufzeitstatus des Gateways an.	Extension	GA
az spring gateway sync-cert	Synchronisierungszertifikat des Gateways.	Extension	GA
az spring gateway update	Aktualisieren Sie eine vorhandene Gatewayeigenschaften.	Extension	GA

az spring gateway clear

Löschen Sie alle Einstellungen des Gateways.

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

Erforderliche Parameter

--resource-group -g

Name der Ressourcengruppe. Sie können die Standardgruppe mit az configure --defaults group=<name>konfigurieren.

--service -s

Der Name der Azure Spring Apps-Instanz, sie können den Standarddienst mithilfe von az configure --defaults spring=<name>konfigurieren.

Optionale Parameter

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--no-wait

Warten Sie nicht, bis der lange ausgeführte Vorgang abgeschlossen ist.

Eigenschaft	Wert
Standardwert:	False

Globale Parameter

--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft	Wert
Standardwert:	False

--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft	Wert
Standardwert:	False

--output -o

Output format.

Eigenschaft	Wert
Standardwert:	json
Zulässige Werte:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft	Wert
Standardwert:	False

az spring gateway create

Erstellen Sie Spring Cloud Gateway.

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

Beispiele

Erstellen Sie Spring Cloud Gateway.

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

Erforderliche Parameter

--resource-group -g

Name der Ressourcengruppe. Sie können die Standardgruppe mit az configure --defaults group=<name>konfigurieren.

--service -s

Der Name der Azure Spring Apps-Instanz, sie können den Standarddienst mithilfe von az configure --defaults spring=<name>konfigurieren.

Optionale Parameter

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--instance-count

Anzahl der Instanzen.

Globale Parameter

--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft	Wert
Standardwert:	False

--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft	Wert
Standardwert:	False

--output -o

Output format.

Eigenschaft	Wert
Standardwert:	json
Zulässige Werte:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft	Wert
Standardwert:	False

az spring gateway delete

Spring Cloud Gateway löschen.

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

Erforderliche Parameter

--resource-group -g

Name der Ressourcengruppe. Sie können die Standardgruppe mit az configure --defaults group=<name>konfigurieren.

--service -s

Der Name der Azure Spring Apps-Instanz, sie können den Standarddienst mithilfe von az configure --defaults spring=<name>konfigurieren.

Optionale Parameter

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--yes -y

Zur Bestätigung nicht auffordern.

Eigenschaft	Wert
Standardwert:	False

Globale Parameter

--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft	Wert
Standardwert:	False

--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft	Wert
Standardwert:	False

--output -o

Output format.

Eigenschaft	Wert
Standardwert:	json
Zulässige Werte:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft	Wert
Standardwert:	False

az spring gateway restart

Starten Sie Spring Cloud Gateway neu.

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

Beispiele

Starten Sie Spring Cloud Gateway neu.

az spring gateway restart -s MyService -g MyResourceGroup

Erforderliche Parameter

--resource-group -g

Name der Ressourcengruppe. Sie können die Standardgruppe mit az configure --defaults group=<name>konfigurieren.

--service -s

Der Name der Azure Spring Apps-Instanz, sie können den Standarddienst mithilfe von az configure --defaults spring=<name>konfigurieren.

Optionale Parameter

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--no-wait

Warten Sie nicht, bis der lange ausgeführte Vorgang abgeschlossen ist.

Eigenschaft	Wert
Standardwert:	False

--yes -y

Zur Bestätigung nicht auffordern.

Eigenschaft	Wert
Standardwert:	False

Globale Parameter

--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft	Wert
Standardwert:	False

--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft	Wert
Standardwert:	False

--output -o

Output format.

Eigenschaft	Wert
Standardwert:	json
Zulässige Werte:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft	Wert
Standardwert:	False

az spring gateway show

Zeigen Sie die Einstellungen, den Bereitstellungsstatus und den Laufzeitstatus des Gateways an.

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

Erforderliche Parameter

--resource-group -g

Name der Ressourcengruppe. Sie können die Standardgruppe mit az configure --defaults group=<name>konfigurieren.

--service -s

Der Name der Azure Spring Apps-Instanz, sie können den Standarddienst mithilfe von az configure --defaults spring=<name>konfigurieren.

Globale Parameter

--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft	Wert
Standardwert:	False

--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft	Wert
Standardwert:	False

--output -o

Output format.

Eigenschaft	Wert
Standardwert:	json
Zulässige Werte:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft	Wert
Standardwert:	False

az spring gateway sync-cert

Synchronisierungszertifikat des Gateways.

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

Beispiele

Synchronisierungszertifikat des Gateways.

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

Erforderliche Parameter

--resource-group -g

Name der Ressourcengruppe. Sie können die Standardgruppe mit az configure --defaults group=<name>konfigurieren.

--service -s

Der Name der Azure Spring Apps-Instanz, sie können den Standarddienst mithilfe von az configure --defaults spring=<name>konfigurieren.

Optionale Parameter

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--no-wait

Warten Sie nicht, bis der lange ausgeführte Vorgang abgeschlossen ist.

Eigenschaft	Wert
Standardwert:	False

--yes -y

Zur Bestätigung nicht auffordern.

Eigenschaft	Wert
Standardwert:	False

Globale Parameter

--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft	Wert
Standardwert:	False

--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft	Wert
Standardwert:	False

--output -o

Output format.

Eigenschaft	Wert
Standardwert:	json
Zulässige Werte:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft	Wert
Standardwert:	False

az spring gateway update

Aktualisieren Sie eine vorhandene Gatewayeigenschaften.

az spring gateway update --resource-group
                         --service
                         [--addon-configs-file]
                         [--addon-configs-json]
                         [--allow-credentials {false, true}]
                         [--allow-origin-patterns --allowed-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 --enable-certificate-verification {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]

Beispiele

Aktualisieren der Gatewayeigenschaft.

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

Aktivieren und konfigurieren Sie den Antwortcache auf Route-Ebene, und legen Sie "ttl" auf 5 Minuten fest.

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

Wenn der Antwortcache aktiviert ist, aktualisieren Sie ttl auf 3 Minuten.

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

Antwortcache deaktivieren.

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

Erforderliche Parameter

--resource-group -g

Name der Ressourcengruppe. Sie können die Standardgruppe mit az configure --defaults group=<name>konfigurieren.

--service -s

Der Name der Azure Spring Apps-Instanz, sie können den Standarddienst mithilfe von az configure --defaults spring=<name>konfigurieren.

Optionale Parameter

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--addon-configs-file

Der Dateipfad der JSON-Zeichenfolge von Add-On-Konfigurationen.

Eigenschaft	Wert
Parameter group:	Add-on Configurations Arguments

--addon-configs-json

JSON-Zeichenfolge von Add-On-Konfigurationen.

Eigenschaft	Wert
Parameter group:	Add-on Configurations Arguments

--allow-credentials

Gibt an, ob Benutzeranmeldeinformationen für websiteübergreifende Anforderungen unterstützt werden.

Eigenschaft	Wert
Parameter group:	Cross-origin Resource Sharing (CORS) Arguments
Zulässige Werte:	false, true

--allow-origin-patterns --allowed-origin-patterns

Durch Trennzeichen getrennte Liste zulässiger Ursprungsmuster, um websiteübergreifende Anforderungen zu erstellen.

Eigenschaft	Wert
Parameter group:	Cross-origin Resource Sharing (CORS) Arguments

--allowed-headers

Durch Trennzeichen getrennte Liste zulässiger Header in standortübergreifenden Anforderungen. Mit dem speziellen Wert * können tatsächliche Anforderungen beliebige Header senden.

Eigenschaft	Wert
Parameter group:	Cross-origin Resource Sharing (CORS) Arguments

--allowed-methods

Durch Trennzeichen getrennte Liste zulässiger HTTP-Methoden für standortübergreifende Anforderungen. Der sondere Wert * lässt alle Methoden zu.

Eigenschaft	Wert
Parameter group:	Cross-origin Resource Sharing (CORS) Arguments

--allowed-origins

Durch Trennzeichen getrennte Liste zulässiger Ursprünge, um websiteübergreifende Anforderungen zu stellen. Der sondere Wert, * alle Domänen zulässt.

Eigenschaft	Wert
Parameter group:	Cross-origin Resource Sharing (CORS) Arguments

--api-description

Detaillierte Beschreibung der APIs, die in der Gatewayinstanz verfügbar sind.

Eigenschaft	Wert
Parameter group:	API metadata Arguments

--api-doc-location

Speicherort der zusätzlichen Dokumentation für die APIs, die in der Gatewayinstanz verfügbar sind.

Eigenschaft	Wert
Parameter group:	API metadata Arguments

--api-title

Titel, der den Kontext der apIs beschreibt, die in der Gatewayinstanz verfügbar sind.

Eigenschaft	Wert
Parameter group:	API metadata Arguments

--api-version

Version der APIs, die in dieser Gatewayinstanz verfügbar sind.

Eigenschaft	Wert
Parameter group:	API metadata Arguments

--apm-types

Mit Leerzeichen getrennte Liste von APM, die in Gateway integriert ist. Zulässige Werte sind: ApplicationInsights, AppDynamics, Dynatrace, NewRelic, ElasticAPM.

Eigenschaft	Wert
Parameter group:	APM Arguments

--apms

Leerzeichentrennte Liste der APM-Referenznamen in Azure Spring Apps, die in Gateway integriert werden sollen.

Eigenschaft	Wert
Parameter group:	APM Arguments

--assign-endpoint

Wenn true, weisen Sie endpunkt-URL für den direkten Zugriff zu.

Eigenschaft	Wert
Zulässige Werte:	false, true

--certificate-names

Durch Trennzeichen getrennte Liste der Zertifikatnamen in Azure Spring Apps.

Eigenschaft	Wert
Parameter group:	Client Certificate Authentication Arguments

--client-id

Der öffentliche Bezeichner für die Anwendung.

Eigenschaft	Wert
Parameter group:	Single Sign On (SSO) Arguments

--client-secret

Der geheime Schlüssel, der nur für die Anwendung und den Autorisierungsserver bekannt ist.

Eigenschaft	Wert
Parameter group:	Single Sign On (SSO) Arguments

--cpu

CPU-Ressourcenmenge. Sollte 500m oder die Anzahl der CPU-Kerne sein.

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

Bei "true" wird das Zertifikat in der TLS-Verbindung von Gateway zu App überprüft.

Eigenschaft	Wert
Parameter group:	Client Certificate Authentication Arguments
Zulässige Werte:	false, true

--enable-response-cache

Aktivieren Sie die Einstellungen für den Antwortcache im Spring Cloud Gateway.

Eigenschaft	Wert
Parameter group:	Response Cache Arguments
Zulässige Werte:	false, true

--exposed-headers

Durch Trennzeichen getrennte Liste der HTTP-Antwortheader, die für standortübergreifende Anforderungen verfügbar gemacht werden sollen.

Eigenschaft	Wert
Parameter group:	Cross-origin Resource Sharing (CORS) Arguments

--https-only

Bei "true" greifen Sie über https auf den Endpunkt zu.

Eigenschaft	Wert
Zulässige Werte:	false, true

--instance-count

Anzahl der Instanzen.

--issuer-uri

Der URI des Ausstellerbezeichners.

Eigenschaft	Wert
Parameter group:	Single Sign On (SSO) Arguments

--max-age

Wie lange die Antwort einer Vorab-Flight-Anforderung in Sekunden von Clients zwischengespeichert werden kann.

Eigenschaft	Wert
Parameter group:	Cross-origin Resource Sharing (CORS) Arguments

--memory

Menge der Speicherressource. Sollte 512Mi oder #Gi sein, z. B. 1Gi, 3Gi.

--no-wait

Warten Sie nicht, bis der lange ausgeführte Vorgang abgeschlossen ist.

Eigenschaft	Wert
Standardwert:	False

--properties

Nicht vertrauliche Eigenschaften für Umgebungsvariablen. Formatieren Sie "key[=value]" und werden durch Leerzeichen getrennt.

--response-cache-scope

Bereich für den Antwortcache, verfügbare Werte sind [Route, Instanz].

Eigenschaft	Wert
Parameter group:	Response Cache Arguments

--response-cache-size

Maximale Größe des Caches, der bestimmt, ob der Cache einige Einträge entfernen muss. Beispiele sind [1 GB, 10 MB, 100 KB]. Verwenden Sie "Standard" zum Zurücksetzen, und Gateway verwaltet diese Eigenschaft.

Eigenschaft	Wert
Parameter group:	Response Cache Arguments

--response-cache-ttl

Zeit vor Ablauf eines zwischengespeicherten Eintrags. Beispiele sind [1h, 30m, 50s]. Verwenden Sie "Standard" zum Zurücksetzen, und Gateway verwaltet diese Eigenschaft.

Eigenschaft	Wert
Parameter group:	Response Cache Arguments

--scope

Durch Trennzeichen getrennte Liste der spezifischen Aktionen können Anwendungen im Namen eines Benutzers ausführen können.

Eigenschaft	Wert
Parameter group:	Single Sign On (SSO) Arguments

--secrets

Vertrauliche Eigenschaften für Umgebungsvariablen. Nach dem Einfügen wird sie verschlüsselt und nicht zurückgegeben. Formatieren Sie "key[=value]" und werden durch Leerzeichen getrennt.

--server-url

Basis-URL, die API-Consumer für den Zugriff auf APIs in der Gatewayinstanz verwenden.

Eigenschaft	Wert
Parameter group:	API metadata Arguments

Globale Parameter

--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft	Wert
Standardwert:	False

--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft	Wert
Standardwert:	False

--output -o

Output format.

Eigenschaft	Wert
Standardwert:	json
Zulässige Werte:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft	Wert
Standardwert:	False

Freigeben über

az spring gateway

Befehle

az spring gateway clear

Erforderliche Parameter

Optionale Parameter

az spring gateway create

Beispiele

Erforderliche Parameter

Optionale Parameter

az spring gateway delete

Erforderliche Parameter

Optionale Parameter

az spring gateway restart

Beispiele

Erforderliche Parameter

Optionale Parameter

az spring gateway show

Erforderliche Parameter

az spring gateway sync-cert

Beispiele

Erforderliche Parameter

Optionale Parameter

az spring gateway update

Beispiele

Erforderliche Parameter

Optionale Parameter

Feedback