ApplicationGatewayProbe Class
Probe of the application gateway.
Variables are only populated by the server, and will be ignored when sending a request.
Constructor
ApplicationGatewayProbe(*, id: str | None = None, name: str | None = None, protocol: str | _models.ApplicationGatewayProtocol | None = None, host: str | None = None, path: str | None = None, interval: int | None = None, timeout: int | None = None, unhealthy_threshold: int | None = None, pick_host_name_from_backend_http_settings: bool | None = None, pick_host_name_from_backend_settings: bool | None = None, min_servers: int | None = None, match: _models.ApplicationGatewayProbeHealthResponseMatch | None = None, port: int | None = None, **kwargs: Any)Keyword-Only Parameters
| Name | Description |
|---|---|
|
id
|
Resource ID. Default value: None
|
|
name
|
Name of the probe that is unique within an Application Gateway. Default value: None
|
|
protocol
|
The protocol used for the probe. Known values are: "Http", "Https", "Tcp", and "Tls". Default value: None
|
|
host
|
Host name to send the probe to. Default value: None
|
|
path
|
Relative path of probe. Valid path starts from '/'. Probe is sent to
Default value: 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. Default value: 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. Default value: 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. Default value: None
|
|
pick_host_name_from_backend_http_settings
|
Whether the host header should be picked from the backend http settings. Default value is false. Default value: 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. Default value: None
|
|
min_servers
|
Minimum number of servers that are always marked healthy. Default value is 0. Default value: None
|
|
match
|
Criterion for classifying a healthy probe response. Default value: 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. Default value: None
|
Variables
| Name | Description |
|---|---|
|
id
|
Resource ID. |
|
name
|
Name of the probe that is unique within an Application Gateway. |
|
etag
|
A unique read-only string that changes whenever the resource is updated. |
|
type
|
Type of the resource. |
|
protocol
|
The protocol used for the probe. Known values are: "Http", "Https", "Tcp", and "Tls". |
|
host
|
Host name to send the probe to. |
|
path
|
Relative path of probe. Valid path starts from '/'. Probe is sent 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. |
|
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. |
|
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. |
|
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_settings
|
Whether the server name indication should be picked from the backend settings for Tls protocol. Default value is false. |
|
min_servers
|
Minimum number of servers that are always marked healthy. Default value is 0. |
|
match
|
Criterion for classifying a healthy probe response. |
|
provisioning_state
|
The provisioning state of the probe resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". |
|
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. |
