ProbeData Class

Definition

A class representing the Probe data model. A load balancer probe.

public class ProbeData : Azure.ResourceManager.Network.Models.NetworkResourceData, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.Network.ProbeData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.Network.ProbeData>
public class ProbeData : Azure.ResourceManager.Network.Models.NetworkResourceData
type ProbeData = class
    inherit NetworkResourceData
    interface IJsonModel<ProbeData>
    interface IPersistableModel<ProbeData>
type ProbeData = class
    inherit NetworkResourceData
Public Class ProbeData
Inherits NetworkResourceData
Implements IJsonModel(Of ProbeData), IPersistableModel(Of ProbeData)
Public Class ProbeData
Inherits NetworkResourceData
Inheritance
Implements

Constructors

ProbeData()

Initializes a new instance of ProbeData.

Properties

ETag

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

Id

Resource ID.

(Inherited from NetworkResourceData)
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.

Name

Resource name.

(Inherited from NetworkResourceData)
NoHealthyBackendsBehavior

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

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.

ResourceType

Resource type.

(Inherited from NetworkResourceData)

Explicit Interface Implementations

IJsonModel<NetworkResourceData>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

(Inherited from NetworkResourceData)
IJsonModel<NetworkResourceData>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

(Inherited from NetworkResourceData)
IJsonModel<ProbeData>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<ProbeData>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<NetworkResourceData>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

(Inherited from NetworkResourceData)
IPersistableModel<NetworkResourceData>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

(Inherited from NetworkResourceData)
IPersistableModel<NetworkResourceData>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

(Inherited from NetworkResourceData)
IPersistableModel<ProbeData>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<ProbeData>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<ProbeData>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to