website·Indexed 32 days ago
https://consuldot.netAPI documentation for the Consul .NET client library (Consul.dll). It provides interfaces and classes for interacting with Consul API endpoints, including IKVEndpoint for key-value store operations, IHealthEndpoint for health checks, IAgentEndpoint for agent management, and ICatalogEndpoint for catalog operations, as well as support for ACL tokens and TLS configuration.
JWTProviderEntry class in the Consul namespace is used to configure Consul to use JSON Web Tokens (JWT) and JSON Web Key Sets (JWKS). This allows the addition of JWT validation to proxies within the service mesh.public class JWTProviderEntryPreparedQuery class (Namespace: Consul, Assembly: Consul.dll) implements the IPreparedQueryEndpoint interface. It is the primary entry point for managing prepared queries in Consul, allowing developers to define queries once and execute them repeatedly by ID or name.PolicyLink class (located in the Consul namespace within Consul.dll) serves as the base representation for an Access Control List (ACL) Policy in Consul. It allows developers to track the unique identifier and the human-readable name of a policy.using Consul;
// Example of initializing a PolicyLink
var policy = new PolicyLink("policy-id", "policy-name");Lock class in the Consul namespace (Assembly: Consul.dll) is used to implement client-side leader election. It implements the IDistributedLock interface and follows the standard Consul leader election algorithm. Because Consul sessions prefer liveness over safety, locks can be lost at any time due to session invalidation, communication errors, or operator intervention. Developers must check the IsHeld property before entering critical sections of code.while (myLock.IsHeld)
{
// critical section
}ConsulLicense class in the Consul namespace (contained in Consul.dll) provides information about the current license status of the Consul instance. It includes properties to retrieve the license object, check if the license is valid, and view any associated warnings.public class ConsulLicenseClusterPeeringStatus class in the Consul namespace (Assembly: Consul.dll) represents the current status of a cluster peering connection in Consul. It provides details about the peering identity, server addresses, connection state, and stream status.public class ClusterPeeringStatusRole class (Namespace: Consul, Assembly: Consul.dll) is used to interact with ACL Roles in Consul through the API. It implements the IRoleEndpoint interface and provides methods for the full lifecycle of ACL roles.PolicyEntry class in the Consul namespace (Assembly: Consul.dll) is used to define and manage ACL Policies in Consul. It contains metadata about the policy, including its unique identifier, name, description, the actual rules governing access, and the datacenters where the policy applies.using Consul;
// Example: Creating a policy entry with basic details
var policy = new PolicyEntry("policy-id", "Policy Name");CatalogRegistration class in the Consul namespace (Assembly: Consul.dll) is used to represent a service registration within the Consul catalog. It contains details about the node, the service instance, and its health check configuration.public class CatalogRegistration
{
public string Address { get; set; }
public AgentCheck Check { get; set; }
public string Datacenter { get; set; }
public string Node { get; set; }
public AgentService Service { get; set; }
}ISnapshotEndpoint interface, located in the Consul namespace within Consul.dll, defines the contract for interacting with the Consul Snapshot API endpoints. It provides the primary mechanisms for backing up (Save) and recovering (Restore) the cluster state.