Probe interface

Package:

@azure/arm-network

A load balancer probe.

Extends

SubResource

Properties

etag	A unique read-only string that changes whenever the resource is updated. NOTE: This property will not be serialized. It can only be populated by the server.
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. NOTE: This property will not be serialized. It can only be populated by the server.
name	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.
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. NOTE: This property will not be serialized. It can only be populated by the server.
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.
type	Type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

id	Resource ID.

Property Details

etag

A unique read-only string that changes whenever the resource is updated. NOTE: This property will not be serialized. It can only be populated by the server.

etag?: string

Property Value

string

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. NOTE: This property will not be serialized. It can only be populated by the server.

loadBalancingRules?: SubResource[]

Property Value

SubResource[]

name

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.

name?: string

Property Value

string

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?: string

Property Value

string

provisioningState

The provisioning state of the probe resource. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

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

type

Type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited Property Details

id

Resource ID.

id?: string

Property Value

string

Inherited From SubResource.id