Share via

Route interface

  • Reference
Package:
@azure/arm-cdn

Friendly Routes name mapping to the any Routes or secret related information.

Extends
ProxyResource

Properties

cacheConfiguration

The caching configuration for this route. To disable caching, do not provide a cacheConfiguration object.
customDomains

Domains referenced by this endpoint.
deploymentStatus

NOTE: This property will not be serialized. It can only be populated by the server.
enabledState

Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'
endpointName

The name of the endpoint which holds the route. NOTE: This property will not be serialized. It can only be populated by the server.
forwardingProtocol

Protocol this rule will use when forwarding traffic to backends.
httpsRedirect

Whether to automatically redirect HTTP traffic to HTTPS traffic. Note that this is a easy way to set up this rule and it will be the first rule that gets executed.
linkToDefaultDomain

whether this route will be linked to the default endpoint domain.
originGroup

A reference to the origin group.
originPath

A directory path on the origin that AzureFrontDoor can use to retrieve content from, e.g. contoso.cloudapp.net/originpath.
patternsToMatch

The route patterns of the rule.
provisioningState

Provisioning status NOTE: This property will not be serialized. It can only be populated by the server.
ruleSets

rule sets referenced by this endpoint.
supportedProtocols

List of supported protocols for this route.

Inherited Properties

id

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.
name

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.
systemData

Read only system data NOTE: This property will not be serialized. It can only be populated by the server.
type

Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

cacheConfiguration

The caching configuration for this route. To disable caching, do not provide a cacheConfiguration object.

cacheConfiguration?: AfdRouteCacheConfiguration

Property Value

AfdRouteCacheConfiguration

customDomains

Domains referenced by this endpoint.

customDomains?: ActivatedResourceReference[]

Property Value

ActivatedResourceReference[]

deploymentStatus

NOTE: This property will not be serialized. It can only be populated by the server.

deploymentStatus?: string

Property Value

string

enabledState

Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'

enabledState?: string

Property Value

string

endpointName

The name of the endpoint which holds the route. NOTE: This property will not be serialized. It can only be populated by the server.

endpointName?: string

Property Value

string

forwardingProtocol

Protocol this rule will use when forwarding traffic to backends.

forwardingProtocol?: string

Property Value

string

httpsRedirect

Whether to automatically redirect HTTP traffic to HTTPS traffic. Note that this is a easy way to set up this rule and it will be the first rule that gets executed.

httpsRedirect?: string

Property Value

string

linkToDefaultDomain

whether this route will be linked to the default endpoint domain.

linkToDefaultDomain?: string

Property Value

string

originGroup

A reference to the origin group.

originGroup?: ResourceReference

Property Value

ResourceReference

originPath

A directory path on the origin that AzureFrontDoor can use to retrieve content from, e.g. contoso.cloudapp.net/originpath.

originPath?: string

Property Value

string

patternsToMatch

The route patterns of the rule.

patternsToMatch?: string[]

Property Value

string[]

provisioningState

Provisioning status NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

ruleSets

rule sets referenced by this endpoint.

ruleSets?: ResourceReference[]

Property Value

ResourceReference[]

supportedProtocols

List of supported protocols for this route.

supportedProtocols?: string[]

Property Value

string[]

Inherited Property Details

id

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From ProxyResource.id

name

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From ProxyResource.name

systemData

Read only system data NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

Inherited From ProxyResource.systemData

type

Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From ProxyResource.type