Skip to main content

Interface IRoleEndpoint

Namespace: Consul
Assembly: Consul.dll

The interface for the ACL Role API Endpoints

public interface IRoleEndpoint

Methods

Create(RoleEntry, CancellationToken)

Task<WriteResult<RoleEntry>> Create(RoleEntry role, CancellationToken ct = default)

Parameters

role RoleEntry

ct CancellationToken

Returns

Task <WriteResult <RoleEntry >>

Create(RoleEntry, WriteOptions, CancellationToken)

Task<WriteResult<RoleEntry>> Create(RoleEntry role, WriteOptions q, CancellationToken ct = default)

Parameters

role RoleEntry

q WriteOptions

ct CancellationToken

Returns

Task <WriteResult <RoleEntry >>

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<RoleEntry[]>> List(CancellationToken ct = default)

Parameters

ct CancellationToken

Returns

Task <QueryResult <RoleEntry []>>

List(QueryOptions, CancellationToken)

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

Parameters

q QueryOptions

ct CancellationToken

Returns

Task <QueryResult <RoleEntry []>>

Read(string, CancellationToken)

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

Parameters

id string

ct CancellationToken

Returns

Task <QueryResult <RoleEntry >>

Read(string, QueryOptions, CancellationToken)

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

Parameters

id string

q QueryOptions

ct CancellationToken

Returns

Task <QueryResult <RoleEntry >>

ReadByName(string, CancellationToken)

Task<QueryResult<RoleEntry>> ReadByName(string name, CancellationToken ct = default)

Parameters

name string

ct CancellationToken

Returns

Task <QueryResult <RoleEntry >>

ReadByName(string, QueryOptions, CancellationToken)

Task<QueryResult<RoleEntry>> ReadByName(string name, QueryOptions q, CancellationToken ct = default)

Parameters

name string

q QueryOptions

ct CancellationToken

Returns

Task <QueryResult <RoleEntry >>

Update(RoleEntry, CancellationToken)

Task<WriteResult<RoleEntry>> Update(RoleEntry role, CancellationToken ct = default)

Parameters

role RoleEntry

ct CancellationToken

Returns

Task <WriteResult <RoleEntry >>

Update(RoleEntry, WriteOptions, CancellationToken)

Task<WriteResult<RoleEntry>> Update(RoleEntry role, WriteOptions q, CancellationToken ct = default)

Parameters

role RoleEntry

q WriteOptions

ct CancellationToken

Returns

Task <WriteResult <RoleEntry >>

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