az afd route

  • Référence

Gérer les itinéraires sous un point de terminaison AFD.

Commandes

Nom Description Type Statut
az afd route create

Créez un itinéraire avec le nom de route spécifié sous l’abonnement, le groupe de ressources, le profil et le point de terminaison AzureFrontDoor spécifiés.

 Core GA
az afd route delete

Supprimez un itinéraire existant avec le nom de route spécifié sous l’abonnement, le groupe de ressources, le profil et le point de terminaison AzureFrontDoor spécifiés.

 Core GA
az afd route list

Répertorier toutes les origines existantes dans un profil.

 Core GA
az afd route show

Obtenez un itinéraire existant avec le nom de route spécifié sous l’abonnement, le groupe de ressources, le profil et le point de terminaison AzureFrontDoor spécifiés.

 Core GA
az afd route update

Mettez à jour un nouvel itinéraire avec le nom de route spécifié sous l’abonnement, le groupe de ressources, le profil et le point de terminaison AzureFrontDoor spécifiés.

 Core GA
az afd route wait

Placez l’interface CLI dans un état d’attente jusqu’à ce qu’une condition soit remplie.

 Core GA

az afd route create

Créez un itinéraire avec le nom de route spécifié sous l’abonnement, le groupe de ressources, le profil et le point de terminaison AzureFrontDoor spécifiés.

az afd route create --endpoint-name
                    --name
                    --profile-name
                    --resource-group
                    [--content-types-to-compress]
                    [--custom-domains]
                    [--enable-caching {0, 1, f, false, n, no, t, true, y, yes}]
                    [--enable-compression {0, 1, f, false, n, no, t, true, y, yes}]
                    [--enabled-state {Disabled, Enabled}]
                    [--forwarding-protocol {HttpOnly, HttpsOnly, MatchRequest}]
                    [--https-redirect {Disabled, Enabled}]
                    [--link-to-default-domain {Disabled, Enabled}]
                    [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                    [--origin-group]
                    [--origin-path]
                    [--patterns-to-match]
                    [--query-parameters]
                    [--query-string-caching-behavior]
                    [--rule-sets]
                    [--supported-protocols]

Exemples

Crée un itinéraire pour associer le domaine par défaut du point de terminaison à un groupe d’origines pour toutes les requêtes HTTPS.

az afd route create -g group --endpoint-name endpoint1 --profile-name profile --route-name route1 --https-redirect Disabled --origin-group og001 --supported-protocols Https --link-to-default-domain Enabled --forwarding-protocol MatchRequest

Crée un itinéraire pour associer le domaine par défaut du point de terminaison à un groupe d’origines pour toutes les requêtes et utiliser les ensembles de règles spécifiés pour personnaliser le comportement de l’itinéraire.

az afd route create -g group --endpoint-name endpoint1 --profile-name profile --route-name route1 --rule-sets ruleset1 rulseset2 --origin-group og001 --supported-protocols Http Https --link-to-default-domain Enabled --forwarding-protocol MatchRequest --https-redirect Disabled

Crée un itinéraire pour associer le domaine par défaut du point de terminaison et un domaine personnalisé à un groupe d’origines pour toutes les requêtes avec les modèles de chemin d’accès spécifiés et rediriger tout le trafic pour utiliser Https.

az afd route create -g group --endpoint-name endpoint1 --profile-name profile --route-name route1 --patterns-to-match /test1/* /tes2/* --origin-group og001 --supported-protocols Http Https --custom-domains cd001 --forwarding-protocol MatchRequest --https-redirect Enabled --link-to-default-domain Enabled

Paramètres obligatoires

--endpoint-name

Nom du point de terminaison sous le profil qui est unique globalement.

--name --route-name -n

Nom de la règle de routage.

--profile-name

Nom du profil Azure Front Door Standard ou Azure Front Door Premium qui est unique dans le groupe de ressources.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

Paramètres facultatifs

--content-types-to-compress

Liste des types de contenu sur lesquels la compression s’applique. Prendre en charge la syntaxe abrégée, json-file et yaml-file. Essayez « ?? » pour en montrer plus.

--custom-domains

Domaines personnalisés référencés par ce point de terminaison. Prendre en charge la syntaxe abrégée, json-file et yaml-file. Essayez « ?? » pour en montrer plus.

--enable-caching

Indique si la mise en cache est enanblage sur cet itinéraire.

valeurs acceptées: 0, 1, f, false, n, no, t, true, y, yes
--enable-compression

Indique si la compression de contenu est activée sur AzureFrontDoor. La valeur par défaut est False. Si la compression est activée, le contenu est servi comme compressé si l’utilisateur demande une version compressée. Le contenu ne sera pas compressé sur AzureFrontDoorwhen demandé contenu est inférieur à 1 octet ou supérieur à 1 Mo.

valeurs acceptées: 0, 1, f, false, n, no, t, true, y, yes
--enabled-state

Indique s’il faut activer l’utilisation de cette route. Les valeurs autorisées sont « Enabled » ou « Disabled ».

valeurs acceptées: Disabled, Enabled
--forwarding-protocol

Protocole utilisé par cette règle pour transférer le trafic vers les back-ends.

valeurs acceptées: HttpOnly, HttpsOnly, MatchRequest
valeur par défaut: MatchRequest
--https-redirect

Indique s’il faut rediriger automatiquement le trafic HTTP vers le trafic HTTPS. Notez qu’il s’agit d’un moyen simple de configurer cette règle et qu’il s’agit de la première règle exécutée.

valeurs acceptées: Disabled, Enabled
valeur par défaut: Disabled
--link-to-default-domain

Indique si cette route est liée au domaine de point de terminaison par défaut.

valeurs acceptées: Disabled, Enabled
valeur par défaut: Disabled
--no-wait

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

valeurs acceptées: 0, 1, f, false, n, no, t, true, y, yes
--origin-group

Nom ou ID du groupe d’origine à associer.

--origin-path

Chemin d’accès au répertoire sur l’origine à partir duquel AzureFrontDoor peut utiliser pour récupérer du contenu, par exemple contoso.cloudapp.net/originpath.

--patterns-to-match

Modèles d’itinéraire de la règle. Prendre en charge la syntaxe abrégée, json-file et yaml-file. Essayez « ?? » pour en montrer plus.

--query-parameters

Interroger les paramètres à inclure ou exclure. Prendre en charge la syntaxe abrégée, json-file et yaml-file. Essayez « ?? » pour en montrer plus.

--query-string-caching-behavior

Définit la façon dont Frontdoor met en cache les requêtes qui incluent des chaînes de requête. Vous pouvez ignorer toutes les chaînes de requête lors de la mise en cache, ignorer des chaînes de requête spécifiques, mettre en cache chaque requête avec une URL unique ou mettre en cache des chaînes de requête spécifiques.

--rule-sets

Collection d’ID ou de nom du jeu de règles référencé par l’itinéraire. Prendre en charge la syntaxe abrégée, json-file et yaml-file. Essayez « ?? » pour en montrer plus.

--supported-protocols

Liste des protocoles pris en charge pour cette route. Prendre en charge la syntaxe abrégée, json-file et yaml-file. Essayez « ?? » pour en montrer plus.

valeur par défaut: ['Http', 'Https']
Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes 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 en utilisant az account set -s NAME_OR_ID.

--verbose

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

az afd route delete

Supprimez un itinéraire existant avec le nom de route spécifié sous l’abonnement, le groupe de ressources, le profil et le point de terminaison AzureFrontDoor spécifiés.

az afd route delete [--endpoint-name]
                    [--ids]
                    [--name]
                    [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                    [--profile-name]
                    [--resource-group]
                    [--subscription]
                    [--yes]

Exemples

Supprimez un itinéraire nommé route1.

az afd route delete -g group --profile-name profile --endpoint-name endpoint1 --route-name route1

Paramètres facultatifs

--endpoint-name

Nom du point de terminaison sous le profil qui est unique globalement.

--ids

Un ou plusieurs ID de ressource (délimités par des espaces). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».

--name --route-name -n

Nom de la règle de routage.

--no-wait

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

valeurs acceptées: 0, 1, f, false, n, no, t, true, y, yes
--profile-name

Nom du profil Azure Front Door Standard ou Azure Front Door Premium qui est unique dans le groupe de ressources.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--subscription

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

--yes -y

Ne pas demander de confirmation.

valeur par défaut: False
Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes 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 en utilisant az account set -s NAME_OR_ID.

--verbose

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

az afd route list

Répertorier toutes les origines existantes dans un profil.

az afd route list --endpoint-name
                  --profile-name
                  --resource-group
                  [--max-items]
                  [--next-token]

Paramètres obligatoires

--endpoint-name

Nom du point de terminaison sous le profil qui est unique globalement.

--profile-name

Nom du profil Azure Front Door Standard ou Azure Front Door Premium qui est unique dans le groupe de ressources.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

Paramètres facultatifs

--max-items

Nombre total d’éléments à retourner dans la sortie de la commande. Si le nombre total d’éléments disponibles est supérieur à la valeur spécifiée, un jeton est fourni dans la sortie de la commande. Pour reprendre la pagination, fournissez la valeur du jeton dans --next-token l’argument d’une commande suivante.

--next-token

Jeton pour spécifier où commencer la pagination. Il s’agit de la valeur du jeton d’une réponse tronquée précédemment.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes 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 en utilisant az account set -s NAME_OR_ID.

--verbose

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

az afd route show

Obtenez un itinéraire existant avec le nom de route spécifié sous l’abonnement, le groupe de ressources, le profil et le point de terminaison AzureFrontDoor spécifiés.

az afd route show [--endpoint-name]
                  [--ids]
                  [--name]
                  [--profile-name]
                  [--resource-group]
                  [--subscription]

Paramètres facultatifs

--endpoint-name

Nom du point de terminaison sous le profil qui est unique globalement.

--ids

Un ou plusieurs ID de ressource (délimités par des espaces). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».

--name --route-name -n

Nom de la règle de routage.

--profile-name

Nom du profil Azure Front Door Standard ou Azure Front Door Premium qui est unique dans le groupe de ressources.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--subscription

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

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes 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 en utilisant az account set -s NAME_OR_ID.

--verbose

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

az afd route update

Mettez à jour un nouvel itinéraire avec le nom de route spécifié sous l’abonnement, le groupe de ressources, le profil et le point de terminaison AzureFrontDoor spécifiés.

az afd route update [--add]
                    [--content-types-to-compress]
                    [--custom-domains]
                    [--enable-caching {0, 1, f, false, n, no, t, true, y, yes}]
                    [--enable-compression {0, 1, f, false, n, no, t, true, y, yes}]
                    [--enabled-state {Disabled, Enabled}]
                    [--endpoint-name]
                    [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                    [--forwarding-protocol {HttpOnly, HttpsOnly, MatchRequest}]
                    [--https-redirect {Disabled, Enabled}]
                    [--ids]
                    [--link-to-default-domain {Disabled, Enabled}]
                    [--name]
                    [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                    [--origin-group]
                    [--origin-path]
                    [--patterns-to-match]
                    [--profile-name]
                    [--query-parameters]
                    [--query-string-caching-behavior]
                    [--remove]
                    [--resource-group]
                    [--rule-sets]
                    [--set]
                    [--subscription]
                    [--supported-protocols]

Exemples

Mettez à jour un itinéraire pour accepter à la fois les requêtes Http et Https et rediriger tout le trafic pour utiliser Https.

az afd route update -g group --endpoint-name endpoint1 --profile-name profile --route-name route1 --supported-protocols Http Https --https-redirect Enabled

Mettez à jour les paramètres des ensembles de règles d’un itinéraire pour personnaliser le comportement de l’itinéraire.

az afd route update -g group --endpoint-name endpoint1 --profile-name profile --route-name route1 --rule-sets ruleset1 rulseset2

Mettez à jour les paramètres de compression d’un itinéraire pour activer la compression pour les types de contenu spécifiés.

az afd route update -g group --endpoint-name endpoint1 --profile-name profile --route-name route1 --query-string-caching-behavior IgnoreQueryString --enable-compression true --content-types-to-compress text/javascript text/plain

Paramètres facultatifs

--add

Ajoutez un objet à une liste d’objets en spécifiant un chemin d’accès et des paires clé-valeur. Exemple : --add property.listProperty <key=value, string ou JSON string>.

--content-types-to-compress

Liste des types de contenu sur lesquels la compression s’applique. Prendre en charge la syntaxe abrégée, json-file et yaml-file. Essayez « ?? » pour en montrer plus.

--custom-domains

Domaines personnalisés référencés par ce point de terminaison. Prendre en charge la syntaxe abrégée, json-file et yaml-file. Essayez « ?? » pour en montrer plus.

--enable-caching

Indique si la mise en cache est enanblage sur cet itinéraire.

valeurs acceptées: 0, 1, f, false, n, no, t, true, y, yes
--enable-compression

Indique si la compression de contenu est activée sur AzureFrontDoor. La valeur par défaut est false. Si la compression est activée, le contenu est servi comme compressé si l’utilisateur demande une version compressée. Le contenu ne sera pas compressé sur AzureFrontDoorwhen demandé contenu est inférieur à 1 octet ou supérieur à 1 Mo.

valeurs acceptées: 0, 1, f, false, n, no, t, true, y, yes
--enabled-state

Indique s’il faut activer l’utilisation de cette route. Les valeurs autorisées sont « Enabled » ou « Disabled ».

valeurs acceptées: Disabled, Enabled
--endpoint-name

Nom du point de terminaison sous le profil qui est unique globalement.

--force-string

Lorsque vous utilisez « set » ou « add », conservez les littéraux de chaîne au lieu de tenter de convertir en JSON.

valeurs acceptées: 0, 1, f, false, n, no, t, true, y, yes
--forwarding-protocol

Protocole utilisé par cette règle pour transférer le trafic vers les back-ends.

valeurs acceptées: HttpOnly, HttpsOnly, MatchRequest
--https-redirect

Indique s’il faut rediriger automatiquement le trafic HTTP vers le trafic HTTPS. Notez qu’il s’agit d’un moyen simple de configurer cette règle et qu’il s’agit de la première règle exécutée.

valeurs acceptées: Disabled, Enabled
--ids

Un ou plusieurs ID de ressource (délimités par des espaces). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».

--link-to-default-domain

Indique si cette route est liée au domaine de point de terminaison par défaut.

valeurs acceptées: Disabled, Enabled
--name --route-name -n

Nom de la règle de routage.

--no-wait

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

valeurs acceptées: 0, 1, f, false, n, no, t, true, y, yes
--origin-group

Nom ou ID du groupe d’origine à associer.

--origin-path

Chemin d’accès au répertoire sur l’origine à partir duquel AzureFrontDoor peut utiliser pour récupérer du contenu, par exemple contoso.cloudapp.net/originpath.

--patterns-to-match

Modèles d’itinéraire de la règle. Prendre en charge la syntaxe abrégée, json-file et yaml-file. Essayez « ?? » pour en montrer plus.

--profile-name

Nom du profil Azure Front Door Standard ou Azure Front Door Premium qui est unique dans le groupe de ressources.

--query-parameters

Interroger les paramètres à inclure ou exclure. Prendre en charge la syntaxe abrégée, json-file et yaml-file. Essayez « ?? » pour en montrer plus.

--query-string-caching-behavior

Définit la façon dont Frontdoor met en cache les requêtes qui incluent des chaînes de requête. Vous pouvez ignorer toutes les chaînes de requête lors de la mise en cache, ignorer des chaînes de requête spécifiques, mettre en cache chaque requête avec une URL unique ou mettre en cache des chaînes de requête spécifiques.

--remove

Supprimez une propriété ou un élément d’une liste. Exemple : --remove property.list OR --remove propertyToRemove.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--rule-sets

Collection d’ID ou de nom du jeu de règles référencé par l’itinéraire. Prendre en charge la syntaxe abrégée, json-file et yaml-file. Essayez « ?? » pour en montrer plus.

--set

Mettez à jour un objet en spécifiant un chemin d’accès et une valeur de propriété à définir. Exemple : --set property1.property2=.

--subscription

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

--supported-protocols

Liste des protocoles pris en charge pour cette route. Prendre en charge la syntaxe abrégée, json-file et yaml-file. Essayez « ?? » pour en montrer plus.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes 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 en utilisant az account set -s NAME_OR_ID.

--verbose

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

az afd route wait

Placez l’interface CLI dans un état d’attente jusqu’à ce qu’une condition soit remplie.

az afd route wait [--created]
                  [--custom]
                  [--deleted]
                  [--endpoint-name]
                  [--exists]
                  [--ids]
                  [--interval]
                  [--name]
                  [--profile-name]
                  [--resource-group]
                  [--subscription]
                  [--timeout]
                  [--updated]

Paramètres facultatifs

--created

Attendez la création avec « provisioningState » sur « Succeeded ».

valeur par défaut: False
--custom

Attendez que la condition réponde à une requête JMESPath personnalisée. Par exemple, provisioningState !='InProgress', instanceView.statuses[ ?code=='PowerState/running'].

--deleted

Attendez la suppression.

valeur par défaut: False
--endpoint-name

Nom du point de terminaison sous le profil qui est unique globalement.

--exists

Attendez que la ressource existe.

valeur par défaut: False
--ids

Un ou plusieurs ID de ressource (délimités par des espaces). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».

--interval

Intervalle d’interrogation en secondes.

valeur par défaut: 30
--name --route-name -n

Nom de la règle de routage.

--profile-name

Nom du profil Azure Front Door Standard ou Azure Front Door Premium qui est unique dans le groupe de ressources.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--subscription

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

--timeout

Délai maximal d’attente en secondes.

valeur par défaut: 3600
--updated

Attendez la mise à jour avec provisioningState sur « Réussi ».

valeur par défaut: False
Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes 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 en utilisant az account set -s NAME_OR_ID.

--verbose

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