ApplicationGatewayProbeResponse

data class ApplicationGatewayProbeResponse(val etag: String, val host: String? = null, val id: String? = null, val interval: Int? = null, val match: ApplicationGatewayProbeHealthResponseMatchResponse? = null, val minServers: Int? = null, val name: String? = null, val path: String? = null, val pickHostNameFromBackendHttpSettings: Boolean? = null, val port: Int? = null, val protocol: String? = null, val provisioningState: String, val timeout: Int? = null, val type: String, val unhealthyThreshold: Int? = null)

Probe of the application gateway.

Constructors

Link copied to clipboard
constructor(etag: String, host: String? = null, id: String? = null, interval: Int? = null, match: ApplicationGatewayProbeHealthResponseMatchResponse? = null, minServers: Int? = null, name: String? = null, path: String? = null, pickHostNameFromBackendHttpSettings: Boolean? = null, port: Int? = null, protocol: String? = null, provisioningState: String, timeout: Int? = null, type: String, unhealthyThreshold: Int? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

A unique read-only string that changes whenever the resource is updated.

Link copied to clipboard
val host: String? = null

Host name to send the probe to.

Link copied to clipboard
val id: String? = null

Resource ID.

Link copied to clipboard
val interval: Int? = null

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

Link copied to clipboard

Criterion for classifying a healthy probe response.

Link copied to clipboard
val minServers: Int? = null

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

Link copied to clipboard
val name: String? = null

Name of the probe that is unique within an Application Gateway.

Link copied to clipboard
val path: String? = null

Relative path of probe. Valid path starts from '/'. Probe is sent to ://:.

Link copied to clipboard

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

Link copied to clipboard
val port: Int? = null

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.

Link copied to clipboard
val protocol: String? = null

The protocol used for the probe.

Link copied to clipboard

The provisioning state of the probe resource.

Link copied to clipboard
val timeout: Int? = null

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.

Link copied to clipboard

Type of the resource.

Link copied to clipboard
val unhealthyThreshold: Int? = null

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