Share via

FrontDoor interface

Package:
@azure/arm-frontdoor

Front Door represents a collection of backend endpoints to route traffic to along with rules that specify how traffic is sent there.

Extends
Resource

Properties

backendPools

Backend pools available to routing rules.
backendPoolsSettings

Settings for all backendPools
cname

The host that each frontendEndpoint must CNAME to. NOTE: This property will not be serialized. It can only be populated by the server.
enabledState

Operational status of the Front Door load balancer. Permitted values are 'Enabled' or 'Disabled'
extendedProperties

Key-Value pair representing additional properties for frontdoor. NOTE: This property will not be serialized. It can only be populated by the server.
friendlyName

A friendly name for the frontDoor
frontdoorId

The Id of the frontdoor. NOTE: This property will not be serialized. It can only be populated by the server.
frontendEndpoints

Frontend endpoints available to routing rules.
healthProbeSettings

Health probe settings associated with this Front Door instance.
loadBalancingSettings

Load balancing settings associated with this Front Door instance.
provisioningState

Provisioning state of the Front Door. NOTE: This property will not be serialized. It can only be populated by the server.
resourceState

Resource status of the Front Door. NOTE: This property will not be serialized. It can only be populated by the server.
routingRules

Routing rules associated with this Front Door.
rulesEngines

Rules Engine Configurations available to routing rules. NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

id

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

Resource location.
name

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

Resource tags.
type

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

Property Details

backendPools

Backend pools available to routing rules.

backendPools?: BackendPool[]

Property Value

BackendPool[]

backendPoolsSettings

Settings for all backendPools

backendPoolsSettings?: BackendPoolsSettings

Property Value

BackendPoolsSettings

cname

The host that each frontendEndpoint must CNAME to. NOTE: This property will not be serialized. It can only be populated by the server.

cname?: string

Property Value

string

enabledState

Operational status of the Front Door load balancer. Permitted values are 'Enabled' or 'Disabled'

enabledState?: string

Property Value

string

extendedProperties

Key-Value pair representing additional properties for frontdoor. NOTE: This property will not be serialized. It can only be populated by the server.

extendedProperties?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

friendlyName

A friendly name for the frontDoor

friendlyName?: string

Property Value

string

frontdoorId

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

frontdoorId?: string

Property Value

string

frontendEndpoints

Frontend endpoints available to routing rules.

frontendEndpoints?: FrontendEndpoint[]

Property Value

FrontendEndpoint[]

healthProbeSettings

Health probe settings associated with this Front Door instance.

healthProbeSettings?: HealthProbeSettingsModel[]

Property Value

HealthProbeSettingsModel[]

loadBalancingSettings

Load balancing settings associated with this Front Door instance.

loadBalancingSettings?: LoadBalancingSettingsModel[]

Property Value

LoadBalancingSettingsModel[]

provisioningState

Provisioning state of the Front Door. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

resourceState

Resource status of the Front Door. NOTE: This property will not be serialized. It can only be populated by the server.

resourceState?: string

Property Value

string

routingRules

Routing rules associated with this Front Door.

routingRules?: RoutingRule[]

Property Value

RoutingRule[]

rulesEngines

Rules Engine Configurations available to routing rules. NOTE: This property will not be serialized. It can only be populated by the server.

rulesEngines?: RulesEngine[]

Property Value

RulesEngine[]

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 Resource.id

location

Resource location.

location?: string

Property Value

string

Inherited From Resource.location

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 Resource.name

tags

Resource tags.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From Resource.tags

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 Resource.type