Routes - Get

Reference

Service:: Front Door Service

API Version:: 2023-05-01

Získá existující trasu se zadaným názvem trasy v rámci zadaného předplatného, skupiny prostředků, profilu a koncového bodu AzureFrontDoor.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}/routes/{routeName}?api-version=2023-05-01

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpointName	path	True	string	Název koncového bodu v profilu, který je globálně jedinečný.
profileName	path	True	string	Název profilu Azure Front Door Standard nebo Azure Front Door Premium, který je v rámci skupiny prostředků jedinečný.
resourceGroupName	path	True	string	Název skupiny prostředků v rámci předplatného Azure Regex pattern: `^[-\w\._]+$`
routeName	path	True	string	Název pravidla směrování
subscriptionId	path	True	string	ID předplatného Azure.
api-version	query	True	string	Verze rozhraní API, která se má použít s požadavkem klienta. Aktuální verze je 1. 5. 2023.

Odpovědi

Name	Typ	Description
200 OK	Route	OK
Other Status Codes	AfdErrorResponse	Chybová odpověď služby Azure Front Door popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

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

Scopes

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

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

Definice

Name	Description
ActivatedResourceReference	Odkaz na jiný prostředek spolu s jeho stavem
AFDEndpointProtocols	Podporované protokoly pro koncový bod zákazníka.
AfdErrorResponse	Odpověď na chybu
AfdProvisioningState	Stav zřizování
afdQueryStringCachingBehavior	Definuje, jak frontdoor ukládá požadavky, které obsahují řetězce dotazů. Při ukládání do mezipaměti můžete ignorovat všechny řetězce dotazů, ignorovat konkrétní řetězce dotazů, ukládat každý požadavek do mezipaměti s jedinečnou adresou URL nebo ukládat do mezipaměti konkrétní řetězce dotazů.
AfdRouteCacheConfiguration	Nastavení ukládání do mezipaměti pro trasu typu ukládání do mezipaměti. Chcete-li zakázat ukládání do mezipaměti, nezadáte objekt cacheConfiguration.
CompressionSettings	nastavení komprese.
DeploymentStatus
EnabledState	Zda se má povolit použití tohoto pravidla. Povolené hodnoty jsou Povoleno nebo Zakázáno.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ForwardingProtocol	Protokol, který toto pravidlo použije při předávání provozu do back-endů.
httpsRedirect	Jestli se má provoz HTTP automaticky přesměrovat na provoz HTTPS. Všimněte si, že toto je snadný způsob, jak toto pravidlo nastavit a bude to první pravidlo, které se spustí.
IdentityType	Typ identity, která vytváří nebo upravuje prostředky
LinkToDefaultDomain	jestli bude tato trasa propojená s výchozí doménou koncového bodu.
ResourceReference	Odkaz na jiný prostředek.
Route	Popisné mapování názvu tras na všechny trasy nebo informace související s tajným kódem
SystemData	Systémová data jen pro čtení

ActivatedResourceReference

Odkaz na jiný prostředek spolu s jeho stavem

Name	Typ	Description
id	string	ID prostředku.
isActive	boolean	Jestli je prostředek aktivní nebo neaktivní

AFDEndpointProtocols

Podporované protokoly pro koncový bod zákazníka.

Name	Typ	Description
Http	string
Https	string

AfdErrorResponse

Odpověď na chybu

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

AfdProvisioningState

Stav zřizování

Name	Typ	Description
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

afdQueryStringCachingBehavior

Definuje, jak frontdoor ukládá požadavky, které obsahují řetězce dotazů. Při ukládání do mezipaměti můžete ignorovat všechny řetězce dotazů, ignorovat konkrétní řetězce dotazů, ukládat každý požadavek do mezipaměti s jedinečnou adresou URL nebo ukládat do mezipaměti konkrétní řetězce dotazů.

Name	Typ	Description
IgnoreQueryString	string
IgnoreSpecifiedQueryStrings	string
IncludeSpecifiedQueryStrings	string
UseQueryString	string

AfdRouteCacheConfiguration

Nastavení ukládání do mezipaměti pro trasu typu ukládání do mezipaměti. Chcete-li zakázat ukládání do mezipaměti, nezadáte objekt cacheConfiguration.

Name	Typ	Description
compressionSettings	CompressionSettings	nastavení komprese.
queryParameters	string	parametry dotazu, které se mají zahrnout nebo vyloučit (oddělené čárkami).
queryStringCachingBehavior	afdQueryStringCachingBehavior	Definuje, jak frontdoor ukládá požadavky, které obsahují řetězce dotazů. Při ukládání do mezipaměti můžete ignorovat všechny řetězce dotazů, ignorovat konkrétní řetězce dotazů, ukládat každý požadavek do mezipaměti s jedinečnou adresou URL nebo ukládat do mezipaměti konkrétní řetězce dotazů.

CompressionSettings

nastavení komprese.

Name	Typ	Description
contentTypesToCompress	string[]	Seznam typů obsahu, na které se vztahuje komprese Hodnota by měla být platný typ MIME.
isCompressionEnabled	boolean	Označuje, jestli je v AzureFrontDoor povolená komprese obsahu. Výchozí hodnota je false. Pokud je povolená komprese, obsah se bude obsluhovat jako komprimovaný, pokud uživatel požádá o komprimovanou verzi. Pokud je požadovaný obsah menší než 1 bajt nebo větší než 1 MB, obsah se v AzureFrontDoor komprimovat nebude.

DeploymentStatus

Name	Typ	Description
Failed	string
InProgress	string
NotStarted	string
Succeeded	string

EnabledState

Zda se má povolit použití tohoto pravidla. Povolené hodnoty jsou Povoleno nebo Zakázáno.

Name	Typ	Description
Disabled	string
Enabled	string

ErrorAdditionalInfo

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě
code	string	Kód chyby
details	ErrorDetail[]	Podrobnosti o chybě
message	string	Chybová zpráva
target	string	Cíl chyby.

ForwardingProtocol

Protokol, který toto pravidlo použije při předávání provozu do back-endů.

Name	Typ	Description
HttpOnly	string
HttpsOnly	string
MatchRequest	string

httpsRedirect

Jestli se má provoz HTTP automaticky přesměrovat na provoz HTTPS. Všimněte si, že toto je snadný způsob, jak toto pravidlo nastavit a bude to první pravidlo, které se spustí.

Name	Typ	Description
Disabled	string
Enabled	string

IdentityType

Typ identity, která vytváří nebo upravuje prostředky

Name	Typ	Description
application	string
key	string
managedIdentity	string
user	string

LinkToDefaultDomain

jestli bude tato trasa propojená s výchozí doménou koncového bodu.

Name	Typ	Description
Disabled	string
Enabled	string

ResourceReference

Odkaz na jiný prostředek.

Name	Typ	Description
id	string	ID prostředku.

Route

Popisné mapování názvu tras na všechny trasy nebo informace související s tajným kódem

Name	Typ	Výchozí hodnota	Description
id	string		ID prostředku.
name	string		Název prostředku.
properties.cacheConfiguration	AfdRouteCacheConfiguration		Konfigurace ukládání do mezipaměti pro tuto trasu. Chcete-li zakázat ukládání do mezipaměti, nezadáte objekt cacheConfiguration.
properties.customDomains	ActivatedResourceReference[]		Domény, na které odkazuje tento koncový bod.
properties.deploymentStatus	DeploymentStatus
properties.enabledState	EnabledState		Zda se má povolit použití tohoto pravidla. Povolené hodnoty jsou Povoleno nebo Zakázáno.
properties.endpointName	string		Název koncového bodu, který obsahuje trasu.
properties.forwardingProtocol	ForwardingProtocol	MatchRequest	Protokol, který toto pravidlo použije při předávání provozu do back-endů.
properties.httpsRedirect	httpsRedirect	Disabled	Jestli se má provoz HTTP automaticky přesměrovat na provoz HTTPS. Všimněte si, že toto je snadný způsob, jak toto pravidlo nastavit a bude to první pravidlo, které se spustí.
properties.linkToDefaultDomain	LinkToDefaultDomain	Disabled	jestli bude tato trasa propojená s výchozí doménou koncového bodu.
properties.originGroup	ResourceReference		Odkaz na skupinu původů.
properties.originPath	string		Cesta k adresáři na původu, kterou může AzureFrontDoor použít k načtení obsahu, například contoso.cloudapp.net/originpath.
properties.patternsToMatch	string[]		Vzory tras pravidla.
properties.provisioningState	AfdProvisioningState		Stav zřizování
properties.ruleSets	ResourceReference[]		sady pravidel, na které odkazuje tento koncový bod.
properties.supportedProtocols	AFDEndpointProtocols[]	[ "Http", "Https" ]	Seznam podporovaných protokolů pro tuto trasu
systemData	SystemData		Systémová data jen pro čtení
type	string		Typ prostředku.

SystemData

Systémová data jen pro čtení

Name	Typ	Description
createdAt	string	Časové razítko vytvoření prostředku (UTC)
createdBy	string	Identifikátor identity, která vytvořila prostředek
createdByType	IdentityType	Typ identity, která vytvořila prostředek
lastModifiedAt	string	Časové razítko poslední změny prostředku (UTC)
lastModifiedBy	string	Identifikátor identity, která naposledy změnila prostředek
lastModifiedByType	IdentityType	Typ identity, která naposledy změnila prostředek

Routes - Get

Parametry identifikátoru URI

Odpovědi

Zabezpečení

azure_auth

Scopes

Příklady

Routes_Get

Sample Request

Sample Response

Definice

ActivatedResourceReference

AFDEndpointProtocols

AfdErrorResponse

AfdProvisioningState

afdQueryStringCachingBehavior

AfdRouteCacheConfiguration

CompressionSettings

DeploymentStatus

EnabledState

ErrorAdditionalInfo

ErrorDetail

ForwardingProtocol

httpsRedirect

IdentityType

LinkToDefaultDomain

ResourceReference

Route

SystemData

Další materiály