Share via

ApplicationGatewayProbe Class

  • Reference

Probe of the application gateway.

Variables are only populated by the server, and will be ignored when sending a request.

Inheritance
azure.mgmt.network.models._models_py3.SubResource
ApplicationGatewayProbe

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
str

Resource ID.
name
str

Name of the probe that is unique within an Application Gateway.
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.
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.

Variables

Name Description
id
str

Resource ID.
name
str

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

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

Type of the resource.
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.
provisioning_state
str or ProvisioningState

The provisioning state of the probe resource. Known values are: "Succeeded", "Updating", "Deleting", and "Failed".
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.