Probe Class

A load balancer probe.

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

Inheritance

azure.mgmt.network.v2017_03_01.models._models_py3.SubResource

Probe

Constructor

Probe(*, id: typing.Union[str, NoneType] = None, name: typing.Union[str, NoneType] = None, etag: typing.Union[str, NoneType] = None, protocol: typing.Union[str, _ForwardRef('ProbeProtocol'), NoneType] = None, port: typing.Union[int, NoneType] = None, interval_in_seconds: typing.Union[int, NoneType] = None, number_of_probes: typing.Union[int, NoneType] = None, request_path: typing.Union[str, NoneType] = None, provisioning_state: typing.Union[str, NoneType] = None, **kwargs)

Parameters

id

str

Resource ID.

name

str

Gets name of the resource that is unique within a resource group. This name can be used to access the resource.

etag

str

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

protocol

str or ProbeProtocol

The protocol of the end point. Possible values are: 'Http' or 'Tcp'. If 'Tcp' is specified, a received ACK is required for the probe to be successful. If 'Http' is specified, a 200 OK response from the specifies URI is required for the probe to be successful. Possible values include: "Http", "Tcp".

port

int

The port for communicating the probe. Possible values range from 1 to 65535, inclusive.

interval_in_seconds

int

The interval, in seconds, for how frequently to probe the endpoint for health status. Typically, the interval is slightly less than half the allocated timeout period (in seconds) which allows two full probes before taking the instance out of rotation. The default value is 15, the minimum value is 5.

number_of_probes

int

The number of probes where if no response, will result in stopping further traffic from being delivered to the endpoint. This values allows endpoints to be taken out of rotation faster or slower than the typical times used in Azure.

request_path

str

The URI used for requesting health status from the VM. Path is required if a protocol is set to http. Otherwise, it is not allowed. There is no default value.

provisioning_state

str

Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.

Variables

load_balancing_rules

list[SubResource]

The load balancer rules that use this probe.