Class Connect
Namespace: Consul
Assembly: Consul.dll
public class Connect : IConnectEndpoint
Inheritance
Implements
Inherited Members
object.Equals(object) , object.Equals(object, object) , object.GetHashCode() , object.GetType() , object.MemberwiseClone() , object.ReferenceEquals(object, object) , object.ToString()
Methods
CAGetConfig(CancellationToken)
CAGetConfig returns the current CA configuration.
public Task<QueryResult<CAConfig>> CAGetConfig(CancellationToken ct = default)
Parameters
Returns
Task <QueryResult <CAConfig >>
CAGetConfig(QueryOptions, CancellationToken)
CAGetConfig returns the current CA configuration.
public Task<QueryResult<CAConfig>> CAGetConfig(QueryOptions q, CancellationToken ct = default)
Parameters
Returns
Task <QueryResult <CAConfig >>
CARoots(CancellationToken)
CARoots queries the list of available roots.
public Task<QueryResult<CARoots>> CARoots(CancellationToken ct = default)
Parameters
Returns
Task <QueryResult <CARoots >>
CARoots(QueryOptions, CancellationToken)
CARoots queries the list of available roots.
public Task<QueryResult<CARoots>> CARoots(QueryOptions q, CancellationToken ct = default)
Parameters
Returns
Task <QueryResult <CARoots >>
CASetConfig(CAConfig, CancellationToken)
CASetConfig sets the current CA configuration.
public Task<WriteResult> CASetConfig(CAConfig config, CancellationToken ct = default)
Parameters
config CAConfig
Returns
Task <WriteResult >
CASetConfig(CAConfig, WriteOptions, CancellationToken)
CASetConfig sets the current CA configuration.
public Task<WriteResult> CASetConfig(CAConfig config, WriteOptions q, CancellationToken ct = default)
Parameters
config CAConfig
Returns
Task <WriteResult >
DeleteIntentionByName(string, string, WriteOptions, CancellationToken)
Deletes a specific intention by its unique source and destination.
public Task<WriteResult> DeleteIntentionByName(string source, string destination, WriteOptions q, CancellationToken ct = default)
Parameters
source string
destination string
Returns
Task <WriteResult >
A Write Option
DeleteIntentionByName(string, string, CancellationToken)
Deletes a specific intention by its unique source and destination.
public Task<WriteResult> DeleteIntentionByName(string source, string destination, CancellationToken ct = default)
Parameters
source string
destination string
Returns
Task <WriteResult >
A Write Option
ListIntentions<ServiceIntention>(CancellationToken)
Retrieves a list of all configured service intentions
public Task<QueryResult<List<ServiceIntention>>> ListIntentions<ServiceIntention>(CancellationToken ct = default)
Parameters
Cancellation Token
Returns
Task <QueryResult <List <ServiceIntention>>>
A list of service intentions
Type Parameters
ServiceIntention
ListIntentions<ServiceIntention>(QueryOptions, CancellationToken)
Retrieves a list of all configured service intentions with query options
public Task<QueryResult<List<ServiceIntention>>> ListIntentions<ServiceIntention>(QueryOptions q, CancellationToken ct = default)
Parameters
Custom query options
Cancellation Token
Returns
Task <QueryResult <List <ServiceIntention>>>
A list of service intentions
Type Parameters
ServiceIntention
ListMatchingIntentions(string, string, QueryOptions, CancellationToken)
lists the intentions that match a given source or destination.
public Task<QueryResult<Dictionary<string, List<ServiceIntention>>>> ListMatchingIntentions(string by, string name, QueryOptions q, CancellationToken ct = default)
Parameters
by string
Specifies whether to match the "name" value by "source" or "destination".
name string
Specifies a name to match according to the source or destination
Returns
Task <QueryResult <Dictionary <string , List <ServiceIntention >>>>
A list of intentions that match the source of destination specified
ListMatchingIntentions(string, string, CancellationToken)
lists the intentions that match a given source or destination.
public Task<QueryResult<Dictionary<string, List<ServiceIntention>>>> ListMatchingIntentions(string by, string name, CancellationToken ct = default)
Parameters
by string
Specifies whether to match the "name" value by "source" or "destination".
name string
Specifies a name to match according to the source or destination
Returns
Task <QueryResult <Dictionary <string , List <ServiceIntention >>>>
A list of intentions that match the source of destination specified
ReadSpecificIntentionByName<ServiceIntention>(string, string, QueryOptions, CancellationToken)
reads a specific intention by its unique source and destination.
public Task<QueryResult<ServiceIntention>> ReadSpecificIntentionByName<ServiceIntention>(string source, string destination, QueryOptions q, CancellationToken ct = default)
Parameters
source string
destination string
Returns
Task <QueryResult <ServiceIntention>>
A service intention
Type Parameters
ServiceIntention
ReadSpecificIntentionByName<ServiceIntention>(string, string, CancellationToken)
reads a specific intention by its unique source and destination.
public Task<QueryResult<ServiceIntention>> ReadSpecificIntentionByName<ServiceIntention>(string source, string destination, CancellationToken ct = default)
Parameters
source string
destination string
Returns
Task <QueryResult <ServiceIntention>>
A service intention
Type Parameters
ServiceIntention
UpsertIntentionsByName(ServiceIntention, WriteOptions, CancellationToken)
Creates a new intention. The intentions created by this endpoint will not be assigned the following fields: ID, CreatedAt, UpdatedAt. Additionally, the Meta field cannot be persisted using this endpoint and will require editing the enclosing service-intentions config entry for the destination.
public Task<WriteResult<bool>> UpsertIntentionsByName(ServiceIntention intention, WriteOptions q, CancellationToken ct = default)
Parameters
intention ServiceIntention
Returns
Task <WriteResult <bool >>
True if the intention was created successfully or False if not
UpsertIntentionsByName(ServiceIntention, CancellationToken)
Creates a new intention. The intentions created by this endpoint will not be assigned the following fields: ID, CreatedAt, UpdatedAt. Additionally, the Meta field cannot be persisted using this endpoint and will require editing the enclosing service-intentions config entry for the destination.
public Task<WriteResult<bool>> UpsertIntentionsByName(ServiceIntention intention, CancellationToken ct = default)
Parameters
intention ServiceIntention
Returns
Task <WriteResult <bool >>
True if the intention was created successfully or False if not