Skip to main content

Class AgentServiceCheck

Namespace: Consul
Assembly: Consul.dll

AgentServiceCheck is used to create an associated check for a service

public class AgentServiceCheck

Inheritance​

object ← AgentServiceCheck

Derived​

AgentCheckRegistration

Inherited Members​

object.Equals(object) , object.Equals(object, object) , object.GetHashCode() , object.GetType() , object.MemberwiseClone() , object.ReferenceEquals(object, object) , object.ToString()

Properties​

AliasNode​

[JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
public string AliasNode { get; set; }

Property Value​

string

AliasService​

[JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
public string AliasService { get; set; }

Property Value​

string

Args​

[JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
public string[] Args { get; set; }

Property Value​

string []

Body​

[JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
public string Body { get; set; }

Property Value​

string

CheckID​

[JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
public string CheckID { get; set; }

Property Value​

string

DeregisterCriticalServiceAfter​

In Consul 0.7 and later, checks that are associated with a service may also contain this optional DeregisterCriticalServiceAfter field, which is a timeout in the same Go time format as Interval and TTL. If a check is in the critical state for more than this configured value, then its associated service (and all of its associated checks) will automatically be deregistered.

[JsonConverter(typeof(DurationTimespanConverter))]
[JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
public TimeSpan? DeregisterCriticalServiceAfter { get; set; }

Property Value​

TimeSpan ?

DockerContainerID​

[JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
public string DockerContainerID { get; set; }

Property Value​

string

GRPC​

[JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
public string GRPC { get; set; }

Property Value​

string

GRPCUseTLS​

[JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
public bool GRPCUseTLS { get; set; }

Property Value​

bool

HTTP​

[JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
public string HTTP { get; set; }

Property Value​

string

Header​

[JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
public Dictionary<string, List<string>> Header { get; set; }

Property Value​

Dictionary <string , List <string >>

ID​

[Obsolete("Use CheckId instead")]
[JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
public string ID { get; set; }

Property Value​

string

Interval​

[JsonConverter(typeof(DurationTimespanConverter))]
[JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
public TimeSpan? Interval { get; set; }

Property Value​

TimeSpan ?

Method​

[JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
public string Method { get; set; }

Property Value​

string

Name​

[JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
public string Name { get; set; }

Property Value​

string

Notes​

[JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
public string Notes { get; set; }

Property Value​

string

Script​

[JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
public string Script { get; set; }

Property Value​

string

Shell​

[JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
public string Shell { get; set; }

Property Value​

string

Status​

[JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
[JsonConverter(typeof(HealthStatusConverter))]
public HealthStatus Status { get; set; }

Property Value​

HealthStatus

TCP​

[JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
public string TCP { get; set; }

Property Value​

string

TLSSkipVerify​

[JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
public bool TLSSkipVerify { get; set; }

Property Value​

bool

TTL​

[JsonConverter(typeof(DurationTimespanConverter))]
[JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
public TimeSpan? TTL { get; set; }

Property Value​

TimeSpan ?

Timeout​

[JsonConverter(typeof(DurationTimespanConverter))]
[JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
public TimeSpan? Timeout { get; set; }

Property Value​

TimeSpan ?

  • Properties
    • AliasNode
    • AliasService
    • Args
    • Body
    • CheckID
    • DeregisterCriticalServiceAfter
    • DockerContainerID
    • GRPC
    • GRPCUseTLS
    • HTTP
    • Header
    • ID
    • Interval
    • Method
    • Name
    • Notes
    • Script
    • Shell
    • Status
    • TCP
    • TLSSkipVerify
    • TTL
    • Timeout