Routes - Get

Serviço:: Front Door Service

Versão da API:: 2025-04-15

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

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}/routes/{routeName}?api-version=2025-04-15

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
endpointName	path	True	string	Nome do ponto de extremidade no perfil que é exclusivo globalmente.
profileName	path	True	string minLength: 1 maxLength: 260 pattern: ^[a-zA-Z0-9]+(-[a-zA-Z0-9])$	Nome do Azure Front Door Standard ou Azure Front Door Premium que é exclusivo dentro do grupo de recursos.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
routeName	path	True	string	Nome da regra de roteamento.
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser uma UUID.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Respostas

Nome	Tipo	Description
200 OK	Route	OKEY
Other Status Codes	ErrorResponse	Resposta de erro do Azure Front Door descrevendo por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Routes_Get

Solicitação de exemplo

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdEndpoints/endpoint1/routes/route1?api-version=2025-04-15

Resposta de exemplo

Código de status:: 200

{
  "name": "route1",
  "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdendpoints/endpoint1/routes/route1",
  "type": "Microsoft.Cdn/profiles/afdendpoints/routes",
  "properties": {
    "customDomains": [
      {
        "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/customDomains/domain1"
      }
    ],
    "originGroup": {
      "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/originGroups/originGroup1"
    },
    "originPath": null,
    "ruleSets": [
      {
        "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/ruleSets/ruleSet1"
      }
    ],
    "supportedProtocols": [
      "Https",
      "Http"
    ],
    "patternsToMatch": [
      "/*"
    ],
    "cacheConfiguration": {
      "compressionSettings": {
        "contentTypesToCompress": [
          "text/html",
          "application/octet-stream"
        ],
        "isCompressionEnabled": true
      },
      "queryStringCachingBehavior": "IgnoreQueryString",
      "queryParameters": null
    },
    "forwardingProtocol": "MatchRequest",
    "linkToDefaultDomain": "Enabled",
    "httpsRedirect": "Enabled",
    "enabledState": "Enabled",
    "provisioningState": "Succeeded",
    "deploymentStatus": "NotStarted"
  }
}

Definições

Nome	Description
ActivatedResourceReference	Referência a outro recurso junto com seu estado.
AFDEndpointProtocols	Protocolos com suporte para o ponto de extremidade do cliente.
AfdProvisioningState	Status do provisionamento
afdQueryStringCachingBehavior	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.
AfdRouteCacheConfiguration	Configurações de cache para uma rota de tipo de cache. Para desabilitar o cache, não forneça um objeto cacheConfiguration.
CompressionSettings	configurações para compactação.
createdByType	O tipo de identidade que criou o recurso.
DeploymentStatus
EnabledState	Se deseja habilitar o uso dessa regra. Os valores permitidos são 'Habilitados' ou 'Desabilitados'
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
ForwardingProtocol	Protocolo que essa regra usará ao encaminhar o tráfego para back-ends.
httpsRedirect	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.
LinkToDefaultDomain	se essa rota será vinculada ao domínio de ponto de extremidade padrão.
ResourceReference	Referência a outro recurso.
Route	Mapeamento de nome de Rotas Amigáveis para qualquer informação relacionada a Rotas ou segredo.
systemData	Metadados relativos à criação e última modificação do recurso.

ActivatedResourceReference

Objeto

Referência a outro recurso junto com seu estado.

Nome	Tipo	Description
id	string	ID do recurso.
isActive	boolean	Se o recurso está ativo ou inativo

AFDEndpointProtocols

Enumeração

Protocolos com suporte para o ponto de extremidade do cliente.

Valor	Description
Http
Https

AfdProvisioningState

Enumeração

Status do provisionamento

Valor	Description
Succeeded
Failed
Updating
Deleting
Creating

afdQueryStringCachingBehavior

Enumeração

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.

Valor	Description
IgnoreQueryString
UseQueryString
IgnoreSpecifiedQueryStrings
IncludeSpecifiedQueryStrings

AfdRouteCacheConfiguration

Objeto

Configurações de cache para uma rota de tipo de cache. Para desabilitar o cache, não forneça um objeto cacheConfiguration.

Nome	Tipo	Description
compressionSettings	CompressionSettings	configurações de compactação.
queryParameters	string	parâmetros de consulta a serem incluídos ou excluídos (separados por vírgula).
queryStringCachingBehavior	afdQueryStringCachingBehavior	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.

CompressionSettings

Objeto

configurações para compactação.

Nome	Tipo	Description
contentTypesToCompress	string[]	Lista de tipos de conteúdo nos quais a compactação se aplica. O valor deve ser um tipo MIME válido.
isCompressionEnabled	boolean	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 AzureFrontDoor quando o conteúdo solicitado for menor que 1 byte ou maior que 1 MB.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

DeploymentStatus

Enumeração

Valor	Description
NotStarted
InProgress
Succeeded
Failed

EnabledState

Enumeração

Se deseja habilitar o uso dessa regra. Os valores permitidos são 'Habilitados' ou 'Desabilitados'

Valor	Description
Enabled
Disabled

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

ForwardingProtocol

Enumeração

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

Valor	Description
HttpOnly
HttpsOnly
MatchRequest

httpsRedirect

Enumeração

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.

Valor	Description
Enabled
Disabled

LinkToDefaultDomain

Enumeração

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

Valor	Description
Enabled
Disabled

ResourceReference

Objeto

Referência a outro recurso.

Nome	Tipo	Description
id	string	ID do recurso.

Route

Objeto

Mapeamento de nome de Rotas Amigáveis para qualquer informação relacionada a Rotas ou segredo.

Nome	Tipo	Valor padrão	Description
id	string (arm-id)		ID de recurso totalmente qualificada para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string		O nome do recurso
properties.cacheConfiguration	AfdRouteCacheConfiguration		A configuração de cache para essa rota. Para desabilitar o cache, não forneça um objeto cacheConfiguration.
properties.customDomains	ActivatedResourceReference[]		Domínios referenciados por esse ponto de extremidade.
properties.deploymentStatus	DeploymentStatus
properties.enabledState	EnabledState		Se deseja habilitar o uso dessa regra. Os valores permitidos são 'Habilitados' ou 'Desabilitados'
properties.endpointName	string		O nome do ponto de extremidade que contém a rota.
properties.forwardingProtocol	ForwardingProtocol	MatchRequest	Protocolo que essa regra usará ao encaminhar o tráfego para back-ends.
properties.httpsRedirect	httpsRedirect	Disabled	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.
properties.linkToDefaultDomain	LinkToDefaultDomain	Disabled	se essa rota será vinculada ao domínio de ponto de extremidade padrão.
properties.originGroup	ResourceReference		Uma referência ao grupo de origem.
properties.originPath	string		Um caminho de diretório na origem que o AzureFrontDoor pode usar para recuperar conteúdo, por exemplo, contoso.cloudapp.net/originpath.
properties.patternsToMatch	string[]		Os padrões de rota da regra.
properties.provisioningState	AfdProvisioningState		Status do provisionamento
properties.ruleSets	ResourceReference[]		conjuntos de regras referenciados por esse ponto de extremidade.
properties.supportedProtocols	AFDEndpointProtocols[]	[ "Http", "Https" ]	Lista de protocolos com suporte para essa rota.
systemData	systemData		Metadados do Azure Resource Manager que contêm informações createdBy e modifiedBy.
type	string		O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

systemData

Objeto

Metadados relativos à criação e última modificação do recurso.

Nome	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

Compartilhar via

Routes - Get

Parâmetros de URI

Respostas

Segurança

azure_auth

Escopos

Exemplos

Routes_Get

Solicitação de exemplo

Resposta de exemplo

Definições

ActivatedResourceReference

AFDEndpointProtocols

AfdProvisioningState

afdQueryStringCachingBehavior

AfdRouteCacheConfiguration

CompressionSettings

createdByType

DeploymentStatus

EnabledState

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ForwardingProtocol

httpsRedirect

LinkToDefaultDomain

ResourceReference

Route

systemData