ProbePropertiesFormat Class

Load balancer probe resource.

Constructor

ProbePropertiesFormat(*args: Any, **kwargs: Any)

Variables

Name Description
load_balancing_rules
list[SubResource]

The load balancer rules that use this probe.
protocol
str or ProbeProtocol

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. Required. Known values are: "Http", "Tcp", and "Https".
port
int

The port for communicating the probe. Possible values range from 1 to 65535, inclusive. Required.
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
str or ProbeNoHealthyBackendsBehavior

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
str or ProvisioningState

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

Attributes

interval_in_seconds

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.

interval_in_seconds: int | None

load_balancing_rules

The load balancer rules that use this probe.

load_balancing_rules: list['_models.SubResource'] | None

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".

no_healthy_backends_behavior: str | _models.ProbeNoHealthyBackendsBehavior | None

number_of_probes

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.

number_of_probes: int | None

port

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

port: int

probe_threshold

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.

probe_threshold: int | None

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. Required. Known values are: "Http", "Tcp", and "Https".

protocol: str | _models.ProbeProtocol

provisioning_state

"Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting".

provisioning_state: str | _models.ProvisioningState | None

request_path

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.

request_path: str | None