Routes - Get

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=2021-06-01

Parâmetros de URI

Name In Required Type Description
endpointName
path True
  • string

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

profileName
path True
  • string

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

resourceGroupName
path True
  • string

Nome do grupo de recursos na assinatura do Azure.

Regex pattern: ^[-\w\._\(\)]+$

routeName
path True
  • string

Nome da regra de roteamento.

subscriptionId
path True
  • string

ID de assinatura do Azure.

api-version
query True
  • string

Versão da API a ser usada com a solicitação do cliente. A versão atual é 2021-06-01.

Respostas

Name Type Description
200 OK

OK

Other Status Codes

CDN resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Azure Active Directory Flow OAuth2.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation representar sua conta de usuário

Exemplos

Routes_Get

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdEndpoints/endpoint1/routes/route1?api-version=2021-06-01

Sample Response

{
  "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

ActivatedResourceReference

Referência a outro recurso junto com seu estado.

AfdErrorResponse

Resposta de erro

AfdProvisioningState

Status de 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

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

CompressionSettings

configurações para compactação.

DeploymentStatus
EnabledState

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

ErrorAdditionalInfo

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

ErrorDetail

O detalhe do erro.

ForwardingProtocol

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

httpsRedirect

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

IdentityType

O tipo de identidade que cria/modifica recursos

LinkToDefaultDomain

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

ResourceReference

Referência a outro recurso.

Route

Mapeamento de nomes de Rotas Amigáveis para todas as rotas ou informações relacionadas ao segredo.

SystemData

Ler somente dados do sistema

ActivatedResourceReference

Referência a outro recurso junto com seu estado.

Name Type Description
id
  • string

ID do recurso.

isActive
  • boolean

Se o recurso está ativo ou inativo

AfdErrorResponse

Resposta de erro

Name Type Description
error

O objeto de erro.

AfdProvisioningState

Status de provisionamento

Name Type Description
Creating
  • string
Deleting
  • string
Failed
  • string
Succeeded
  • string
Updating
  • string

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.

Name Type Description
IgnoreQueryString
  • string
IgnoreSpecifiedQueryStrings
  • string
IncludeSpecifiedQueryStrings
  • string
UseQueryString
  • string

AfdRouteCacheConfiguration

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

Name Type Description
compressionSettings

configurações de compactação.

queryParameters
  • string

parâmetros de consulta a serem incluídos ou excluídos (vírgula separada).

queryStringCachingBehavior

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

configurações para compactação.

Name Type 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 é false. 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.

DeploymentStatus

Name Type Description
Failed
  • string
InProgress
  • string
NotStarted
  • string
Succeeded
  • string

EnabledState

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

Name Type Description
Disabled
  • string
Enabled
  • string

ErrorAdditionalInfo

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

Name Type Description
info
  • object

As informações adicionais.

type
  • string

O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Name Type Description
additionalInfo

As informações adicionais do erro.

code
  • string

O código de erro.

details

Os detalhes do erro.

message
  • string

A mensagem de erro.

target
  • string

O destino do erro.

ForwardingProtocol

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

Name Type Description
HttpOnly
  • string
HttpsOnly
  • string
MatchRequest
  • string

httpsRedirect

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

Name Type Description
Disabled
  • string
Enabled
  • string

IdentityType

O tipo de identidade que cria/modifica recursos

Name Type Description
application
  • string
key
  • string
managedIdentity
  • string
user
  • string

LinkToDefaultDomain

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

Name Type Description
Disabled
  • string
Enabled
  • string

ResourceReference

Referência a outro recurso.

Name Type Description
id
  • string

ID do recurso.

Route

Mapeamento de nomes de Rotas Amigáveis para todas as rotas ou informações relacionadas ao segredo.

Name Type Description
id
  • string

ID do recurso.

name
  • string

Nome do recurso.

properties.cacheConfiguration

A configuração de cache para essa rota. Para desabilitar o cache, não forneça um objeto cacheConfiguration.

properties.customDomains

Domínios referenciados por este ponto de extremidade.

properties.deploymentStatus
properties.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

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

properties.httpsRedirect

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

properties.linkToDefaultDomain

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

properties.originGroup

Uma referência ao grupo de origem.

properties.originPath
  • string

Um caminho de diretório sobre a 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

Status de provisionamento

properties.ruleSets

conjuntos de regras referenciados por este ponto de extremidade.

properties.supportedProtocols
  • string[]

Lista de protocolos com suporte para essa rota.

systemData

Ler somente dados do sistema

type
  • string

Tipo de recurso.

SystemData

Ler somente dados do sistema

Name Type Description
createdAt
  • string

O carimbo de data/hora da criação de recursos (UTC)

createdBy
  • string

Um identificador para a identidade que criou o recurso

createdByType

O tipo de identidade que criou o recurso

lastModifiedAt
  • string

O carimbo de data/hora da última modificação do recurso (UTC)

lastModifiedBy
  • string

Um identificador para a identidade que modificou o recurso pela última vez

lastModifiedByType

O tipo de identidade que modificou o recurso pela última vez