Share via

Backend interface

  • Reference
Package:
@azure/arm-frontdoor

Backend address of a frontDoor load balancer.

Properties

address

Location of the backend (IP address or FQDN)
backendHostHeader

The value to use as the host header sent to the backend. If blank or unspecified, this defaults to the incoming host.
enabledState

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

The HTTP TCP port number. Must be between 1 and 65535.
httpsPort

The HTTPS TCP port number. Must be between 1 and 65535.
priority

Priority to use for load balancing. Higher priorities will not be used for load balancing if any lower priority backend is healthy.
privateEndpointStatus

The Approval status for the connection to the Private Link NOTE: This property will not be serialized. It can only be populated by the server.
privateLinkAlias

The Alias of the Private Link resource. Populating this optional field indicates that this backend is 'Private'
privateLinkApprovalMessage

A custom message to be included in the approval request to connect to the Private Link
privateLinkLocation

The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated
privateLinkResourceId

The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private'
weight

Weight of this endpoint for load balancing purposes.

Property Details

address

Location of the backend (IP address or FQDN)

address?: string

Property Value

string

backendHostHeader

The value to use as the host header sent to the backend. If blank or unspecified, this defaults to the incoming host.

backendHostHeader?: string

Property Value

string

enabledState

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

enabledState?: string

Property Value

string

httpPort

The HTTP TCP port number. Must be between 1 and 65535.

httpPort?: number

Property Value

number

httpsPort

The HTTPS TCP port number. Must be between 1 and 65535.

httpsPort?: number

Property Value

number

priority

Priority to use for load balancing. Higher priorities will not be used for load balancing if any lower priority backend is healthy.

priority?: number

Property Value

number

privateEndpointStatus

The Approval status for the connection to the Private Link NOTE: This property will not be serialized. It can only be populated by the server.

privateEndpointStatus?: string

Property Value

string

privateLinkAlias

The Alias of the Private Link resource. Populating this optional field indicates that this backend is 'Private'

privateLinkAlias?: string

Property Value

string

privateLinkApprovalMessage

A custom message to be included in the approval request to connect to the Private Link

privateLinkApprovalMessage?: string

Property Value

string

privateLinkLocation

The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated

privateLinkLocation?: string

Property Value

string

privateLinkResourceId

The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private'

privateLinkResourceId?: string

Property Value

string

weight

Weight of this endpoint for load balancing purposes.

weight?: number

Property Value

number