Table of Contents

Class ManagementClient

Namespace
EasyNetQ.Management.Client
Assembly
EasyNetQ.Management.Client.dll
public class ManagementClient : IManagementClient, IDisposable
Inheritance
ManagementClient
Implements
Inherited Members
Extension Methods

Constructors

ManagementClient(HttpClient, string, string)

public ManagementClient(HttpClient httpClient, string username, string password)

Parameters

httpClient HttpClient
username string
password string

ManagementClient(string, string, string, int, TimeSpan?, Action<HttpRequestMessage>?, bool, Action<SocketsHttpHandler>?)

[Obsolete("Please use another constructor")]
public ManagementClient(string hostUrl, string username, string password, int portNumber = 15672, TimeSpan? timeout = null, Action<HttpRequestMessage>? configureHttpRequestMessage = null, bool ssl = false, Action<SocketsHttpHandler>? configureHttpHandler = null)

Parameters

hostUrl string
username string
password string
portNumber int
timeout TimeSpan?
configureHttpRequestMessage Action<HttpRequestMessage>
ssl bool
configureHttpHandler Action<SocketsHttpHandler>

ManagementClient(Uri, string, string, TimeSpan?, Action<HttpRequestMessage>?, Action<SocketsHttpHandler>?)

public ManagementClient(Uri endpoint, string username, string password, TimeSpan? timeout = null, Action<HttpRequestMessage>? configureHttpRequestMessage = null, Action<SocketsHttpHandler>? configureHttpHandler = null)

Parameters

endpoint Uri
username string
password string
timeout TimeSpan?
configureHttpRequestMessage Action<HttpRequestMessage>
configureHttpHandler Action<SocketsHttpHandler>

Properties

Endpoint

The endpoint that the client is using.

public Uri Endpoint { get; }

Property Value

Uri

Methods

CheckAsync(RelativePath, CancellationToken)

public Task<bool> CheckAsync(RelativePath path, CancellationToken cancellationToken = default)

Parameters

path RelativePath
cancellationToken CancellationToken

Returns

Task<bool>

DeleteAsync(RelativePath, IEnumerable<KeyValuePair<string, string>>?, CancellationToken)

public Task DeleteAsync(RelativePath path, IEnumerable<KeyValuePair<string, string>>? queryParameters, CancellationToken cancellationToken = default)

Parameters

path RelativePath
queryParameters IEnumerable<KeyValuePair<string, string>>
cancellationToken CancellationToken

Returns

Task

Dispose()

public void Dispose()

GetAsync<TResult>(RelativePath, IEnumerable<KeyValuePair<string, string>>?, CancellationToken)

public Task<TResult> GetAsync<TResult>(RelativePath path, IEnumerable<KeyValuePair<string, string>>? queryParameters, CancellationToken cancellationToken = default)

Parameters

path RelativePath
queryParameters IEnumerable<KeyValuePair<string, string>>
cancellationToken CancellationToken

Returns

Task<TResult>

Type Parameters

TResult

PostAsync(RelativePath, CancellationToken)

public Task PostAsync(RelativePath path, CancellationToken cancellationToken = default)

Parameters

path RelativePath
cancellationToken CancellationToken

Returns

Task

PostAsync<TItem>(RelativePath, TItem, CancellationToken)

public Task PostAsync<TItem>(RelativePath path, TItem item, CancellationToken cancellationToken = default)

Parameters

path RelativePath
item TItem
cancellationToken CancellationToken

Returns

Task

Type Parameters

TItem

PostAsync<TItem, TResult>(RelativePath, TItem, CancellationToken)

public Task<TResult> PostAsync<TItem, TResult>(RelativePath path, TItem item, CancellationToken cancellationToken = default)

Parameters

path RelativePath
item TItem
cancellationToken CancellationToken

Returns

Task<TResult>

Type Parameters

TItem
TResult

PutAsync(RelativePath, CancellationToken)

public Task PutAsync(RelativePath path, CancellationToken cancellationToken = default)

Parameters

path RelativePath
cancellationToken CancellationToken

Returns

Task

PutAsync<TBody>(RelativePath, TBody, CancellationToken)

public Task PutAsync<TBody>(RelativePath path, TBody item, CancellationToken cancellationToken = default)

Parameters

path RelativePath
item TBody
cancellationToken CancellationToken

Returns

Task

Type Parameters

TBody