Routes - Get

Servicio:: Front Door Service

Versión de la API:: 2025-04-15

Obtiene una ruta existente con el nombre de ruta especificado en la suscripción, el grupo de recursos, el perfil y el punto de conexión de 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 identificador URI

Nombre	En	Requerido	Tipo	Description
endpointName	path	True	string	Nombre del punto de conexión en el perfil que es único globalmente.
profileName	path	True	string minLength: 1 maxLength: 260 pattern: ^[a-zA-Z0-9]+(-[a-zA-Z0-9])$	Nombre de Azure Front Door Standard o Azure Front Door Premium que es único dentro del grupo de recursos.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
routeName	path	True	string	Nombre de la regla de enrutamiento.
subscriptionId	path	True	string (uuid)	Identificador de la suscripción de destino. El valor debe ser un UUID.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Respuestas

Nombre	Tipo	Description
200 OK	Route	De acuerdo
Other Status Codes	ErrorResponse	Respuesta de error de Azure Front Door que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

Routes_Get

Solicitud de ejemplo

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

Respuesta de muestra

status code:: 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"
  }
}

Definiciones

Nombre	Description
ActivatedResourceReference	Referencia a otro recurso junto con su estado.
AFDEndpointProtocols	Protocolos admitidos para el punto de conexión del cliente.
AfdProvisioningState	Estado de aprovisionamiento
afdQueryStringCachingBehavior	Define cómo Frontdoor almacena en caché las solicitudes que incluyen cadenas de consulta. Puede omitir cualquier cadena de consulta al almacenar en caché, omitir cadenas de consulta específicas, almacenar en caché todas las solicitudes con una dirección URL única o almacenar en caché cadenas de consulta específicas.
AfdRouteCacheConfiguration	Configuración de almacenamiento en caché para una ruta de tipo de almacenamiento en caché. Para deshabilitar el almacenamiento en caché, no proporcione un objeto cacheConfiguration.
CompressionSettings	configuración para la compresión.
createdByType	Tipo de identidad que creó el recurso.
DeploymentStatus
EnabledState	Indica si se va a habilitar el uso de esta regla. Los valores permitidos son "Enabled" o "Disabled"
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
ForwardingProtocol	Protocolo que usará esta regla al reenviar el tráfico a los back-end.
httpsRedirect	Indica si se redirige automáticamente el tráfico HTTP al tráfico HTTPS. Tenga en cuenta que esta es una manera fácil de configurar esta regla y será la primera regla que se ejecuta.
LinkToDefaultDomain	si esta ruta se vinculará al dominio de punto de conexión predeterminado.
ResourceReference	Referencia a otro recurso.
Route	Asignación de nombres de rutas descriptivos a cualquier información relacionada con rutas o secretos.
systemData	Metadatos relativos a la creación y última modificación del recurso.

ActivatedResourceReference

Object

Referencia a otro recurso junto con su estado.

Nombre	Tipo	Description
id	string	Identificador de recurso.
isActive	boolean	Si el recurso está activo o inactivo

AFDEndpointProtocols

Enumeración

Protocolos admitidos para el punto de conexión del cliente.

Valor	Description
Http
Https

AfdProvisioningState

Enumeración

Estado de aprovisionamiento

Valor	Description
Succeeded
Failed
Updating
Deleting
Creating

afdQueryStringCachingBehavior

Enumeración

Define cómo Frontdoor almacena en caché las solicitudes que incluyen cadenas de consulta. Puede omitir cualquier cadena de consulta al almacenar en caché, omitir cadenas de consulta específicas, almacenar en caché todas las solicitudes con una dirección URL única o almacenar en caché cadenas de consulta específicas.

Valor	Description
IgnoreQueryString
UseQueryString
IgnoreSpecifiedQueryStrings
IncludeSpecifiedQueryStrings

AfdRouteCacheConfiguration

Object

Configuración de almacenamiento en caché para una ruta de tipo de almacenamiento en caché. Para deshabilitar el almacenamiento en caché, no proporcione un objeto cacheConfiguration.

Nombre	Tipo	Description
compressionSettings	CompressionSettings	configuración de compresión.
queryParameters	string	parámetros de consulta para incluir o excluir (separados por comas).
queryStringCachingBehavior	afdQueryStringCachingBehavior	Define cómo Frontdoor almacena en caché las solicitudes que incluyen cadenas de consulta. Puede omitir cualquier cadena de consulta al almacenar en caché, omitir cadenas de consulta específicas, almacenar en caché todas las solicitudes con una dirección URL única o almacenar en caché cadenas de consulta específicas.

CompressionSettings

Object

configuración para la compresión.

Nombre	Tipo	Description
contentTypesToCompress	string[]	Lista de tipos de contenido en los que se aplica la compresión. El valor debe ser un tipo MIME válido.
isCompressionEnabled	boolean	Indica si la compresión de contenido está habilitada en AzureFrontDoor. El valor predeterminado es Falso. Si la compresión está habilitada, el contenido se servirá como comprimido si el usuario solicita una versión comprimida. El contenido no se comprimirá en AzureFrontDoor cuando el contenido solicitado sea inferior a 1 byte o superior a 1 MB.

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor	Description
User
Application
ManagedIdentity
Key

DeploymentStatus

Enumeración

Valor	Description
NotStarted
InProgress
Succeeded
Failed

EnabledState

Enumeración

Indica si se va a habilitar el uso de esta regla. Los valores permitidos son "Enabled" o "Disabled"

Valor	Description
Enabled
Disabled

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

ForwardingProtocol

Enumeración

Protocolo que usará esta regla al reenviar el tráfico a los back-end.

Valor	Description
HttpOnly
HttpsOnly
MatchRequest

httpsRedirect

Enumeración

Indica si se redirige automáticamente el tráfico HTTP al tráfico HTTPS. Tenga en cuenta que esta es una manera fácil de configurar esta regla y será la primera regla que se ejecuta.

Valor	Description
Enabled
Disabled

LinkToDefaultDomain

Enumeración

si esta ruta se vinculará al dominio de punto de conexión predeterminado.

Valor	Description
Enabled
Disabled

ResourceReference

Object

Referencia a otro recurso.

Nombre	Tipo	Description
id	string	Identificador de recurso.

Route

Object

Asignación de nombres de rutas descriptivos a cualquier información relacionada con rutas o secretos.

Nombre	Tipo	Valor predeterminado	Description
id	string (arm-id)		Identificador de recurso completo para el recurso. Por ejemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string		Nombre del recurso
properties.cacheConfiguration	AfdRouteCacheConfiguration		Configuración de almacenamiento en caché para esta ruta. Para deshabilitar el almacenamiento en caché, no proporcione un objeto cacheConfiguration.
properties.customDomains	ActivatedResourceReference[]		Dominios a los que hace referencia este punto de conexión.
properties.deploymentStatus	DeploymentStatus
properties.enabledState	EnabledState		Indica si se va a habilitar el uso de esta regla. Los valores permitidos son "Enabled" o "Disabled"
properties.endpointName	string		Nombre del punto de conexión que contiene la ruta.
properties.forwardingProtocol	ForwardingProtocol	MatchRequest	Protocolo que usará esta regla al reenviar el tráfico a los back-end.
properties.httpsRedirect	httpsRedirect	Disabled	Indica si se redirige automáticamente el tráfico HTTP al tráfico HTTPS. Tenga en cuenta que esta es una manera fácil de configurar esta regla y será la primera regla que se ejecuta.
properties.linkToDefaultDomain	LinkToDefaultDomain	Disabled	si esta ruta se vinculará al dominio de punto de conexión predeterminado.
properties.originGroup	ResourceReference		Referencia al grupo de origen.
properties.originPath	string		Ruta de acceso de directorio en el origen que AzureFrontDoor puede usar para recuperar contenido, por ejemplo, contoso.cloudapp.net/originpath.
properties.patternsToMatch	string[]		Patrones de ruta de la regla.
properties.provisioningState	AfdProvisioningState		Estado de aprovisionamiento
properties.ruleSets	ResourceReference[]		conjuntos de reglas a los que hace referencia este punto de conexión.
properties.supportedProtocols	AFDEndpointProtocols[]	[ "Http", "Https" ]	Lista de protocolos admitidos para esta ruta.
systemData	systemData		Metadatos de Azure Resource Manager que contienen información createdBy y modifiedBy.
type	string		Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

systemData

Object

Metadatos relativos a la creación y última modificación del recurso.

Nombre	Tipo	Description
createdAt	string (date-time)	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string (date-time)	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.

Compartir a través de

Routes - Get

Parámetros de identificador URI

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

Routes_Get

Solicitud de ejemplo

Respuesta de muestra

Definiciones

ActivatedResourceReference

AFDEndpointProtocols

AfdProvisioningState

afdQueryStringCachingBehavior

AfdRouteCacheConfiguration

CompressionSettings

createdByType

DeploymentStatus

EnabledState

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ForwardingProtocol

httpsRedirect

LinkToDefaultDomain

ResourceReference

Route

systemData