Routes - Get

Hämtar en befintlig väg med det angivna vägnamnet under den angivna prenumerationen, resursgruppen, profilen och AzureFrontDoor-slutpunkten.

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

URI-parametrar

Name In Required Type Description
endpointName
path True
  • string

Namnet på slutpunkten under profilen som är unik globalt.

profileName
path True
  • string

Namnet på Profilen Azure Front Door Standard eller Azure Front Door Premium som är unik i resursgruppen.

resourceGroupName
path True
  • string

Namnet på resursgruppen i Azure-prenumerationen.

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

routeName
path True
  • string

Namn på routningsregeln.

subscriptionId
path True
  • string

Azure-prenumerations-ID.

api-version
query True
  • string

Version av API:et som ska användas med klientbegäran. Den aktuella versionen är 2021-06-01.

Svar

Name Type Description
200 OK

OK

Other Status Codes

CDN felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name Description
user_impersonation personifiera ditt användarkonto

Exempel

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

Definitioner

ActivatedResourceReference

Referens till en annan resurs tillsammans med dess tillstånd.

AfdErrorResponse

Felsvar

AfdProvisioningState

Etableringsstatus

afdQueryStringCachingBehavior

Definierar hur Frontdoor cachelagrar begäranden som innehåller frågesträngar. Du kan ignorera alla frågesträngar när du cachelagrar, ignorera specifika frågesträngar, cachelagra varje begäran med en unik URL eller cachelagra specifika frågesträngar.

AfdRouteCacheConfiguration

Cachelagring inställningar för en cachelagringsväg. Om du vill inaktivera cachelagring ska du inte ange ett cacheConfiguration-objekt.

CompressionSettings

inställningar för komprimering.

DeploymentStatus
EnabledState

Om du vill aktivera användning av den här regeln. Tillåtna värden är "aktiverade" eller "inaktiverade"

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

ErrorDetail

Felinformationen.

ForwardingProtocol

Protokoll som den här regeln använder när trafik vidarebefordras till serverdelar.

httpsRedirect

Om HTTP-trafik ska omdirigeras automatiskt till HTTPS-trafik. Observera att det här är ett enkelt sätt att konfigurera den här regeln och att det blir den första regeln som körs.

IdentityType

Den typ av identitet som skapar/ändrar resurser

LinkToDefaultDomain

om den här vägen kommer att länkas till standardslutpunktsdomänen.

ResourceReference

Referens till en annan resurs.

Route

Namnmappning av egna vägar till eventuell information om vägar eller hemligheter.

SystemData

Skrivskyddade systemdata

ActivatedResourceReference

Referens till en annan resurs tillsammans med dess tillstånd.

Name Type Description
id
  • string

Resurs-ID.

isActive
  • boolean

Om resursen är aktiv eller inaktiv

AfdErrorResponse

Felsvar

Name Type Description
error

Felobjektet.

AfdProvisioningState

Etableringsstatus

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

afdQueryStringCachingBehavior

Definierar hur Frontdoor cachelagrar begäranden som innehåller frågesträngar. Du kan ignorera alla frågesträngar när du cachelagrar, ignorera specifika frågesträngar, cachelagra varje begäran med en unik URL eller cachelagra specifika frågesträngar.

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

AfdRouteCacheConfiguration

Cachelagring inställningar för en cachelagringsväg. Om du vill inaktivera cachelagring ska du inte ange ett cacheConfiguration-objekt.

Name Type Description
compressionSettings

komprimeringsinställningar.

queryParameters
  • string

frågeparametrar som ska inkluderas eller exkluderas (kommaavgränsade).

queryStringCachingBehavior

Definierar hur Frontdoor cachelagrar begäranden som innehåller frågesträngar. Du kan ignorera alla frågesträngar när du cachelagrar, ignorera specifika frågesträngar, cachelagra varje begäran med en unik URL eller cachelagra specifika frågesträngar.

CompressionSettings

inställningar för komprimering.

Name Type Description
contentTypesToCompress
  • string[]

Lista över innehållstyper som komprimering gäller för. Värdet ska vara en giltig MIME-typ.

isCompressionEnabled
  • boolean

Anger om innehållskomprimering är aktiverat på AzureFrontDoor. Standardvärdet är falskt. Om komprimering är aktiverat kommer innehållet att fungera som komprimerat om användaren begär en komprimerad version. Innehållet komprimeras inte på AzureFrontDoor när begärt innehåll är mindre än 1 byte eller större än 1 MB.

DeploymentStatus

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

EnabledState

Om du vill aktivera användning av den här regeln. Tillåtna värden är "aktiverade" eller "inaktiverade"

Name Type Description
Disabled
  • string
Enabled
  • string

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name Type Description
info
  • object

Ytterligare information.

type
  • string

Den ytterligare informationstypen.

ErrorDetail

Felinformationen.

Name Type Description
additionalInfo

Ytterligare information om felet.

code
  • string

Felkoden.

details

Felinformationen.

message
  • string

Felmeddelandet.

target
  • string

Felmålet.

ForwardingProtocol

Protokoll som den här regeln använder när trafik vidarebefordras till serverdelar.

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

httpsRedirect

Om HTTP-trafik ska omdirigeras automatiskt till HTTPS-trafik. Observera att det här är ett enkelt sätt att konfigurera den här regeln och att det blir den första regeln som körs.

Name Type Description
Disabled
  • string
Enabled
  • string

IdentityType

Den typ av identitet som skapar/ändrar resurser

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

LinkToDefaultDomain

om den här vägen kommer att länkas till standardslutpunktsdomänen.

Name Type Description
Disabled
  • string
Enabled
  • string

ResourceReference

Referens till en annan resurs.

Name Type Description
id
  • string

Resurs-ID.

Route

Namnmappning av egna vägar till eventuell information om vägar eller hemligheter.

Name Type Description
id
  • string

Resurs-ID.

name
  • string

Resursnamn.

properties.cacheConfiguration

Cachelagringskonfigurationen för den här vägen. Om du vill inaktivera cachelagring ska du inte ange ett cacheConfiguration-objekt.

properties.customDomains

Domäner som refereras av den här slutpunkten.

properties.deploymentStatus
properties.enabledState

Om du vill aktivera användning av den här regeln. Tillåtna värden är "aktiverade" eller "inaktiverade"

properties.endpointName
  • string

Namnet på slutpunkten som innehåller vägen.

properties.forwardingProtocol

Protokoll som den här regeln använder när trafik vidarebefordras till serverdelar.

properties.httpsRedirect

Om HTTP-trafik ska omdirigeras automatiskt till HTTPS-trafik. Observera att det här är ett enkelt sätt att konfigurera den här regeln och att det blir den första regeln som körs.

properties.linkToDefaultDomain

om den här vägen kommer att länkas till standardslutpunktsdomänen.

properties.originGroup

En referens till ursprungsgruppen.

properties.originPath
  • string

En katalogsökväg för ursprunget som AzureFrontDoor kan använda för att hämta innehåll från, t.ex. contoso.cloudapp.net/originpath.

properties.patternsToMatch
  • string[]

Regelns routningsmönster.

properties.provisioningState

Etableringsstatus

properties.ruleSets

regeluppsättningar som refereras av den här slutpunkten.

properties.supportedProtocols
  • string[]

Lista över protokoll som stöds för den här vägen.

systemData

Skrivskyddade systemdata

type
  • string

Resurstyp.

SystemData

Skrivskyddade systemdata

Name Type Description
createdAt
  • string

Tidsstämpeln för resursskapande (UTC)

createdBy
  • string

En identifierare för den identitet som skapade resursen

createdByType

Typen av identitet som skapade resursen

lastModifiedAt
  • string

Tidsstämpeln för resursens senaste ändring (UTC)

lastModifiedBy
  • string

En identifierare för den identitet som senast ändrade resursen

lastModifiedByType

Den typ av identitet som senast ändrade resursen