Compartilhar via

az afd route

  • Referência

Gerenciar rotas em um ponto de extremidade AFD.

Comandos

Nome Description Tipo Status
az afd route create

Crie uma nova rota com o nome de rota especificado na assinatura, grupo de recursos, perfil e ponto de extremidade do AzureFrontDoor especificados.

 Núcleo GA
az afd route delete

Exclua uma rota existente com o nome de rota especificado na assinatura, grupo de recursos, perfil e ponto de extremidade do AzureFrontDoor especificados.

 Núcleo GA
az afd route list

Liste todas as origens existentes em um perfil.

 Núcleo GA
az afd route show

Obtenha uma rota existente com o nome de rota especificado na assinatura, grupo de recursos, perfil e ponto de extremidade do AzureFrontDoor especificados.

 Núcleo GA
az afd route update

Atualize uma nova rota com o nome de rota especificado na assinatura, grupo de recursos, perfil e ponto de extremidade do AzureFrontDoor especificados.

 Núcleo GA
az afd route wait

Coloque a CLI em um estado de espera até que uma condição seja atendida.

 Núcleo GA

az afd route create

Crie uma nova rota com o nome de rota especificado na assinatura, grupo de recursos, perfil e ponto de extremidade do AzureFrontDoor especificados.

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]

Exemplos

Cria uma rota para associar o domínio padrão do ponto de extremidade a um grupo de origem para todas as solicitações 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

Cria uma rota para associar o domínio padrão do ponto de extremidade a um grupo de origem para todas as solicitações e usar os conjuntos de regras especificados para personalizar o comportamento da rota.

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

Cria uma rota para associar o domínio padrão do ponto de extremidade e um domínio personalizado a um grupo de origem para todas as solicitações com os padrões de caminho especificados e redirecionar todo o trafic para usar 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

Parâmetros Exigidos

--endpoint-name

Nome do ponto de extremidade no perfil que é exclusivo globalmente.

--name --route-name -n

Nome da regra de roteamento.

--profile-name

Nome do perfil Azure Front Door Standard ou Azure Front Door Premium, que é exclusivo dentro do grupo de recursos.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

--content-types-to-compress

Lista de tipos de conteúdo nos quais a compactação se aplica. Suporte a sintaxe abreviada, arquivo json e yaml-file. Tente "??" para mostrar mais.

--custom-domains

Domínios personalizados referenciados por esse ponto de extremidade. Suporte a sintaxe abreviada, arquivo json e yaml-file. Tente "??" para mostrar mais.

--enable-caching

Indica se o cache está habilitado nessa rota.

Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--enable-compression

Indica se a compactação de conteúdo está habilitada no AzureFrontDoor. O valor padrão é falso. Se a compactação estiver habilitada, o conteúdo será servido como compactado se o usuário solicitar uma versão compactada. O conteúdo não será compactado no AzureFrontDoorwhen que o conteúdo solicitado for menor que 8 MB ou maior que 1 KB.

Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--enabled-state

Se deseja habilitar o uso dessa regra. Os valores permitidos são "Habilitado" ou "Desabilitado".

Valores aceitos: Disabled, Enabled
--forwarding-protocol

Protocolo que essa regra usará ao encaminhar o tráfego para back-ends.

Valores aceitos: HttpOnly, HttpsOnly, MatchRequest
Valor padrão: MatchRequest
--https-redirect

Se será necessário redirecionar automaticamente o tráfego HTTP para o tráfego HTTPS. Observe que essa é uma maneira fácil de configurar essa regra e será a primeira regra a ser executada.

Valores aceitos: Disabled, Enabled
Valor padrão: Disabled
--link-to-default-domain

Se essa rota será vinculada ao domínio de ponto de extremidade padrão.

Valores aceitos: Disabled, Enabled
Valor padrão: Disabled
--no-wait

Não aguarde a conclusão da operação de execução prolongada.

Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--origin-group

Nome ou ID do grupo de origem ao qual ser associado.

--origin-path

Um caminho de diretório na origem que o AzureFrontDoor pode usar para recuperar conteúdo, por exemplo, contoso.cloudapp.net/originpath.

--patterns-to-match

Os padrões de rota da regra. Suporte a sintaxe abreviada, arquivo json e yaml-file. Tente "??" para mostrar mais.

--query-parameters

Parâmetros de consulta a serem incluídos ou excluídos. Suporte a sintaxe abreviada, arquivo json e yaml-file. Tente "??" para mostrar mais.

--query-string-caching-behavior

Define como o Frontdoor armazena em cache solicitações que incluem cadeias de caracteres de consulta. Você pode ignorar todas as cadeias de caracteres de consulta ao armazenar em cache, ignorar cadeias de caracteres de consulta específicas, armazenar em cache cada solicitação com uma URL exclusiva ou armazenar cadeias de caracteres de consulta específicas em cache.

--rule-sets

Coleção de ID ou nome do conjunto de regras referenciado pela rota. Suporte a sintaxe abreviada, arquivo json e yaml-file. Tente "??" para mostrar mais.

--supported-protocols

Lista de protocolos com suporte para essa rota. Suporte a sintaxe abreviada, arquivo json e yaml-file. Tente "??" para mostrar mais.

Valor padrão: ['Http', 'Https']
Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

az afd route delete

Exclua uma rota existente com o nome de rota especificado na assinatura, grupo de recursos, perfil e ponto de extremidade do AzureFrontDoor especificados.

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]

Exemplos

Exclua uma rota chamada route1.

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

Parâmetros Opcionais

--endpoint-name

Nome do ponto de extremidade no perfil que é exclusivo globalmente.

--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

--name --route-name -n

Nome da regra de roteamento.

--no-wait

Não aguarde a conclusão da operação de execução prolongada.

Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--profile-name

Nome do perfil Azure Front Door Standard ou Azure Front Door Premium, que é exclusivo dentro do grupo de recursos.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--yes -y

Não solicite confirmação.

Valor padrão: False
Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

az afd route list

Liste todas as origens existentes em um perfil.

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

Parâmetros Exigidos

--endpoint-name

Nome do ponto de extremidade no perfil que é exclusivo globalmente.

--profile-name

Nome do perfil Azure Front Door Standard ou Azure Front Door Premium, que é exclusivo dentro do grupo de recursos.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

--max-items

Número total de itens a serem retornados na saída do comando. Se o número total de itens disponíveis for maior do que o valor especificado, um token será fornecido na saída do comando. Para retomar a paginação, forneça o valor do token em --next-token argumento de um comando subsequente.

--next-token

Token para especificar onde iniciar a paginação. Esse é o valor do token de uma resposta truncada anteriormente.

Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

az afd route show

Obtenha uma rota existente com o nome de rota especificado na assinatura, grupo de recursos, perfil e ponto de extremidade do AzureFrontDoor especificados.

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

Parâmetros Opcionais

--endpoint-name

Nome do ponto de extremidade no perfil que é exclusivo globalmente.

--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

--name --route-name -n

Nome da regra de roteamento.

--profile-name

Nome do perfil Azure Front Door Standard ou Azure Front Door Premium, que é exclusivo dentro do grupo de recursos.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

az afd route update

Atualize uma nova rota com o nome de rota especificado na assinatura, grupo de recursos, perfil e ponto de extremidade do AzureFrontDoor especificados.

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]

Exemplos

Atualize uma rota para aceitar solicitações Http e Https e redirecionar todo o trafic para usar Https.

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

Atualize as configurações de conjuntos de regras de uma rota para personalizar o comportamento da rota.

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

Atualize as configurações de compactação de uma rota para habilitar a compactação para os tipos de conteúdo especificados.

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

Parâmetros Opcionais

--add

Adicione um objeto a uma lista de objetos especificando um caminho e pares de valor de chave. Exemplo: --add property.listProperty <key=value, string or JSON string>.

--content-types-to-compress

Lista de tipos de conteúdo nos quais a compactação se aplica. Suporte a sintaxe abreviada, arquivo json e yaml-file. Tente "??" para mostrar mais.

--custom-domains

Domínios personalizados referenciados por esse ponto de extremidade. Suporte a sintaxe abreviada, arquivo json e yaml-file. Tente "??" para mostrar mais.

--enable-caching

Indica se o cache está habilitado nessa rota.

Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--enable-compression

Indica se a compactação de conteúdo está habilitada no AzureFrontDoor. O valor padrão é falso. Se a compactação estiver habilitada, o conteúdo será servido como compactado se o usuário solicitar uma versão compactada. O conteúdo não será compactado no AzureFrontDoorwhen que o conteúdo solicitado for menor que 8 MB ou maior que 1 KB.

Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--enabled-state

Se deseja habilitar o uso dessa regra. Os valores permitidos são "Habilitado" ou "Desabilitado".

Valores aceitos: Disabled, Enabled
--endpoint-name

Nome do ponto de extremidade no perfil que é exclusivo globalmente.

--force-string

Ao usar 'set' ou 'add', preserve literais de cadeia de caracteres em vez de tentar converter em JSON.

Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--forwarding-protocol

Protocolo que essa regra usará ao encaminhar o tráfego para back-ends.

Valores aceitos: HttpOnly, HttpsOnly, MatchRequest
--https-redirect

Se será necessário redirecionar automaticamente o tráfego HTTP para o tráfego HTTPS. Observe que essa é uma maneira fácil de configurar essa regra e será a primeira regra a ser executada.

Valores aceitos: Disabled, Enabled
--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

--link-to-default-domain

Se essa rota será vinculada ao domínio de ponto de extremidade padrão.

Valores aceitos: Disabled, Enabled
--name --route-name -n

Nome da regra de roteamento.

--no-wait

Não aguarde a conclusão da operação de execução prolongada.

Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--origin-group

Nome ou ID do grupo de origem ao qual ser associado.

--origin-path

Um caminho de diretório na origem que o AzureFrontDoor pode usar para recuperar conteúdo, por exemplo, contoso.cloudapp.net/originpath.

--patterns-to-match

Os padrões de rota da regra. Suporte a sintaxe abreviada, arquivo json e yaml-file. Tente "??" para mostrar mais.

--profile-name

Nome do perfil Azure Front Door Standard ou Azure Front Door Premium, que é exclusivo dentro do grupo de recursos.

--query-parameters

Parâmetros de consulta a serem incluídos ou excluídos. Suporte a sintaxe abreviada, arquivo json e yaml-file. Tente "??" para mostrar mais.

--query-string-caching-behavior

Define como o Frontdoor armazena em cache solicitações que incluem cadeias de caracteres de consulta. Você pode ignorar todas as cadeias de caracteres de consulta ao armazenar em cache, ignorar cadeias de caracteres de consulta específicas, armazenar em cache cada solicitação com uma URL exclusiva ou armazenar cadeias de caracteres de consulta específicas em cache.

--remove

Remova uma propriedade ou um elemento de uma lista. Exemplo: --remove property.list <indexToRemove> OR --remove propertyToRemove.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--rule-sets

Coleção de ID ou nome do conjunto de regras referenciado pela rota. Suporte a sintaxe abreviada, arquivo json e yaml-file. Tente "??" para mostrar mais.

--set

Atualize um objeto especificando um caminho de propriedade e um valor a ser definido. Exemplo: --set property1.property2=<value>.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--supported-protocols

Lista de protocolos com suporte para essa rota. Suporte a sintaxe abreviada, arquivo json e yaml-file. Tente "??" para mostrar mais.

Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

az afd route wait

Coloque a CLI em um estado de espera até que uma condição seja atendida.

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

Parâmetros Opcionais

--created

Aguarde até ser criado com 'provisioningState' em 'Succeeded'.

Valor padrão: False
--custom

Aguarde até que a condição atenda a uma consulta JMESPath personalizada. Por exemplo, provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Aguarde até ser excluído.

Valor padrão: False
--endpoint-name

Nome do ponto de extremidade no perfil que é exclusivo globalmente.

--exists

Aguarde até que o recurso exista.

Valor padrão: False
--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

--interval

Intervalo de sondagem em segundos.

Valor padrão: 30
--name --route-name -n

Nome da regra de roteamento.

--profile-name

Nome do perfil Azure Front Door Standard ou Azure Front Door Premium, que é exclusivo dentro do grupo de recursos.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--timeout

Espera máxima em segundos.

Valor padrão: 3600
--updated

Aguarde até que seja atualizado com provisioningState em 'Succeeded'.

Valor padrão: False
Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.