Route interface

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
enabledState	Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'
endpointName	The name of the endpoint which holds the route.
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
ruleSets	rule sets referenced by this endpoint.
supportedProtocols	List of supported protocols for this route.

Inherited Properties

id	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	The name of the resource
systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

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

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.

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

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

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

id?: string

Property Value

string

Inherited From ProxyResource.id

name

The name of the resource

name?: string

Property Value

string

Inherited From ProxyResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

systemData?: SystemData

Property Value

SystemData

Inherited From ProxyResource.systemData

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

type?: string

Property Value

string

Inherited From ProxyResource.type