azure.mgmt.network.models.ApplicationGatewayProbePropertiesFormat class

Constructor

ApplicationGatewayProbePropertiesFormat(*args: Any, **kwargs: Any)

Variables

Name	Description
protocol	str or ApplicationGatewayProtocol The protocol used for the probe. Known values are: "Http", "Https", "Tcp", and "Tls".
host	str Host name to send the probe to.
path	str Relative path of probe. Valid path starts from '/'. Probe is sent to <Protocol>://<host>:<port><path>.
interval	int The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds.
timeout	int 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.
unhealthy_threshold	int The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20.
pick_host_name_from_backend_http_settings	bool Whether the host header should be picked from the backend http settings. Default value is false.
pick_host_name_from_backend_settings	bool Whether the server name indication should be picked from the backend settings for Tls protocol. Default value is false.
min_servers	int Minimum number of servers that are always marked healthy. Default value is 0.
match	ApplicationGatewayProbeHealthResponseMatch Criterion for classifying a healthy probe response.
enable_probe_proxy_protocol_header	bool Whether to send Proxy Protocol header along with the Health Probe over TCP or TLS protocol. Default value is false.
provisioning_state	str or ProvisioningState The provisioning state of the probe resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting".
port	int 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 Basic, Standard_v2 and WAF_v2 only.

enable_probe_proxy_protocol_header

Whether to send Proxy Protocol header along with the Health Probe over TCP or TLS protocol. Default value is false.

enable_probe_proxy_protocol_header: bool | None

host

Host name to send the probe to.

host: str | None

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: int | None

match

Criterion for classifying a healthy probe response.

match: _models.ApplicationGatewayProbeHealthResponseMatch | None

min_servers

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

min_servers: int | None

path

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

path: str | None

pick_host_name_from_backend_http_settings

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

pick_host_name_from_backend_http_settings: bool | None

pick_host_name_from_backend_settings

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

pick_host_name_from_backend_settings: bool | None

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 Basic, Standard_v2 and WAF_v2 only.

port: int | None

protocol

"Http", "Https", "Tcp", and "Tls".

protocol: str | _models.ApplicationGatewayProtocol | None

provisioning_state

"Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting".

provisioning_state: str | _models.ProvisioningState | None

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: int | None

unhealthy_threshold

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

unhealthy_threshold: int | None