HealthCheck Class

Declaration Syntax

C#

public class HealthCheck

Members

Icon

Member

Description

HealthCheck()()()()

Default constructor for a new HealthCheck object. Callers should use the properties or fluent setter (With...) methods to initialize this object after creating it.

HealthCheck(String, Int32, Int32, Int32, Int32)

Constructs a new HealthCheck object. Callers should use the properties or fluent setter (With...) methods to initialize any additional object members.

Equals(Object)

Determines whether the specified Object is equal to the current Object.

(Inherited from Object.)

GetHashCode()()()()

Serves as a hash function for a particular type.

(Inherited from Object.)

GetType()()()()

Gets the type of the current instance.

(Inherited from Object.)

HealthyThreshold

Specifies the number of consecutive health probe successes required before moving the instance to the Healthy state.

Constraints:

Range: 2 - 10

Interval

Specifies the approximate interval, in seconds, between health checks of an individual instance.

Constraints:

Range: 1 - 300

Target

Specifies the instance being checked. The protocol is either TCP, HTTP, HTTPS, or SSL. The range of valid ports is one (1) through 65535.

Note:

TCP is the default, specified as a TCP: port pair, for example "TCP:5000". In this case a healthcheck simply attempts to open a TCP connection to the instance on the specified port. Failure to connect within the configured timeout is considered unhealthy. SSL is also specified as SSL: port pair, for example, SSL:5000. For HTTP or HTTPS protocol, the situation is different. You have to include a ping path in the string. HTTP is specified as a HTTP:port;/;PathToPing; grouping, for example "HTTP:80/weather/us/wa/seattle". In this case, a HTTP GET request is issued to the instance on the given port and path. Any answer other than "200 OK" within the timeout period is considered unhealthy. The total length of the HTTP ping target needs to be 1024 16-bit Unicode characters or less.

Timeout

Specifies the amount of time, in seconds, during which no response means a failed health probe.

Note:
This value must be less than the Interval value.

Constraints:

Range: 1 - 300

ToString()()()()

Returns a string that represents the current object.

(Inherited from Object.)

UnhealthyThreshold

Specifies the number of consecutive health probe failures required before moving the instance to the Unhealthy state.

Constraints:

Range: 2 - 10

WithHealthyThreshold(Int32)

Obsolete.

Sets the HealthyThreshold property

WithInterval(Int32)

Obsolete.

Sets the Interval property

WithTarget(String)

Obsolete.

Sets the Target property

WithTimeout(Int32)

Obsolete.

Sets the Timeout property

WithUnhealthyThreshold(Int32)

Obsolete.

Sets the UnhealthyThreshold property

Inheritance Hierarchy

Object
	HealthCheck

All Members	Constructors	Methods	Properties
Public Protected		Instance Static		Declared Inherited