Routes - Get

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

Parámetros de identificador URI

Name In Required Type Description
endpointName
path True
  • string

Nombre del punto de conexión en el perfil que es único globalmente.

profileName
path True
  • string

Nombre del perfil de Azure Front Door Standard o Azure Front Door Premium que es único dentro del grupo de recursos.

resourceGroupName
path True
  • string

Nombre del grupo de recursos dentro de la suscripción de Azure.

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

routeName
path True
  • string

Nombre de la regla de enrutamiento.

subscriptionId
path True
  • string

Identificador de suscripción de Azure

api-version
query True
  • string

Versión de la API que se va a usar con la solicitud de cliente. La versión actual es 2021-06-01.

Respuestas

Name Type Description
200 OK

Aceptar

Other Status Codes

CDN respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

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 suplantar la cuenta de usuario

Ejemplos

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

Definiciones

ActivatedResourceReference

Referencia a otro recurso junto con su estado.

AfdErrorResponse

Respuesta de error

AfdProvisioningState

Estado de aprovisionamiento

afdQueryStringCachingBehavior

Define cómo Frontdoor almacena en caché las solicitudes que incluyen cadenas de consulta. Puede omitir las cadenas 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.

DeploymentStatus
EnabledState

Si desea 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.

ForwardingProtocol

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

httpsRedirect

Indica si se va a redirigir automáticamente el tráfico HTTP al tráfico HTTPS. Tenga en cuenta que se trata de una manera sencilla de configurar esta regla y será la primera regla que se ejecute.

IdentityType

Tipo de identidad que crea o modifica recursos

LinkToDefaultDomain

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

ResourceReference

Referencia a otro recurso.

Route

Nombre descriptivo de rutas asignación a cualquier información relacionada con rutas o secretos.

SystemData

Datos del sistema de solo lectura

ActivatedResourceReference

Referencia a otro recurso junto con su estado.

Name Type Description
id
  • string

Identificador del recurso.

isActive
  • boolean

Si el recurso está activo o inactivo

AfdErrorResponse

Respuesta de error

Name Type Description
error

Objeto de error.

AfdProvisioningState

Estado de aprovisionamiento

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

afdQueryStringCachingBehavior

Define cómo Frontdoor almacena en caché las solicitudes que incluyen cadenas de consulta. Puede omitir las cadenas 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.

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

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.

Name Type Description
compressionSettings

configuración de compresión.

queryParameters
  • string

parámetros de consulta para incluir o excluir (separados por comas).

queryStringCachingBehavior

Define cómo Frontdoor almacena en caché las solicitudes que incluyen cadenas de consulta. Puede omitir las cadenas 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

configuración para la compresión.

Name Type 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 False. 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.

DeploymentStatus

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

EnabledState

Si desea habilitar el uso de esta regla. Los valores permitidos son "Enabled" o "Disabled"

Name Type Description
Disabled
  • string
Enabled
  • string

ErrorAdditionalInfo

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

Name Type Description
info
  • object

La información adicional.

type
  • string

Tipo de información adicional.

ErrorDetail

Detalle del error.

Name Type Description
additionalInfo

Información adicional del error.

code
  • string

Código de error.

details

Los detalles del error.

message
  • string

El mensaje de error.

target
  • string

Destino del error.

ForwardingProtocol

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

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

httpsRedirect

Indica si se va a redirigir automáticamente el tráfico HTTP al tráfico HTTPS. Tenga en cuenta que se trata de una manera sencilla de configurar esta regla y será la primera regla que se ejecute.

Name Type Description
Disabled
  • string
Enabled
  • string

IdentityType

Tipo de identidad que crea o modifica recursos

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

LinkToDefaultDomain

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

Name Type Description
Disabled
  • string
Enabled
  • string

ResourceReference

Referencia a otro recurso.

Name Type Description
id
  • string

Identificador del recurso.

Route

Nombre descriptivo de rutas asignación a cualquier información relacionada con rutas o secretos.

Name Type Description
id
  • string

Identificador del recurso.

name
  • string

Nombre del recurso.

properties.cacheConfiguration

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

properties.customDomains

Dominios a los que hace referencia este punto de conexión.

properties.deploymentStatus
properties.enabledState

Si desea 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

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

properties.httpsRedirect

Indica si se va a redirigir automáticamente el tráfico HTTP al tráfico HTTPS. Tenga en cuenta que se trata de una manera sencilla de configurar esta regla y será la primera regla que se ejecute.

properties.linkToDefaultDomain

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

properties.originGroup

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

Estado de aprovisionamiento

properties.ruleSets

conjuntos de reglas a los que hace referencia este punto de conexión.

properties.supportedProtocols
  • string[]

Lista de protocolos admitidos para esta ruta.

systemData

Datos del sistema de solo lectura

type
  • string

Tipo de recurso.

SystemData

Datos del sistema de solo lectura

Name Type Description
createdAt
  • string

Marca de tiempo de creación de recursos (UTC)

createdBy
  • string

Identificador de la identidad que creó el recurso.

createdByType

Tipo de identidad que creó el recurso

lastModifiedAt
  • string

Marca de tiempo de la última modificación del recurso (UTC)

lastModifiedBy
  • string

Identificador de la identidad que modificó por última vez el recurso.

lastModifiedByType

Tipo de identidad que modificó por última vez el recurso.