Routes - Get

Referencia

Service:: Front Door Service

API Version:: 2023-05-01

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

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	Nombre del perfil de Azure Front Door Standard o Azure Front Door Premium que es único en el 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 2023-05-01.

Respuestas

Nombre	Tipo	Description
200 OK	Route	Aceptar
Other Status Codes	AfdErrorResponse	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.

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

Scopes

Nombre	Description
user_impersonation	suplantación de su 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=2023-05-01


/** Samples for Routes Get. */
public final class Main {
    /*
     * x-ms-original-file: specification/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/examples/Routes_Get.json
     */
    /**
     * Sample code: Routes_Get.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void routesGet(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.cdnProfiles().manager().serviceClient().getRoutes().getWithResponse("RG", "profile1", "endpoint1",
            "route1", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential
from azure.mgmt.cdn import CdnManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-cdn
# USAGE
    python routes_get.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = CdnManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.routes.get(
        resource_group_name="RG",
        profile_name="profile1",
        endpoint_name="endpoint1",
        route_name="route1",
    )
    print(response)


# x-ms-original-file: specification/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/examples/Routes_Get.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armcdn_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/cdn/armcdn/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7b551033155a63739b6d28f79b9c07569f6179b8/specification/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/examples/Routes_Get.json
func ExampleRoutesClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcdn.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewRoutesClient().Get(ctx, "RG", "profile1", "endpoint1", "route1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Route = armcdn.Route{
	// 	Name: to.Ptr("route1"),
	// 	Type: to.Ptr("Microsoft.Cdn/profiles/afdendpoints/routes"),
	// 	ID: to.Ptr("/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdendpoints/endpoint1/routes/route1"),
	// 	Properties: &armcdn.RouteProperties{
	// 		DeploymentStatus: to.Ptr(armcdn.DeploymentStatusNotStarted),
	// 		ProvisioningState: to.Ptr(armcdn.AfdProvisioningStateSucceeded),
	// 		CacheConfiguration: &armcdn.AfdRouteCacheConfiguration{
	// 			CompressionSettings: &armcdn.CompressionSettings{
	// 				ContentTypesToCompress: []*string{
	// 					to.Ptr("text/html"),
	// 					to.Ptr("application/octet-stream")},
	// 					IsCompressionEnabled: to.Ptr(true),
	// 				},
	// 				QueryStringCachingBehavior: to.Ptr(armcdn.AfdQueryStringCachingBehaviorIgnoreQueryString),
	// 			},
	// 			CustomDomains: []*armcdn.ActivatedResourceReference{
	// 				{
	// 					ID: to.Ptr("/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/customDomains/domain1"),
	// 			}},
	// 			EnabledState: to.Ptr(armcdn.EnabledStateEnabled),
	// 			ForwardingProtocol: to.Ptr(armcdn.ForwardingProtocolMatchRequest),
	// 			HTTPSRedirect: to.Ptr(armcdn.HTTPSRedirectEnabled),
	// 			LinkToDefaultDomain: to.Ptr(armcdn.LinkToDefaultDomainEnabled),
	// 			OriginGroup: &armcdn.ResourceReference{
	// 				ID: to.Ptr("/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/originGroups/originGroup1"),
	// 			},
	// 			PatternsToMatch: []*string{
	// 				to.Ptr("/*")},
	// 				RuleSets: []*armcdn.ResourceReference{
	// 					{
	// 						ID: to.Ptr("/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/ruleSets/ruleSet1"),
	// 				}},
	// 				SupportedProtocols: []*armcdn.AFDEndpointProtocols{
	// 					to.Ptr(armcdn.AFDEndpointProtocolsHTTPS),
	// 					to.Ptr(armcdn.AFDEndpointProtocolsHTTP)},
	// 				},
	// 			}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { CdnManagementClient } = require("@azure/arm-cdn");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets an existing route with the specified route name under the specified subscription, resource group, profile, and AzureFrontDoor endpoint.
 *
 * @summary Gets an existing route with the specified route name under the specified subscription, resource group, profile, and AzureFrontDoor endpoint.
 * x-ms-original-file: specification/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/examples/Routes_Get.json
 */
async function routesGet() {
  const subscriptionId = process.env["CDN_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["CDN_RESOURCE_GROUP"] || "RG";
  const profileName = "profile1";
  const endpointName = "endpoint1";
  const routeName = "route1";
  const credential = new DefaultAzureCredential();
  const client = new CdnManagementClient(credential, subscriptionId);
  const result = await client.routes.get(resourceGroupName, profileName, endpointName, routeName);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

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.
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 usará esta regla al reenviar el tráfico a los servidores back-end.
httpsRedirect	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.

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

AFDEndpointProtocols

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

Nombre	Tipo	Description
Http	string
Https	string

AfdErrorResponse

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

AfdProvisioningState

Estado de aprovisionamiento

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

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

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

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

Nombre	Tipo	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"

Nombre	Tipo	Description
Disabled	string
Enabled	string

ErrorAdditionalInfo

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

Detalle del error.

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

ForwardingProtocol

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

Nombre	Tipo	Description
HttpOnly	string
HttpsOnly	string
MatchRequest	string

httpsRedirect

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.

Nombre	Tipo	Description
Disabled	string
Enabled	string

IdentityType

Tipo de identidad que crea o modifica recursos

Nombre	Tipo	Description
application	string
key	string
managedIdentity	string
user	string

LinkToDefaultDomain

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

Nombre	Tipo	Description
Disabled	string
Enabled	string

ResourceReference

Referencia a otro recurso.

Nombre	Tipo	Description
id	string	Identificador del recurso.

Route

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

Nombre	Tipo	Valor predeterminado	Description
id	string		Identificador del recurso.
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		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	ForwardingProtocol	MatchRequest	Protocolo que usará esta regla al reenviar el tráfico a los servidores back-end.
properties.httpsRedirect	httpsRedirect	Disabled	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	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		Datos del sistema de solo lectura
type	string		Tipo de recurso.

SystemData

Datos del sistema de solo lectura

Nombre	Tipo	Description
createdAt	string	Marca de tiempo de creación de recursos (UTC)
createdBy	string	Identificador de la identidad que creó el recurso.
createdByType	IdentityType	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	IdentityType	Tipo de identidad que modificó por última vez el recurso.

Routes - Get

Parámetros de identificador URI

Respuestas

Seguridad

azure_auth

Scopes

Ejemplos

Routes_Get

Sample Request

Sample Response

Definiciones

ActivatedResourceReference

AFDEndpointProtocols

AfdErrorResponse

AfdProvisioningState

afdQueryStringCachingBehavior

AfdRouteCacheConfiguration

CompressionSettings

DeploymentStatus

EnabledState

ErrorAdditionalInfo

ErrorDetail

ForwardingProtocol

httpsRedirect

IdentityType

LinkToDefaultDomain

ResourceReference

Route

SystemData

Recursos adicionales