Routes - Get

Služba:: Front Door Service

Verze rozhraní API:: 2025-04-15

Získá existující trasu se zadaným názvem trasy pod zadaným předplatným, skupinou prostředků, profilem a koncovým bodem AzureFrontDoor.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpointName	path	True	string	Název koncového bodu pod profilem, který je globálně jedinečný.
profileName	path	True	string minLength: 1 maxLength: 260 pattern: ^[a-zA-Z0-9]+(-[a-zA-Z0-9])$	Název služby Azure Front Door Standard nebo Azure Front Door Premium, který je jedinečný v rámci skupiny prostředků.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
routeName	path	True	string	Název pravidla směrování
subscriptionId	path	True	string (uuid)	ID cílového předplatného. Hodnota musí být UUID.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name	Typ	Description
200 OK	Route	OK
Other Status Codes	ErrorResponse	Odpověď na chybu služby Azure Front Door popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok OAuth2 v Azure Active Directory

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

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

Příklady

Routes_Get

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 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.
AfdProvisioningState	Stav provisioningu
afdQueryStringCachingBehavior	Definuje, jak frontdoor ukládá požadavky, které zahrnují ř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 všechny požadavky do mezipaměti s jedinečnou adresou URL nebo ukládat do mezipaměti konkrétní řetězce dotazu.
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í pro kompresi.
createdByType	Typ identity, která prostředek vytvořila.
DeploymentStatus
EnabledState	Zda chcete povolit použití tohoto pravidla. Povolené hodnoty jsou Enabled (Povoleno) nebo Disabled (Zakázáno).
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
ForwardingProtocol	Toto pravidlo se použije při předávání provozu do back-endů.
httpsRedirect	Určuje, jestli se má automaticky přesměrovat provoz HTTP na provoz HTTPS. Všimněte si, že toto pravidlo je snadný způsob, jak toto pravidlo nastavit a bude prvním pravidlem, které se spustí.
LinkToDefaultDomain	zda bude tato trasa propojena s výchozí doménou koncového bodu.
ResourceReference	Odkaz na jiný prostředek
Route	Popisné mapování názvů tras na všechny trasy nebo informace související s tajnými kódy.
systemData	Metadata týkající se vytvoření a poslední změny prostředku.

ActivatedResourceReference

Objekt

Odkaz na jiný prostředek spolu s jeho stavem.

Name	Typ	Description
id	string	ID prostředku.
isActive	boolean	Bez ohledu na to, jestli je prostředek aktivní nebo neaktivní

AFDEndpointProtocols

Výčet

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

Hodnota	Description
Http
Https

AfdProvisioningState

Výčet

Stav provisioningu

Hodnota	Description
Succeeded
Failed
Updating
Deleting
Creating

afdQueryStringCachingBehavior

Výčet

Definuje, jak frontdoor ukládá požadavky, které zahrnují ř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 všechny požadavky do mezipaměti s jedinečnou adresou URL nebo ukládat do mezipaměti konkrétní řetězce dotazu.

Hodnota	Description
IgnoreQueryString
UseQueryString
IgnoreSpecifiedQueryStrings
IncludeSpecifiedQueryStrings

AfdRouteCacheConfiguration

Objekt

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é zahrnují ř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 všechny požadavky do mezipaměti s jedinečnou adresou URL nebo ukládat do mezipaměti konkrétní řetězce dotazu.

CompressionSettings

Objekt

nastavení pro kompresi.

Name	Typ	Description
contentTypesToCompress	string[]	Seznam typů obsahu, na které se komprese vztahuje. Hodnota by měla být platným typem MIME.
isCompressionEnabled	boolean	Určuje, jestli je v AzureFrontDoor povolená komprese obsahu. Výchozí hodnotou je nepravda. 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 nezkomprimuje.

createdByType

Výčet

Typ identity, která prostředek vytvořila.

Hodnota	Description
User
Application
ManagedIdentity
Key

DeploymentStatus

Výčet

Hodnota	Description
NotStarted
InProgress
Succeeded
Failed

EnabledState

Výčet

Zda chcete povolit použití tohoto pravidla. Povolené hodnoty jsou Enabled (Povoleno) nebo Disabled (Zakázáno).

Hodnota	Description
Enabled
Disabled

ErrorAdditionalInfo

Objekt

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

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

ErrorDetail

Objekt

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.

ErrorResponse

Objekt

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

ForwardingProtocol

Výčet

Toto pravidlo se použije při předávání provozu do back-endů.

Hodnota	Description
HttpOnly
HttpsOnly
MatchRequest

httpsRedirect

Výčet

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

Hodnota	Description
Enabled
Disabled

LinkToDefaultDomain

Výčet

zda bude tato trasa propojena s výchozí doménou koncového bodu.

Hodnota	Description
Enabled
Disabled

ResourceReference

Objekt

Odkaz na jiný prostředek

Name	Typ	Description
id	string	ID prostředku.

Route

Objekt

Popisné mapování názvů tras na všechny trasy nebo informace související s tajnými kódy.

Name	Typ	Default value	Description
id	string (arm-id)		Plně kvalifikované ID prostředku pro prostředek. Například /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
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 odkazované tímto koncovým bodem
properties.deploymentStatus	DeploymentStatus
properties.enabledState	EnabledState		Zda chcete povolit použití tohoto pravidla. Povolené hodnoty jsou Enabled (Povoleno) nebo Disabled (Zakázáno).
properties.endpointName	string		Název koncového bodu, který obsahuje trasu.
properties.forwardingProtocol	ForwardingProtocol	MatchRequest	Toto pravidlo se použije při předávání provozu do back-endů.
properties.httpsRedirect	httpsRedirect	Disabled	Určuje, jestli se má automaticky přesměrovat provoz HTTP na provoz HTTPS. Všimněte si, že toto pravidlo je snadný způsob, jak toto pravidlo nastavit a bude prvním pravidlem, které se spustí.
properties.linkToDefaultDomain	LinkToDefaultDomain	Disabled	zda bude tato trasa propojena s výchozí doménou koncového bodu.
properties.originGroup	ResourceReference		Odkaz na skupinu původu.
properties.originPath	string		Cesta k adresáři v původu, ze kterého může AzureFrontDoor načíst obsah, např. contoso.cloudapp.net/originpath.
properties.patternsToMatch	string[]		Vzory tras pravidla.
properties.provisioningState	AfdProvisioningState		Stav provisioningu
properties.ruleSets	ResourceReference[]		sady pravidel odkazované tímto koncovým bodem.
properties.supportedProtocols	AFDEndpointProtocols[]	[ "Http", "Https" ]	Seznam podporovaných protokolů pro tuto trasu
systemData	systemData		Metadata služby Azure Resource Manager obsahující informace o tom, kdo jej vytvořil a upravil.
type	string		Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

systemData

Objekt

Metadata týkající se vytvoření a poslední změny prostředku.

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

Sdílet prostřednictvím

Routes - Get

Parametry identifikátoru URI

Odpovědi

Zabezpečení

azure_auth

Rozsahy

Příklady

Routes_Get

Ukázkový požadavek

Ukázková odpověď

Definice

ActivatedResourceReference

AFDEndpointProtocols

AfdProvisioningState

afdQueryStringCachingBehavior

AfdRouteCacheConfiguration

CompressionSettings

createdByType

DeploymentStatus

EnabledState

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ForwardingProtocol

httpsRedirect

LinkToDefaultDomain

ResourceReference

Route

systemData