Compartilhar via


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=2023-05-01

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

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

resourceGroupName
path True

string

Nome do grupo de recursos na assinatura do Azure.

Padrão Regex: ^[-\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 é 2023-05-01.

Respostas

Nome Tipo Description
200 OK

Route

OK

Other Status Codes

AfdErrorResponse

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

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

Resposta de exemplo

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

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

Configurações de cache para uma rota do tipo 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 'Enabled' ou 'Disabled'

ErrorAdditionalInfo

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

ErrorDetail

Os detalhes do erro.

ForwardingProtocol

O protocolo que essa regra usará ao encaminhar o tráfego aos back-ends.

httpsRedirect

Decisão de redirecionar automaticamente (ou não) 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 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 nome 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.

Nome Tipo Description
id

string

ID do recurso.

isActive

boolean

Se o recurso está ativo ou inativo

AFDEndpointProtocols

Protocolos com suporte para o ponto de extremidade do cliente.

Nome Tipo Description
Http

string

Https

string

AfdErrorResponse

Resposta de erro

Nome Tipo Description
error

ErrorDetail

O objeto de erro.

AfdProvisioningState

Status de provisionamento

Nome Tipo 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.

Nome Tipo Description
IgnoreQueryString

string

IgnoreSpecifiedQueryStrings

string

IncludeSpecifiedQueryStrings

string

UseQueryString

string

AfdRouteCacheConfiguration

Configurações de cache para uma rota do tipo 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írgulas).

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

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 é 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

Nome Tipo Description
Failed

string

InProgress

string

NotStarted

string

Succeeded

string

EnabledState

Se deseja habilitar o uso dessa regra. Os valores permitidos são 'Enabled' ou 'Disabled'

Nome Tipo Description
Disabled

string

Enabled

string

ErrorAdditionalInfo

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

Os detalhes 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.

ForwardingProtocol

O protocolo que essa regra usará ao encaminhar o tráfego aos back-ends.

Nome Tipo Description
HttpOnly

string

HttpsOnly

string

MatchRequest

string

httpsRedirect

Decisão de redirecionar automaticamente (ou não) 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 que será executada.

Nome Tipo Description
Disabled

string

Enabled

string

IdentityType

O tipo de identidade que cria/modifica recursos

Nome Tipo Description
application

string

key

string

managedIdentity

string

user

string

LinkToDefaultDomain

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

Nome Tipo Description
Disabled

string

Enabled

string

ResourceReference

Referência a outro recurso.

Nome Tipo Description
id

string

ID do recurso.

Route

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

Nome Tipo Valor padrão Description
id

string

ID do recurso.

name

string

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 'Enabled' ou 'Disabled'

properties.endpointName

string

O nome do ponto de extremidade que contém a rota.

properties.forwardingProtocol

ForwardingProtocol

MatchRequest

O protocolo que essa regra usará ao encaminhar o tráfego aos back-ends.

properties.httpsRedirect

httpsRedirect

Disabled

Decisão de redirecionar automaticamente (ou não) 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 que 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 de 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

Ler somente dados do sistema

type

string

Tipo de recurso.

SystemData

Ler somente dados do sistema

Nome Tipo 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

IdentityType

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

IdentityType

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