Partager via

az spring gateway

  • Déprécié

Remarque

Cette référence fait partie de l’extension spring pour Azure CLI (version 2.56.0 ou ultérieure). L’extension installe automatiquement la première fois que vous exécutez une commande az spring gateway. En savoir plus sur les extensions.

Ce groupe de commandes est implicitement déconseillé, car le groupe de commandes « spring » est déconseillé et sera supprimé dans une version ultérieure.

(Niveau Entreprise uniquement) Commandes permettant de gérer la passerelle dans Azure Spring Apps.

Commandes

Nom Description Type État
az spring gateway clear

Effacez tous les paramètres de la passerelle.

 Extension Deprecated
az spring gateway create

Créez Spring Cloud Gateway.

 Extension Deprecated
az spring gateway custom-domain

Commandes permettant de gérer des domaines personnalisés pour la passerelle.

 Extension Deprecated
az spring gateway custom-domain bind

Lier un domaine personnalisé à la passerelle.

 Extension Deprecated
az spring gateway custom-domain list

Répertorier tous les domaines personnalisés de la passerelle.

 Extension Deprecated
az spring gateway custom-domain show

Afficher les détails d’un domaine personnalisé.

 Extension Deprecated
az spring gateway custom-domain unbind

Dissociez un domaine personnalisé de la passerelle.

 Extension Deprecated
az spring gateway custom-domain update

Mettez à jour un domaine personnalisé de la passerelle.

 Extension Deprecated
az spring gateway delete

Supprimez Spring Cloud Gateway.

 Extension Deprecated
az spring gateway restart

Redémarrez Spring Cloud Gateway.

 Extension Deprecated
az spring gateway route-config

Commandes pour gérer les configurations de routage de passerelle dans Azure Spring Apps.

 Extension Deprecated
az spring gateway route-config create

Créez une configuration d’itinéraire de passerelle avec des règles de routage au format de tableau Json.

 Extension Deprecated
az spring gateway route-config list

Répertorier toutes les configurations de routage de passerelle existantes.

 Extension Deprecated
az spring gateway route-config remove

Supprimez une configuration d’itinéraire de passerelle existante.

 Extension Deprecated
az spring gateway route-config show

Obtenir une configuration d’itinéraire de passerelle existante.

 Extension Deprecated
az spring gateway route-config update

Mettez à jour une configuration d’itinéraire de passerelle existante avec des règles de routage au format de tableau Json.

 Extension Deprecated
az spring gateway show

Affichez les paramètres, l’état d’approvisionnement et l’état d’exécution de la passerelle.

 Extension Deprecated
az spring gateway sync-cert

Synchroniser le certificat de passerelle.

 Extension Deprecated
az spring gateway update

Mettez à jour les propriétés d’une passerelle existante.

 Extension Deprecated

az spring gateway clear

Déprécié

Cette commande est implicitement déconseillée, car le groupe de commandes « spring » est déconseillé et sera supprimé dans une version ultérieure.

Effacez tous les paramètres de la passerelle.

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

Paramètres obligatoires

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

--service -s

Nom de l’instance Azure Spring Apps, vous pouvez configurer le service par défaut à l’aide de az configure --defaults spring=<name>.

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--no-wait

Ne pas attendre la fin de l’opération de longue durée.

Propriété Valeur
Valeur par défaut: False
Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut à l’aide de az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.

Propriété Valeur
Valeur par défaut: False

az spring gateway create

Déprécié

Cette commande est implicitement déconseillée, car le groupe de commandes « spring » est déconseillé et sera supprimé dans une version ultérieure.

Créez Spring Cloud Gateway.

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

Exemples

Créez Spring Cloud Gateway.

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

Paramètres obligatoires

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

--service -s

Nom de l’instance Azure Spring Apps, vous pouvez configurer le service par défaut à l’aide de az configure --defaults spring=<name>.

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--instance-count

Nombre d’instances.

Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut à l’aide de az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.

Propriété Valeur
Valeur par défaut: False

az spring gateway delete

Déprécié

Cette commande est implicitement déconseillée, car le groupe de commandes « spring » est déconseillé et sera supprimé dans une version ultérieure.

Supprimez Spring Cloud Gateway.

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

Paramètres obligatoires

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

--service -s

Nom de l’instance Azure Spring Apps, vous pouvez configurer le service par défaut à l’aide de az configure --defaults spring=<name>.

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--yes -y

N’invitez pas à confirmer.

Propriété Valeur
Valeur par défaut: False
Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut à l’aide de az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.

Propriété Valeur
Valeur par défaut: False

az spring gateway restart

Déprécié

Cette commande est implicitement déconseillée, car le groupe de commandes « spring » est déconseillé et sera supprimé dans une version ultérieure.

Redémarrez Spring Cloud Gateway.

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

Exemples

Redémarrez Spring Cloud Gateway.

az spring gateway restart -s MyService -g MyResourceGroup

Paramètres obligatoires

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

--service -s

Nom de l’instance Azure Spring Apps, vous pouvez configurer le service par défaut à l’aide de az configure --defaults spring=<name>.

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--no-wait

Ne pas attendre la fin de l’opération de longue durée.

Propriété Valeur
Valeur par défaut: False
--yes -y

N’invitez pas à confirmer.

Propriété Valeur
Valeur par défaut: False
Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut à l’aide de az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.

Propriété Valeur
Valeur par défaut: False

az spring gateway show

Déprécié

Cette commande est implicitement déconseillée, car le groupe de commandes « spring » est déconseillé et sera supprimé dans une version ultérieure.

Affichez les paramètres, l’état d’approvisionnement et l’état d’exécution de la passerelle.

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

Paramètres obligatoires

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

--service -s

Nom de l’instance Azure Spring Apps, vous pouvez configurer le service par défaut à l’aide de az configure --defaults spring=<name>.

Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut à l’aide de az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.

Propriété Valeur
Valeur par défaut: False

az spring gateway sync-cert

Déprécié

Cette commande est implicitement déconseillée, car le groupe de commandes « spring » est déconseillé et sera supprimé dans une version ultérieure.

Synchroniser le certificat de passerelle.

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

Exemples

Synchroniser le certificat de passerelle.

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

Paramètres obligatoires

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

--service -s

Nom de l’instance Azure Spring Apps, vous pouvez configurer le service par défaut à l’aide de az configure --defaults spring=<name>.

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--no-wait

Ne pas attendre la fin de l’opération de longue durée.

Propriété Valeur
Valeur par défaut: False
--yes -y

N’invitez pas à confirmer.

Propriété Valeur
Valeur par défaut: False
Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut à l’aide de az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.

Propriété Valeur
Valeur par défaut: False

az spring gateway update

Déprécié

Cette commande est implicitement déconseillée, car le groupe de commandes « spring » est déconseillé et sera supprimé dans une version ultérieure.

Mettez à jour les propriétés d’une passerelle existante.

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]

Exemples

Mettez à jour la propriété de passerelle.

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

Activez et configurez le cache de réponse au niveau de l’itinéraire et définissez la durée de vie sur 5 minutes.

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

Lorsque le cache de réponse est activé, mettez à jour la durée de vie à 3 minutes.

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

Désactivez le cache de réponse.

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

Paramètres obligatoires

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

--service -s

Nom de l’instance Azure Spring Apps, vous pouvez configurer le service par défaut à l’aide de az configure --defaults spring=<name>.

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--addon-configs-file

Chemin d’accès au fichier de la chaîne JSON des configurations de module complémentaire.

Propriété Valeur
Groupe de paramètres: Add-on Configurations Arguments
--addon-configs-json

Chaîne JSON de configurations de module complémentaire.

Propriété Valeur
Groupe de paramètres: Add-on Configurations Arguments
--allow-credentials

Indique si les informations d’identification de l’utilisateur sont prises en charge sur les demandes intersites.

Propriété Valeur
Groupe de paramètres: Cross-origin Resource Sharing (CORS) Arguments
Valeurs acceptées: false, true
--allow-origin-patterns --allowed-origin-patterns

Liste séparée par des virgules des modèles d’origine autorisés pour effectuer des requêtes intersites.

Propriété Valeur
Groupe de paramètres: Cross-origin Resource Sharing (CORS) Arguments
--allowed-headers

Liste séparée par des virgules des en-têtes autorisés dans les requêtes intersites. La valeur spéciale * permet aux demandes réelles d’envoyer n’importe quel en-tête.

Propriété Valeur
Groupe de paramètres: Cross-origin Resource Sharing (CORS) Arguments
--allowed-methods

Liste séparée par des virgules des méthodes HTTP autorisées sur les requêtes intersite. La valeur spéciale * autorise toutes les méthodes.

Propriété Valeur
Groupe de paramètres: Cross-origin Resource Sharing (CORS) Arguments
--allowed-origins

Liste séparée par des virgules des origines autorisées pour effectuer des requêtes intersites. La valeur spéciale * autorise tous les domaines.

Propriété Valeur
Groupe de paramètres: Cross-origin Resource Sharing (CORS) Arguments
--api-description

Description détaillée des API disponibles sur l’instance de passerelle.

Propriété Valeur
Groupe de paramètres: API metadata Arguments
--api-doc-location

Emplacement de la documentation supplémentaire pour les API disponibles sur l’instance de passerelle.

Propriété Valeur
Groupe de paramètres: API metadata Arguments
--api-title

Titre décrivant le contexte des API disponibles sur l’instance de passerelle.

Propriété Valeur
Groupe de paramètres: API metadata Arguments
--api-version

Version des API disponibles sur cette instance de passerelle.

Propriété Valeur
Groupe de paramètres: API metadata Arguments
--apm-types

Liste séparée par l’espace d’APM intégrée à la passerelle. Les valeurs autorisées sont : ApplicationInsights, AppDynamics, Dynatrace, NewRelic, ElasticAPM.

Propriété Valeur
Groupe de paramètres: APM Arguments
--apms

Liste séparée par l’espace des noms de référence APM dans Azure Spring Apps à intégrer à la passerelle.

Propriété Valeur
Groupe de paramètres: APM Arguments
--assign-endpoint

Si la valeur est true, affectez l’URL du point de terminaison pour l’accès direct.

Propriété Valeur
Valeurs acceptées: false, true
--certificate-names

Liste séparée par des virgules des noms de certificats dans Azure Spring Apps.

Propriété Valeur
Groupe de paramètres: Client Certificate Authentication Arguments
--client-id

Identificateur public de l’application.

Propriété Valeur
Groupe de paramètres: Single Sign On (SSO) Arguments
--client-secret

Secret connu uniquement pour l’application et le serveur d’autorisation.

Propriété Valeur
Groupe de paramètres: Single Sign On (SSO) Arguments
--cpu

Quantité de ressources processeur. Doit être de 500 m ou de nombre de cœurs d’UC.

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

Si la valeur est true, vérifiez le certificat dans la connexion TLS de la passerelle à l’application.

Propriété Valeur
Groupe de paramètres: Client Certificate Authentication Arguments
Valeurs acceptées: false, true
--enable-response-cache

Activez les paramètres du cache de réponse dans Spring Cloud Gateway.

Propriété Valeur
Groupe de paramètres: Response Cache Arguments
Valeurs acceptées: false, true
--exposed-headers

Liste séparée par des virgules d’en-têtes de réponse HTTP à exposer pour les requêtes intersites.

Propriété Valeur
Groupe de paramètres: Cross-origin Resource Sharing (CORS) Arguments
--https-only

Si la valeur est true, accédez au point de terminaison via https.

Propriété Valeur
Valeurs acceptées: false, true
--instance-count

Nombre d’instances.

--issuer-uri

URI de l’identificateur de l’émetteur.

Propriété Valeur
Groupe de paramètres: Single Sign On (SSO) Arguments
--max-age

Combien de temps, en secondes, la réponse d’une demande de préversion peut être mise en cache par les clients.

Propriété Valeur
Groupe de paramètres: Cross-origin Resource Sharing (CORS) Arguments
--memory

Quantité de ressources mémoire. Doit être 512Mi ou #Gi, par exemple, 1Gi, 3Gi.

--no-wait

Ne pas attendre la fin de l’opération de longue durée.

Propriété Valeur
Valeur par défaut: False
--properties

Propriétés non sensibles pour les variables d’environnement. Mettez en forme « key[=value] » et séparés par espace.

--response-cache-scope

Étendue pour le cache de réponse, les valeurs disponibles sont [Route, Instance].

Propriété Valeur
Groupe de paramètres: Response Cache Arguments
--response-cache-size

Taille maximale du cache qui détermine si le cache doit supprimer certaines entrées. Les exemples sont [1 Go, 10 Mo, 100 Ko]. Utilisez « par défaut » pour réinitialiser et la passerelle gérera cette propriété.

Propriété Valeur
Groupe de paramètres: Response Cache Arguments
--response-cache-ttl

Heure avant l’expiration d’une entrée mise en cache. Les exemples sont [1h, 30m, 50s]. Utilisez « par défaut » pour réinitialiser et la passerelle gérera cette propriété.

Propriété Valeur
Groupe de paramètres: Response Cache Arguments
--scope

La liste séparée par des virgules des applications d’actions spécifiques peut être autorisée à effectuer au nom d’un utilisateur.

Propriété Valeur
Groupe de paramètres: Single Sign On (SSO) Arguments
--secrets

Propriétés sensibles pour les variables d’environnement. Une fois mis, il sera chiffré et non retourné. Mettez en forme « key[=value] » et séparés par espace.

--server-url

URL de base utilisée par les consommateurs d’API pour accéder aux API sur l’instance de passerelle.

Propriété Valeur
Groupe de paramètres: API metadata Arguments
Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut à l’aide de az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.

Propriété Valeur
Valeur par défaut: False