Routes - Get

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

Parametry identifikátoru URI

Name In Required Type 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 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

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 žádostí klienta. Aktuální verze je 2021-06-01.

Odpovědi

Name Type Description
200 OK

OK

Other Status Codes

CDN chybová odpověď popisující, proč operace selhala.

Zabezpečení

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

Definice

ActivatedResourceReference

Odkaz na jiný prostředek spolu se stavem.

AfdErrorResponse

Chybová odpověď

AfdProvisioningState

Stav zřizování

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 každý požadavek do mezipaměti s jedinečnou adresou URL nebo řetězce dotazu konkrétní mezipaměti.

AfdRouteCacheConfiguration

nastavení Ukládání do mezipaměti trasy 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.

DeploymentStatus
EnabledState

Jestli chcete povolit použití tohoto pravidla. Povolené hodnoty jsou Povolené nebo Zakázané.

ErrorAdditionalInfo

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

ErrorDetail

Podrobnosti o chybě.

ForwardingProtocol

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

httpsRedirect

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

IdentityType

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

LinkToDefaultDomain

zda bude tato trasa propojená 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

Systémová data jen pro čtení

ActivatedResourceReference

Odkaz na jiný prostředek spolu se stavem.

Name Type Description
id
  • string

ID prostředku.

isActive
  • boolean

Bez ohledu na to, jestli je prostředek aktivní nebo neaktivní

AfdErrorResponse

Chybová odpověď

Name Type Description
error

Objekt chyby.

AfdProvisioningState

Stav zřizování

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

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 každý požadavek do mezipaměti s jedinečnou adresou URL nebo řetězce dotazu konkrétní mezipaměti.

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

AfdRouteCacheConfiguration

nastavení Ukládání do mezipaměti trasy typu ukládání do mezipaměti. Chcete-li zakázat ukládání do mezipaměti, nezadáte objekt cacheConfiguration.

Name Type Description
compressionSettings

nastavení komprese.

queryParameters
  • string

parametry dotazu, které se mají zahrnout nebo vyloučit (oddělené čárkami).

queryStringCachingBehavior

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 každý požadavek do mezipaměti s jedinečnou adresou URL nebo řetězce dotazu konkrétní mezipaměti.

CompressionSettings

nastavení pro kompresi.

Name Type Description
contentTypesToCompress
  • string[]

Seznam typů obsahu, na které se komprese vztahuje. Hodnota by měla být platným typem MIME.

isCompressionEnabled
  • boolean

Označuje, jestli je v AzureFrontDoor povolená komprese obsahu. Výchozí hodnota je false. Pokud je povolená komprese, bude obsah sloužit jako komprimovaný, pokud uživatel požaduje komprimovanou verzi. Pokud je požadovaný obsah menší než 1 bajt nebo větší než 1 MB, obsah se v AzureFrontDoor nezkomprimuje.

DeploymentStatus

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

EnabledState

Jestli chcete povolit použití tohoto pravidla. Povolené hodnoty jsou Povolené nebo Zakázané.

Name Type Description
Disabled
  • string
Enabled
  • string

ErrorAdditionalInfo

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

Name Type Description
info
  • object

Další informace.

type
  • string

Další typ informací.

ErrorDetail

Podrobnosti o chybě.

Name Type Description
additionalInfo

Další informace o chybě.

code
  • string

Kód chyby

details

Podrobnosti o chybě.

message
  • string

Chybová zpráva

target
  • string

Cíl chyby.

ForwardingProtocol

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

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

httpsRedirect

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

Name Type Description
Disabled
  • string
Enabled
  • string

IdentityType

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

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

LinkToDefaultDomain

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

Name Type Description
Disabled
  • string
Enabled
  • string

ResourceReference

Odkaz na jiný prostředek

Name Type Description
id
  • string

ID prostředku.

Route

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

Name Type Description
id
  • string

ID prostředku.

name
  • string

Název prostředku.

properties.cacheConfiguration

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

Domény odkazované tímto koncovým bodem

properties.deploymentStatus
properties.enabledState

Jestli chcete povolit použití tohoto pravidla. Povolené hodnoty jsou Povolené nebo Zakázané.

properties.endpointName
  • string

Název koncového bodu, který obsahuje trasu.

properties.forwardingProtocol

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

properties.httpsRedirect

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

properties.linkToDefaultDomain

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

properties.originGroup

Odkaz na skupinu původu.

properties.originPath
  • string

Cesta k adresáři na původu, ze kterého může AzureFrontDoor použít k načtení obsahu, například z contoso.cloudapp.net/originpath.

properties.patternsToMatch
  • string[]

Vzory tras pravidla.

properties.provisioningState

Stav zřizování

properties.ruleSets

sady pravidel odkazované na tento koncový bod.

properties.supportedProtocols
  • string[]

Seznam podporovaných protokolů pro tuto trasu

systemData

Systémová data jen pro čtení

type
  • string

Typ prostředku.

SystemData

Systémová data jen pro čtení

Name Type Description
createdAt
  • string

Časové razítko vytvoření prostředku (UTC)

createdBy
  • string

Identifikátor identity, která prostředek vytvořila

createdByType

Typ identity, která prostředek vytvořila

lastModifiedAt
  • string

Časové razítko poslední změny zdroje (UTC)

lastModifiedBy
  • string

Identifikátor identity, která naposledy změnila prostředek

lastModifiedByType

Typ identity, která naposledy upravila prostředek