RouteProperties interface

Package:

@azure/arm-cdn

The JSON object that contains the properties of the Routes to create.

Extends

RouteUpdatePropertiesParameters,AFDStateProperties

Inherited 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 Property Details

cacheConfiguration

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

cacheConfiguration?: AfdRouteCacheConfiguration

Property Value

AfdRouteCacheConfiguration

Inherited From RouteUpdatePropertiesParameters.cacheConfiguration

customDomains

Domains referenced by this endpoint.

customDomains?: ActivatedResourceReference[]

Property Value

ActivatedResourceReference[]

Inherited From RouteUpdatePropertiesParameters.customDomains

deploymentStatus

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

deploymentStatus?: string

Property Value

string

Inherited From AFDStateProperties.deploymentStatus

enabledState

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

enabledState?: string

Property Value

string

Inherited From RouteUpdatePropertiesParameters.enabledState

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

Inherited From RouteUpdatePropertiesParameters.endpointName

forwardingProtocol

Protocol this rule will use when forwarding traffic to backends.

forwardingProtocol?: string

Property Value

string

Inherited From RouteUpdatePropertiesParameters.forwardingProtocol

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

Inherited From RouteUpdatePropertiesParameters.httpsRedirect

linkToDefaultDomain

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

linkToDefaultDomain?: string

Property Value

string

Inherited From RouteUpdatePropertiesParameters.linkToDefaultDomain

originGroup

A reference to the origin group.

originGroup?: ResourceReference

Property Value

ResourceReference

Inherited From RouteUpdatePropertiesParameters.originGroup

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

Inherited From RouteUpdatePropertiesParameters.originPath

patternsToMatch

The route patterns of the rule.

patternsToMatch?: string[]

Property Value

string[]

Inherited From RouteUpdatePropertiesParameters.patternsToMatch

provisioningState

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

provisioningState?: string

Property Value

string

Inherited From AFDStateProperties.provisioningState

ruleSets

rule sets referenced by this endpoint.

ruleSets?: ResourceReference[]

Property Value

ResourceReference[]

Inherited From RouteUpdatePropertiesParameters.ruleSets

supportedProtocols

List of supported protocols for this route.

supportedProtocols?: string[]

Property Value

string[]

Inherited From RouteUpdatePropertiesParameters.supportedProtocols