Share via


Probe Class

Definition

A load balancer probe.

[Microsoft.Rest.Serialization.JsonTransformation]
public class Probe : Microsoft.Azure.PowerShell.Cmdlets.Websites.Helper.Network.Models.SubResource
[<Microsoft.Rest.Serialization.JsonTransformation>]
type Probe = class
    inherit SubResource
Public Class Probe
Inherits SubResource
Inheritance
Attributes

Constructors

Probe()

Initializes a new instance of the Probe class.

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

Initializes a new instance of the Probe class.

Properties

Etag

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

Id

Gets or sets resource ID.

(Inherited from SubResource)
IntervalInSeconds

Gets or sets 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

Gets the load balancer rules that use this probe.

Name

Gets or sets 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.

NumberOfProbes

Gets or sets 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

Gets or sets the port for communicating the probe. Possible values range from 1 to 65535, inclusive.

Protocol

Gets or sets 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'

ProvisioningState

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

RequestPath

Gets or sets 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.

Type

Gets type of the resource.

Methods

Validate()

Validate the object.

Applies to