ApplicationGatewayProbePropertiesFormat interface

Package:

@azure-rest/arm-network

Properties of probe of an application gateway.

Properties

host	Host name to send the probe to.
interval	The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds.
match	Criterion for classifying a healthy probe response.
minServers	Minimum number of servers that are always marked healthy. Default value is 0.
path	Relative path of probe. Valid path starts from '/'. Probe is sent to <Protocol>://<host>:<port><path>.
pickHostNameFromBackendHttpSettings	Whether the host header should be picked from the backend http settings. Default value is false.
pickHostNameFromBackendSettings	Whether the server name indication should be picked from the backend settings for Tls protocol. Default value is false.
port	Custom port which will be used for probing the backend servers. The valid value ranges from 1 to 65535. In case not set, port from http settings will be used. This property is valid for Standard_v2 and WAF_v2 only.
protocol	The protocol used for the probe.
timeout	The probe timeout in seconds. Probe marked as failed if valid response is not received with this timeout period. Acceptable values are from 1 second to 86400 seconds.
unhealthyThreshold	The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20.

Property Details

host

Host name to send the probe to.

host?: string

Property Value

string

interval

The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds.

interval?: number

Property Value

number

match

Criterion for classifying a healthy probe response.

match?: ApplicationGatewayProbeHealthResponseMatch

Property Value

ApplicationGatewayProbeHealthResponseMatch

minServers

Minimum number of servers that are always marked healthy. Default value is 0.

minServers?: number

Property Value

number

path

Relative path of probe. Valid path starts from '/'. Probe is sent to <Protocol>://<host>:<port><path>.

path?: string

Property Value

string

pickHostNameFromBackendHttpSettings

Whether the host header should be picked from the backend http settings. Default value is false.

pickHostNameFromBackendHttpSettings?: boolean

Property Value

boolean

pickHostNameFromBackendSettings

Whether the server name indication should be picked from the backend settings for Tls protocol. Default value is false.

pickHostNameFromBackendSettings?: boolean

Property Value

boolean

port

Custom port which will be used for probing the backend servers. The valid value ranges from 1 to 65535. In case not set, port from http settings will be used. This property is valid for Standard_v2 and WAF_v2 only.

port?: number

Property Value

number

protocol

The protocol used for the probe.

protocol?: "Http" | "Https" | "Tcp" | "Tls"

Property Value

"Http" | "Https" | "Tcp" | "Tls"

timeout

The probe timeout in seconds. Probe marked as failed if valid response is not received with this timeout period. Acceptable values are from 1 second to 86400 seconds.

timeout?: number

Property Value

number

unhealthyThreshold

The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20.

unhealthyThreshold?: number

Property Value

number