Skip to main content

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

ct CancellationToken

Returns

Task <WriteResult <PolicyEntry >>

Create(PolicyEntry, WriteOptions, CancellationToken)

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

Parameters

policy PolicyEntry

q WriteOptions

ct CancellationToken

Returns

Task <WriteResult <PolicyEntry >>

Delete(string, CancellationToken)

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

Parameters

id string

ct CancellationToken

Returns

Task <WriteResult <bool >>

Delete(string, WriteOptions, CancellationToken)

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

Parameters

id string

q WriteOptions

ct CancellationToken

Returns

Task <WriteResult <bool >>

List(CancellationToken)

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

Parameters

ct CancellationToken

Returns

Task <QueryResult <PolicyEntry []>>

List(QueryOptions, CancellationToken)

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

Parameters

q QueryOptions

ct CancellationToken

Returns

Task <QueryResult <PolicyEntry []>>

Read(string, CancellationToken)

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

Parameters

id string

ct CancellationToken

Returns

Task <QueryResult <PolicyEntry >>

Read(string, QueryOptions, CancellationToken)

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

Parameters

id string

q QueryOptions

ct CancellationToken

Returns

Task <QueryResult <PolicyEntry >>

Update(PolicyEntry, CancellationToken)

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

Parameters

policy PolicyEntry

ct CancellationToken

Returns

Task <WriteResult <PolicyEntry >>

Update(PolicyEntry, WriteOptions, CancellationToken)

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

Parameters

policy PolicyEntry

q WriteOptions

ct CancellationToken

Returns

Task <WriteResult <PolicyEntry >>

  • Methods
    • Create(PolicyEntry, CancellationToken)
    • Create(PolicyEntry, WriteOptions, CancellationToken)
    • Delete(string, CancellationToken)
    • Delete(string, WriteOptions, CancellationToken)
    • List(CancellationToken)
    • List(QueryOptions, CancellationToken)
    • Read(string, CancellationToken)
    • Read(string, QueryOptions, CancellationToken)
    • Update(PolicyEntry, CancellationToken)
    • Update(PolicyEntry, WriteOptions, CancellationToken)