Interface IAgentEndpoint
Namespace: Consul
Assembly: Consul.dll
The interface for the Agent API Endpoints
public interface IAgentEndpoint
Properties
NodeName
[Obsolete("This property will be removed in a future release. Replace uses of it with a call to GetNodeName()")]
string NodeName { get; }
Property Value
Methods
CheckDeregister(string, CancellationToken)
Task<WriteResult> CheckDeregister(string checkID, CancellationToken ct = default)
Parameters
checkID string
Returns
Task <WriteResult >
CheckRegister(AgentCheckRegistration, CancellationToken)
Task<WriteResult> CheckRegister(AgentCheckRegistration check, CancellationToken ct = default)
Parameters
check AgentCheckRegistration
Returns
Task <WriteResult >
Checks(CancellationToken)
Task<QueryResult<Dictionary<string, AgentCheck>>> Checks(CancellationToken ct = default)
Parameters
Returns
Task <QueryResult <Dictionary <string , AgentCheck >>>
Checks(Filter, CancellationToken)
Task<QueryResult<Dictionary<string, AgentCheck>>> Checks(Filter filter, CancellationToken ct = default)
Parameters
filter Filter
Returns
Task <QueryResult <Dictionary <string , AgentCheck >>>
ConnectAuthorize(AgentAuthorizeParameters, CancellationToken)
Task<WriteResult<AgentAuthorizeResponse>> ConnectAuthorize(AgentAuthorizeParameters parameters, CancellationToken ct = default)
Parameters
parameters AgentAuthorizeParameters
Returns
Task <WriteResult <AgentAuthorizeResponse >>
ConnectAuthorize(AgentAuthorizeParameters, WriteOptions, CancellationToken)
Task<WriteResult<AgentAuthorizeResponse>> ConnectAuthorize(AgentAuthorizeParameters parameters, WriteOptions w, CancellationToken ct = default)
Parameters
parameters AgentAuthorizeParameters
Returns
Task <WriteResult <AgentAuthorizeResponse >>
DisableNodeMaintenance(CancellationToken)
Task<WriteResult> DisableNodeMaintenance(CancellationToken ct = default)
Parameters
Returns
Task <WriteResult >
DisableServiceMaintenance(string, CancellationToken)
Task<WriteResult> DisableServiceMaintenance(string serviceID, CancellationToken ct = default)
Parameters
serviceID string
Returns
Task <WriteResult >
EnableNodeMaintenance(string, CancellationToken)
Task<WriteResult> EnableNodeMaintenance(string reason, CancellationToken ct = default)
Parameters
reason string
Returns
Task <WriteResult >
EnableServiceMaintenance(string, string, CancellationToken)
Task<WriteResult> EnableServiceMaintenance(string serviceID, string reason, CancellationToken ct = default)
Parameters
serviceID string
reason string
Returns
Task <WriteResult >
FailTTL(string, string, CancellationToken)
Task FailTTL(string checkID, string note, CancellationToken ct = default)
Parameters
checkID string
note string
Returns
ForceLeave(string, CancellationToken)
Task<WriteResult> ForceLeave(string node, CancellationToken ct = default)
Parameters
node string
Returns
Task <WriteResult >
GetAgentHostInfo(CancellationToken)
Task<QueryResult<AgentHostInfo>> GetAgentHostInfo(CancellationToken ct = default)
Parameters
Returns
Task <QueryResult <AgentHostInfo >>
GetAgentMetrics(CancellationToken)
Task<QueryResult<Metrics>> GetAgentMetrics(CancellationToken ct = default)
Parameters
Returns
Task <QueryResult <Metrics >>
GetAgentVersion(CancellationToken)
Task<QueryResult<AgentVersion>> GetAgentVersion(CancellationToken ct = default)
Parameters
Returns
Task <QueryResult <AgentVersion >>
GetCALeaf(string, CancellationToken)
Task<QueryResult<CALeaf>> GetCALeaf(string serviceId, CancellationToken ct = default)
Parameters
serviceId string
Returns
Task <QueryResult <CALeaf >>
GetCALeaf(string, QueryOptions, CancellationToken)
Task<QueryResult<CALeaf>> GetCALeaf(string serviceId, QueryOptions q, CancellationToken ct = default)
Parameters
serviceId string
Returns
Task <QueryResult <CALeaf >>
GetCARoots(CancellationToken)
Task<QueryResult<CARoots>> GetCARoots(CancellationToken ct = default)
Parameters
Returns
Task <QueryResult <CARoots >>
GetCARoots(QueryOptions, CancellationToken)
Task<QueryResult<CARoots>> GetCARoots(QueryOptions q, CancellationToken ct = default)
Parameters
Returns
Task <QueryResult <CARoots >>
GetLocalServiceHealth(string, QueryOptions, CancellationToken)
Task<QueryResult<LocalServiceHealth[]>> GetLocalServiceHealth(string serviceName, QueryOptions q, CancellationToken ct = default)
Parameters
serviceName string
Returns
Task <QueryResult <LocalServiceHealth []>>
GetLocalServiceHealth(string, CancellationToken)
Task<QueryResult<LocalServiceHealth[]>> GetLocalServiceHealth(string serviceName, CancellationToken ct = default)
Parameters
serviceName string
Returns
Task <QueryResult <LocalServiceHealth []>>
GetLocalServiceHealthByID(string, QueryOptions, CancellationToken)
Task<QueryResult<LocalServiceHealth>> GetLocalServiceHealthByID(string serviceID, QueryOptions q, CancellationToken ct = default)
Parameters
serviceID string
Returns
Task <QueryResult <LocalServiceHealth >>
GetLocalServiceHealthByID(string, CancellationToken)
Task<QueryResult<LocalServiceHealth>> GetLocalServiceHealthByID(string serviceID, CancellationToken ct = default)
Parameters
serviceID string
Returns
Task <QueryResult <LocalServiceHealth >>
GetNodeName(CancellationToken)
Task<string> GetNodeName(CancellationToken ct = default)
Parameters
Returns
GetServiceConfiguration(string, QueryOptions, CancellationToken)
Task<QueryResult<ServiceConfiguration>> GetServiceConfiguration(string serviceID, QueryOptions q, CancellationToken ct = default)
Parameters
serviceID string
Returns
Task <QueryResult <ServiceConfiguration >>
GetServiceConfiguration(string, CancellationToken)
Task<QueryResult<ServiceConfiguration>> GetServiceConfiguration(string serviceID, CancellationToken ct = default)
Parameters
serviceID string
Returns
Task <QueryResult <ServiceConfiguration >>
GetWorstLocalServiceHealth(string, QueryOptions, CancellationToken)
Task<QueryResult<string>> GetWorstLocalServiceHealth(string serviceName, QueryOptions q, CancellationToken ct = default)
Parameters
serviceName string
Returns
Task <QueryResult <string >>
GetWorstLocalServiceHealth(string, CancellationToken)
Task<QueryResult<string>> GetWorstLocalServiceHealth(string serviceName, CancellationToken ct = default)
Parameters
serviceName string
Returns
Task <QueryResult <string >>
Join(string, bool, CancellationToken)
Task<WriteResult> Join(string addr, bool wan, CancellationToken ct = default)
Parameters
addr string
wan bool
Returns
Task <WriteResult >
Leave(string, CancellationToken)
Task<WriteResult> Leave(string node, CancellationToken ct = default)
Parameters
node string
Returns
Task <WriteResult >
Members(bool, CancellationToken)
Task<QueryResult<AgentMember[]>> Members(bool wan, CancellationToken ct = default)
Parameters
wan bool
Returns
Task <QueryResult <AgentMember []>>
Monitor(LogLevel, CancellationToken)
Task<Agent.LogStream> Monitor(LogLevel level = LogLevel.Info, CancellationToken ct = default)
Parameters
level LogLevel
Returns
MonitorJSON(LogLevel, CancellationToken)
Task<Agent.LogStream> MonitorJSON(LogLevel level = LogLevel.Info, CancellationToken ct = default)
Parameters
level LogLevel
Returns
PassTTL(string, string, CancellationToken)
Task PassTTL(string checkID, string note, CancellationToken ct = default)
Parameters
checkID string
note string
Returns
Reload(CancellationToken)
Task<WriteResult> Reload(CancellationToken ct = default)
Parameters
Returns
Task <WriteResult >
Reload(string, CancellationToken)
[Obsolete]
Task<WriteResult> Reload(string node, CancellationToken ct = default)
Parameters
node string
Returns
Task <WriteResult >
Self(CancellationToken)
Task<QueryResult<Dictionary<string, Dictionary<string, dynamic>>>> Self(CancellationToken ct = default)
Parameters
Returns
Task <QueryResult <Dictionary <string , Dictionary <string , dynamic>>>>
ServiceDeregister(string, CancellationToken)
Task<WriteResult> ServiceDeregister(string serviceID, CancellationToken ct = default)
Parameters
serviceID string
Returns
Task <WriteResult >
ServiceRegister(AgentServiceRegistration, CancellationToken)
Task<WriteResult> ServiceRegister(AgentServiceRegistration service, CancellationToken ct = default)
Parameters
service AgentServiceRegistration
Returns
Task <WriteResult >
ServiceRegister(AgentServiceRegistration, bool, CancellationToken)
Task<WriteResult> ServiceRegister(AgentServiceRegistration service, bool replaceExistingChecks, CancellationToken ct = default)
Parameters
service AgentServiceRegistration
replaceExistingChecks bool
Returns
Task <WriteResult >
Services(CancellationToken)
Task<QueryResult<Dictionary<string, AgentService>>> Services(CancellationToken ct = default)
Parameters
Returns
Task <QueryResult <Dictionary <string , AgentService >>>
Services(Filter, CancellationToken)
Task<QueryResult<Dictionary<string, AgentService>>> Services(Filter filter, CancellationToken ct = default)
Parameters
filter Filter
Returns
Task <QueryResult <Dictionary <string , AgentService >>>
UpdateTTL(string, string, TTLStatus, CancellationToken)
Task<WriteResult> UpdateTTL(string checkID, string output, TTLStatus status, CancellationToken ct = default)
Parameters
checkID string
output string
status TTLStatus
Returns
Task <WriteResult >
WarnTTL(string, string, CancellationToken)
Task WarnTTL(string checkID, string note, CancellationToken ct = default)
Parameters
checkID string
note string