ApplicationGatewayProbe Class

Probe of the application gateway.

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

Inheritance

azure.mgmt.network.v2019_12_01.models._models_py3.SubResource

ApplicationGatewayProbe

Constructor

ApplicationGatewayProbe(*, id: typing.Union[str, NoneType] = None, name: typing.Union[str, NoneType] = None, protocol: typing.Union[str, _ForwardRef('ApplicationGatewayProtocol'), NoneType] = None, host: typing.Union[str, NoneType] = None, path: typing.Union[str, NoneType] = None, interval: typing.Union[int, NoneType] = None, timeout: typing.Union[int, NoneType] = None, unhealthy_threshold: typing.Union[int, NoneType] = None, pick_host_name_from_backend_http_settings: typing.Union[bool, NoneType] = None, min_servers: typing.Union[int, NoneType] = None, match: typing.Union[_ForwardRef('ApplicationGatewayProbeHealthResponseMatch'), NoneType] = None, port: typing.Union[int, NoneType] = None, **kwargs)

Parameters

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. Possible values include: "Http", "Https".

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.

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

Variables

etag

str

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

type

str

Type of the resource.

provisioning_state

str or ProvisioningState

The provisioning state of the probe resource. Possible values include: "Succeeded", "Updating", "Deleting", "Failed".