ProbePropertiesFormatOutput interface

Package:

@azure-rest/arm-network

Load balancer probe resource.

Properties

intervalInSeconds	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.
loadBalancingRules	The load balancer rules that use this probe.
numberOfProbes	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.
port	The port for communicating the probe. Possible values range from 1 to 65535, inclusive.
probeThreshold	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.
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.
provisioningState	The provisioning state of the probe resource.
requestPath	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.

Property Details

intervalInSeconds

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.

intervalInSeconds?: number

Property Value

number

loadBalancingRules

The load balancer rules that use this probe.

loadBalancingRules?: SubResourceOutput[]

Property Value

SubResourceOutput[]

numberOfProbes

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.

numberOfProbes?: number

Property Value

number

port

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

port: number

Property Value

number

probeThreshold

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.

probeThreshold?: number

Property Value

number

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.

protocol: "Http" | "Https" | "Tcp"

Property Value

"Http" | "Https" | "Tcp"

provisioningState

The provisioning state of the probe resource.

provisioningState?: "Succeeded" | "Updating" | "Deleting" | "Failed"

Property Value

"Succeeded" | "Updating" | "Deleting" | "Failed"

requestPath

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.

requestPath?: string

Property Value

string