ProbeArgs

data class ProbeArgs(val id: Output<String>? = null, val intervalInSeconds: Output<Int>? = null, val name: Output<String>? = null, val noHealthyBackendsBehavior: Output<Either<String, ProbeNoHealthyBackendsBehavior>>? = null, val numberOfProbes: Output<Int>? = null, val port: Output<Int>, val probeThreshold: Output<Int>? = null, val protocol: Output<Either<String, ProbeProtocol>>, val requestPath: Output<String>? = null) : ConvertibleToJava<ProbeArgs>

A load balancer probe.

Constructors

Link copied to clipboard
constructor(id: Output<String>? = null, intervalInSeconds: Output<Int>? = null, name: Output<String>? = null, noHealthyBackendsBehavior: Output<Either<String, ProbeNoHealthyBackendsBehavior>>? = null, numberOfProbes: Output<Int>? = null, port: Output<Int>, probeThreshold: Output<Int>? = null, protocol: Output<Either<String, ProbeProtocol>>, requestPath: Output<String>? = null)

Properties

Link copied to clipboard
val id: Output<String>? = null

Resource ID.

Link copied to clipboard
val intervalInSeconds: Output<Int>? = null

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.

Link copied to clipboard
val name: Output<String>? = null

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.

Link copied to clipboard

Determines how new connections are handled by the load balancer when all backend instances are probed down.

Link copied to clipboard
val numberOfProbes: Output<Int>? = null

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.

Link copied to clipboard
val port: Output<Int>

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

Link copied to clipboard
val probeThreshold: Output<Int>? = null

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.

Link copied to clipboard
val protocol: Output<Either<String, 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.

Link copied to clipboard
val requestPath: Output<String>? = null

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.

Functions

Link copied to clipboard
open override fun toJava(): ProbeArgs