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.models._models_py3.SubResource
Probe

Constructor

Probe(*, id: str | None = None, name: str | None = None, protocol: str | _models.ProbeProtocol | None = None, port: int | None = None, interval_in_seconds: int | None = None, no_healthy_backends_behavior: str | _models.ProbeNoHealthyBackendsBehavior | None = None, number_of_probes: int | None = None, probe_threshold: int | None = None, request_path: str | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
id
str

Resource ID.

name
str

The name of the resource that is unique within the set of probes used by the load balancer. This name can be used to access the resource.

protocol

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

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.

no_healthy_backends_behavior

Determines how new connections are handled by the load balancer when all backend instances are probed down. Known values are: "AllProbedDown" and "AllProbedUp".

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.

probe_threshold
int

The number of consecutive successful or failed probes in order to allow or deny traffic from being delivered to this endpoint. After failing the number of consecutive probes equal to this value, the endpoint will be taken out of rotation and require the same number of successful consecutive probes to be placed back in rotation.

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.

Variables

Name Description
id
str

Resource ID.

name
str

The name of the resource that is unique within the set of probes used by the load balancer. This name can be used to access the resource.

etag
str

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

type
str

Type of the resource.

load_balancing_rules

The load balancer rules that use this probe.

protocol

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

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.

no_healthy_backends_behavior

Determines how new connections are handled by the load balancer when all backend instances are probed down. Known values are: "AllProbedDown" and "AllProbedUp".

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.

probe_threshold
int

The number of consecutive successful or failed probes in order to allow or deny traffic from being delivered to this endpoint. After failing the number of consecutive probes equal to this value, the endpoint will be taken out of rotation and require the same number of successful consecutive probes to be placed back in rotation.

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

The provisioning state of the probe resource. Known values are: "Succeeded", "Updating", "Deleting", and "Failed".