Interface IPolicyEndpoint
Namespace: Consul
Assembly: Consul.dll
The interface for the ACL Policy API Endpoints
public interface IPolicyEndpoint
Methods
Create(PolicyEntry, CancellationToken)
Task<WriteResult<PolicyEntry>> Create(PolicyEntry policy, CancellationToken ct = default)
Parameters
policy PolicyEntry
Returns
Task <WriteResult <PolicyEntry >>
Create(PolicyEntry, WriteOptions, CancellationToken)
Task<WriteResult<PolicyEntry>> Create(PolicyEntry policy, WriteOptions q, CancellationToken ct = default)
Parameters
policy PolicyEntry
Returns
Task <WriteResult <PolicyEntry >>
Delete(string, CancellationToken)
Task<WriteResult<bool>> Delete(string id, CancellationToken ct = default)
Parameters
id string
Returns
Task <WriteResult <bool >>
Delete(string, WriteOptions, CancellationToken)
Task<WriteResult<bool>> Delete(string id, WriteOptions q, CancellationToken ct = default)
Parameters
id string
Returns
Task <WriteResult <bool >>
List(CancellationToken)
Task<QueryResult<PolicyEntry[]>> List(CancellationToken ct = default)
Parameters
Returns
Task <QueryResult <PolicyEntry []>>
List(QueryOptions, CancellationToken)
Task<QueryResult<PolicyEntry[]>> List(QueryOptions q, CancellationToken ct = default)
Parameters
Returns
Task <QueryResult <PolicyEntry []>>
ListTemplatedPolicies(QueryOptions, CancellationToken)
Task<QueryResult<Dictionary<string, TemplatedPolicyResponse>>> ListTemplatedPolicies(QueryOptions q, CancellationToken ct = default)
Parameters
Returns
Task <QueryResult <Dictionary <string , TemplatedPolicyResponse >>>
ListTemplatedPolicies(CancellationToken)
Task<QueryResult<Dictionary<string, TemplatedPolicyResponse>>> ListTemplatedPolicies(CancellationToken ct = default)
Parameters
Returns
Task <QueryResult <Dictionary <string , TemplatedPolicyResponse >>>
PreviewTemplatedPolicy(string, WriteOptions, CancellationToken)
Task<WriteResult<PolicyEntry>> PreviewTemplatedPolicy(string name, WriteOptions q, CancellationToken ct = default)
Parameters
name string
Returns
Task <WriteResult <PolicyEntry >>
PreviewTemplatedPolicy(string, CancellationToken)
Task<WriteResult<PolicyEntry>> PreviewTemplatedPolicy(string name, CancellationToken ct = default)
Parameters
name string
Returns
Task <WriteResult <PolicyEntry >>
Read(string, CancellationToken)
Task<QueryResult<PolicyEntry>> Read(string id, CancellationToken ct = default)
Parameters
id string
Returns
Task <QueryResult <PolicyEntry >>
Read(string, QueryOptions, CancellationToken)
Task<QueryResult<PolicyEntry>> Read(string id, QueryOptions q, CancellationToken ct = default)
Parameters
id string
Returns
Task <QueryResult <PolicyEntry >>
ReadPolicyByName(string, CancellationToken)
Task<QueryResult<PolicyEntry>> ReadPolicyByName(string name, CancellationToken ct = default)
Parameters
name string
Returns
Task <QueryResult <PolicyEntry >>
ReadPolicyByName(string, QueryOptions, CancellationToken)
Task<QueryResult<PolicyEntry>> ReadPolicyByName(string name, QueryOptions q, CancellationToken ct = default)
Parameters
name string
Returns
Task <QueryResult <PolicyEntry >>
ReadTemplatedPolicyByName(string, QueryOptions, CancellationToken)
Task<QueryResult<TemplatedPolicyResponse>> ReadTemplatedPolicyByName(string name, QueryOptions q, CancellationToken ct = default)
Parameters
name string
Returns
Task <QueryResult <TemplatedPolicyResponse >>
ReadTemplatedPolicyByName(string, CancellationToken)
Task<QueryResult<TemplatedPolicyResponse>> ReadTemplatedPolicyByName(string name, CancellationToken ct = default)
Parameters
name string
Returns
Task <QueryResult <TemplatedPolicyResponse >>
Update(PolicyEntry, CancellationToken)
Task<WriteResult<PolicyEntry>> Update(PolicyEntry policy, CancellationToken ct = default)
Parameters
policy PolicyEntry
Returns
Task <WriteResult <PolicyEntry >>
Update(PolicyEntry, WriteOptions, CancellationToken)
Task<WriteResult<PolicyEntry>> Update(PolicyEntry policy, WriteOptions q, CancellationToken ct = default)
Parameters
policy PolicyEntry
Returns
Task <WriteResult <PolicyEntry >>