Skip to main content

Class Policy

Namespace: Consul
Assembly: Consul.dll

Policy is used to interact with ACL Policies in Consul through the API

public class Policy : IPolicyEndpoint

Inheritance​

object ← Policy

Implements​

IPolicyEndpoint

Inherited Members​

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

Methods​

Create(PolicyEntry, CancellationToken)​

Creates a new ACL Policy in Consul

public Task<WriteResult<PolicyEntry>> Create(PolicyEntry policy, CancellationToken ct)

Parameters​

policy PolicyEntry

The new ACL PolicyEntry

ct CancellationToken

Cancellation token for long poll request. If set, OperationCanceledException will be thrown if the request is cancelled before completing

Returns​

Task <WriteResult <PolicyEntry >>

A write result containing the created ACL Policy

Create(PolicyEntry)​

public Task<WriteResult<PolicyEntry>> Create(PolicyEntry policy)

Parameters​

policy PolicyEntry

Returns​

Task <WriteResult <PolicyEntry >>

Create(PolicyEntry, WriteOptions, CancellationToken)​

Creates a new ACL Policy in Consul

public Task<WriteResult<PolicyEntry>> Create(PolicyEntry policy, WriteOptions writeOptions, CancellationToken ct = default)

Parameters​

policy PolicyEntry

The new ACL PolicyEntry

writeOptions WriteOptions

Customised write options

ct CancellationToken

Cancellation token for long poll request. If set, OperationCanceledException will be thrown if the request is cancelled before completing

Returns​

Task <WriteResult <PolicyEntry >>

A write result containing the created ACL Policy

Delete(string, CancellationToken)​

Deletes an existing ACL Policy in Consul

public Task<WriteResult<bool>> Delete(string id, CancellationToken ct)

Parameters​

id string

The ID of the ACL Policy to delete

ct CancellationToken

Cancellation token for long poll request. If set, OperationCanceledException will be thrown if the request is cancelled before completing

Returns​

Task <WriteResult <bool >>

Success (true) or failure (false)

Delete(string)​

public Task<WriteResult<bool>> Delete(string id)

Parameters​

id string

Returns​

Task <WriteResult <bool >>

Delete(string, WriteOptions, CancellationToken)​

Deletes an existing ACL Policy in Consul

public Task<WriteResult<bool>> Delete(string id, WriteOptions writeOptions, CancellationToken ct = default)

Parameters​

id string

The ID of the ACL Policy to delete

writeOptions WriteOptions

Customised write options

ct CancellationToken

Cancellation token for long poll request. If set, OperationCanceledException will be thrown if the request is cancelled before completing

Returns​

Task <WriteResult <bool >>

Success (true) or failure (false)

List(CancellationToken)​

Lists the existing ACL Policies in Consul

public Task<QueryResult<PolicyEntry[]>> List(CancellationToken ct)

Parameters​

ct CancellationToken

Cancellation token for long poll request. If set, OperationCanceledException will be thrown if the request is cancelled before completing

Returns​

Task <QueryResult <PolicyEntry []>>

A query result containing an array of ACL Policies

List()​

public Task<QueryResult<PolicyEntry[]>> List()

Returns​

Task <QueryResult <PolicyEntry []>>

List(QueryOptions, CancellationToken)​

Lists the existing ACL Policies in Consul

public Task<QueryResult<PolicyEntry[]>> List(QueryOptions queryOptions, CancellationToken ct = default)

Parameters​

queryOptions QueryOptions

Customised query options

ct CancellationToken

Cancellation token for long poll request. If set, OperationCanceledException will be thrown if the request is cancelled before completing

Returns​

Task <QueryResult <PolicyEntry []>>

A query result containing an array of ACL Policies

ListTemplatedPolicies(QueryOptions, CancellationToken)​

Returns a list of all templated policies

public Task<QueryResult<Dictionary<string, TemplatedPolicyResponse>>> ListTemplatedPolicies(QueryOptions q, CancellationToken ct = default)

Parameters​

q QueryOptions

ct CancellationToken

Returns​

Task <QueryResult <Dictionary <string , TemplatedPolicyResponse >>>

ListTemplatedPolicies(CancellationToken)​

Returns a list of all templated policies

public Task<QueryResult<Dictionary<string, TemplatedPolicyResponse>>> ListTemplatedPolicies(CancellationToken ct)

Parameters​

ct CancellationToken

Returns​

Task <QueryResult <Dictionary <string , TemplatedPolicyResponse >>>

ListTemplatedPolicies()​

public Task<QueryResult<Dictionary<string, TemplatedPolicyResponse>>> ListTemplatedPolicies()

Returns​

Task <QueryResult <Dictionary <string , TemplatedPolicyResponse >>>

PreviewTemplatedPolicy(string, WriteOptions, CancellationToken)​

Shows the policy created from a templated policy.

public Task<WriteResult<PolicyEntry>> PreviewTemplatedPolicy(string name, WriteOptions options, CancellationToken ct = default)

Parameters​

name string

options WriteOptions

ct CancellationToken

Returns​

Task <WriteResult <PolicyEntry >>

An ACL Policy

PreviewTemplatedPolicy(string, CancellationToken)​

Shows the policy created from a templated policy.

public Task<WriteResult<PolicyEntry>> PreviewTemplatedPolicy(string name, CancellationToken ct)

Parameters​

name string

ct CancellationToken

Returns​

Task <WriteResult <PolicyEntry >>

An ACL Policy

PreviewTemplatedPolicy(string)​

public Task<WriteResult<PolicyEntry>> PreviewTemplatedPolicy(string name)

Parameters​

name string

Returns​

Task <WriteResult <PolicyEntry >>

Read(string, CancellationToken)​

Gets the requested ACL Policy from Consul

public Task<QueryResult<PolicyEntry>> Read(string id, CancellationToken ct)

Parameters​

id string

The ID of the ACL Policy to get

ct CancellationToken

Cancellation token for long poll request. If set, OperationCanceledException will be thrown if the request is cancelled before completing

Returns​

Task <QueryResult <PolicyEntry >>

A query result containing the requested ACL Policy

Read(string)​

public Task<QueryResult<PolicyEntry>> Read(string id)

Parameters​

id string

Returns​

Task <QueryResult <PolicyEntry >>

Read(string, QueryOptions, CancellationToken)​

Gets the requested ACL Policy from Consul

public Task<QueryResult<PolicyEntry>> Read(string id, QueryOptions queryOptions, CancellationToken ct = default)

Parameters​

id string

The ID of the ACL Policy to get

queryOptions QueryOptions

Customised query options

ct CancellationToken

Cancellation token for long poll request. If set, OperationCanceledException will be thrown if the request is cancelled before completing

Returns​

Task <QueryResult <PolicyEntry >>

A query result containing the requested ACL Policy

ReadPolicyByName(string, CancellationToken)​

Gets the requested ACL Policy from Consul

public Task<QueryResult<PolicyEntry>> ReadPolicyByName(string name, CancellationToken ct)

Parameters​

name string

The name of the ACL Policy to get

ct CancellationToken

Cancellation token for long poll request. If set, OperationCanceledException will be thrown if the request is cancelled before completing

Returns​

Task <QueryResult <PolicyEntry >>

A query result containing the requested ACL Policy

ReadPolicyByName(string)​

public Task<QueryResult<PolicyEntry>> ReadPolicyByName(string name)

Parameters​

name string

Returns​

Task <QueryResult <PolicyEntry >>

ReadPolicyByName(string, QueryOptions, CancellationToken)​

Gets the requested ACL Policy from Consul

public Task<QueryResult<PolicyEntry>> ReadPolicyByName(string name, QueryOptions queryOptions, CancellationToken ct = default)

Parameters​

name string

The name of the ACL Policy to get

queryOptions QueryOptions

Customised query options

ct CancellationToken

Cancellation token for long poll request. If set, OperationCanceledException will be thrown if the request is cancelled before completing

Returns​

Task <QueryResult <PolicyEntry >>

A query result containing the requested ACL Policy

ReadTemplatedPolicyByName(string, QueryOptions, CancellationToken)​

Reads an ACL policy with the given ID or name parameter

public Task<QueryResult<TemplatedPolicyResponse>> ReadTemplatedPolicyByName(string name, QueryOptions q, CancellationToken ct = default)

Parameters​

name string

q QueryOptions

ct CancellationToken

Returns​

Task <QueryResult <TemplatedPolicyResponse >>

Returns an ACL Policy

ReadTemplatedPolicyByName(string, CancellationToken)​

Reads an ACL policy with the given ID or name parameter

public Task<QueryResult<TemplatedPolicyResponse>> ReadTemplatedPolicyByName(string name, CancellationToken ct)

Parameters​

name string

ct CancellationToken

Returns​

Task <QueryResult <TemplatedPolicyResponse >>

Returns an ACL Policy

ReadTemplatedPolicyByName(string)​

public Task<QueryResult<TemplatedPolicyResponse>> ReadTemplatedPolicyByName(string name)

Parameters​

name string

Returns​

Task <QueryResult <TemplatedPolicyResponse >>

Update(PolicyEntry, CancellationToken)​

Updates an existing ACL Policy in Consul

public Task<WriteResult<PolicyEntry>> Update(PolicyEntry policy, CancellationToken ct)

Parameters​

policy PolicyEntry

The modified ACL Policy

ct CancellationToken

Cancellation token for long poll request. If set, OperationCanceledException will be thrown if the request is cancelled before completing

Returns​

Task <WriteResult <PolicyEntry >>

A write result containing the updated ACL Policy

Update(PolicyEntry)​

public Task<WriteResult<PolicyEntry>> Update(PolicyEntry policy)

Parameters​

policy PolicyEntry

Returns​

Task <WriteResult <PolicyEntry >>

Update(PolicyEntry, WriteOptions, CancellationToken)​

Updates an existing ACL Policy in Consul

public Task<WriteResult<PolicyEntry>> Update(PolicyEntry policy, WriteOptions writeOptions, CancellationToken ct = default)

Parameters​

policy PolicyEntry

The modified ACL Policy

writeOptions WriteOptions

Customised write options

ct CancellationToken

Cancellation token for long poll request. If set, OperationCanceledException will be thrown if the request is cancelled before completing

Returns​

Task <WriteResult <PolicyEntry >>

A write result containing the updated ACL policy

  • Methods
    • Create(PolicyEntry, CancellationToken)
    • Create(PolicyEntry)
    • Create(PolicyEntry, WriteOptions, CancellationToken)
    • Delete(string, CancellationToken)
    • Delete(string)
    • Delete(string, WriteOptions, CancellationToken)
    • List(CancellationToken)
    • List()
    • List(QueryOptions, CancellationToken)
    • ListTemplatedPolicies(QueryOptions, CancellationToken)
    • ListTemplatedPolicies(CancellationToken)
    • ListTemplatedPolicies()
    • PreviewTemplatedPolicy(string, WriteOptions, CancellationToken)
    • PreviewTemplatedPolicy(string, CancellationToken)
    • PreviewTemplatedPolicy(string)
    • Read(string, CancellationToken)
    • Read(string)
    • Read(string, QueryOptions, CancellationToken)
    • ReadPolicyByName(string, CancellationToken)
    • ReadPolicyByName(string)
    • ReadPolicyByName(string, QueryOptions, CancellationToken)
    • ReadTemplatedPolicyByName(string, QueryOptions, CancellationToken)
    • ReadTemplatedPolicyByName(string, CancellationToken)
    • ReadTemplatedPolicyByName(string)
    • Update(PolicyEntry, CancellationToken)
    • Update(PolicyEntry)
    • Update(PolicyEntry, WriteOptions, CancellationToken)