Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Probe

Package version

A load balancer probe.

Hierarchy

Index

Properties

Optional etag

etag: undefined | string

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

Optional id

id: undefined | string

Resource ID.

Optional intervalInSeconds

intervalInSeconds: undefined | number

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.

Optional loadBalancingRules

loadBalancingRules: SubResource[]

The load balancer rules that use this probe. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

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

Optional numberOfProbes

numberOfProbes: undefined | number

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

port: number

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

protocol

protocol: 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'

Optional provisioningState

provisioningState: undefined | string

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

Optional requestPath

requestPath: undefined | string

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.

Generated using TypeDoc