ArmNetworkModelFactory.ProbeData Method

Definition

Initializes a new instance of ProbeData.

public static Azure.ResourceManager.Network.ProbeData ProbeData (Azure.Core.ResourceIdentifier id = default, string name = default, Azure.Core.ResourceType? resourceType = default, Azure.ETag? etag = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.Resources.Models.WritableSubResource> loadBalancingRules = default, Azure.ResourceManager.Network.Models.ProbeProtocol? protocol = default, int? port = default, int? intervalInSeconds = default, Azure.ResourceManager.Network.Models.ProbeNoHealthyBackendsBehavior? noHealthyBackendsBehavior = default, int? numberOfProbes = default, int? probeThreshold = default, string requestPath = default, Azure.ResourceManager.Network.Models.NetworkProvisioningState? provisioningState = default);
static member ProbeData : Azure.Core.ResourceIdentifier * string * Nullable<Azure.Core.ResourceType> * Nullable<Azure.ETag> * seq<Azure.ResourceManager.Resources.Models.WritableSubResource> * Nullable<Azure.ResourceManager.Network.Models.ProbeProtocol> * Nullable<int> * Nullable<int> * Nullable<Azure.ResourceManager.Network.Models.ProbeNoHealthyBackendsBehavior> * Nullable<int> * Nullable<int> * string * Nullable<Azure.ResourceManager.Network.Models.NetworkProvisioningState> -> Azure.ResourceManager.Network.ProbeData
Public Shared Function ProbeData (Optional id As ResourceIdentifier = Nothing, Optional name As String = Nothing, Optional resourceType As Nullable(Of ResourceType) = Nothing, Optional etag As Nullable(Of ETag) = Nothing, Optional loadBalancingRules As IEnumerable(Of WritableSubResource) = Nothing, Optional protocol As Nullable(Of ProbeProtocol) = Nothing, Optional port As Nullable(Of Integer) = Nothing, Optional intervalInSeconds As Nullable(Of Integer) = Nothing, Optional noHealthyBackendsBehavior As Nullable(Of ProbeNoHealthyBackendsBehavior) = Nothing, Optional numberOfProbes As Nullable(Of Integer) = Nothing, Optional probeThreshold As Nullable(Of Integer) = Nothing, Optional requestPath As String = Nothing, Optional provisioningState As Nullable(Of NetworkProvisioningState) = Nothing) As ProbeData

Parameters

id
ResourceIdentifier

Resource ID.

name
String

Resource name.

resourceType
Nullable<ResourceType>

Resource type.

etag
Nullable<ETag>

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

loadBalancingRules
IEnumerable<WritableSubResource>

The load balancer rules that use this probe.

protocol
Nullable<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.

port
Nullable<Int32>

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

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.

noHealthyBackendsBehavior
Nullable<ProbeNoHealthyBackendsBehavior>

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

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
Nullable<NetworkProvisioningState>

The provisioning state of the probe resource.

Returns

A new ProbeData instance for mocking.

Applies to