Probe Constructors

Definition

Overloads

Probe()

Initializes a new instance of the Probe class.

Probe(String, Int32, String, IList<SubResource>, Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, String, String, String, String, String)

Initializes a new instance of the Probe class.

Probe()

Initializes a new instance of the Probe class.

public Probe ();
Public Sub New ()

Applies to

Probe(String, Int32, String, IList<SubResource>, Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, String, String, String, String, String)

Initializes a new instance of the Probe class.

public Probe (string protocol, int port, string id = default, System.Collections.Generic.IList<Microsoft.Azure.Management.Network.Models.SubResource> loadBalancingRules = default, int? intervalInSeconds = default, int? numberOfProbes = default, int? probeThreshold = default, string requestPath = default, string provisioningState = default, string name = default, string etag = default, string type = default);
new Microsoft.Azure.Management.Network.Models.Probe : string * int * string * System.Collections.Generic.IList<Microsoft.Azure.Management.Network.Models.SubResource> * Nullable<int> * Nullable<int> * Nullable<int> * string * string * string * string * string -> Microsoft.Azure.Management.Network.Models.Probe
Public Sub New (protocol As String, port As Integer, Optional id As String = Nothing, Optional loadBalancingRules As IList(Of SubResource) = Nothing, Optional intervalInSeconds As Nullable(Of Integer) = Nothing, Optional numberOfProbes As Nullable(Of Integer) = Nothing, Optional probeThreshold As Nullable(Of Integer) = Nothing, Optional requestPath As String = Nothing, Optional provisioningState As String = Nothing, Optional name As String = Nothing, Optional etag As String = Nothing, Optional type As String = Nothing)

Parameters

protocol
String

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. Possible values include: 'Http', 'Tcp', 'Https'

port
Int32

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

id
String

Resource ID.

loadBalancingRules
IList<SubResource>

The load balancer rules that use this probe.

intervalInSeconds
Nullable<Int32>

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.

numberOfProbes
Nullable<Int32>

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.

probeThreshold
Nullable<Int32>

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.

requestPath
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.

provisioningState
String

The provisioning state of the probe resource. Possible values include: 'Succeeded', 'Updating', 'Deleting', 'Failed'

name
String

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.

etag
String

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

type
String

Type of the resource.

Applies to