Class IManagementClientExtensions

Namespace: EasyNetQ.Management.Client

Assembly: EasyNetQ.Management.Client.dll

public static class IManagementClientExtensions

Inheritance: object

IManagementClientExtensions

Inherited Members: object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Methods

ChangeUserPassword(IManagementClient, User, string, CancellationToken)

public static void ChangeUserPassword(this IManagementClient client, User user, string newPassword, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
user User
newPassword string
cancellationToken CancellationToken

ChangeUserPassword(IManagementClient, string, string, CancellationToken)

public static void ChangeUserPassword(this IManagementClient client, string userName, string newPassword, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
userName string
newPassword string
cancellationToken CancellationToken

ChangeUserPasswordAsync(IManagementClient, User, string, CancellationToken)

public static Task ChangeUserPasswordAsync(this IManagementClient client, User user, string newPassword, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
user User
newPassword string
cancellationToken CancellationToken

Returns

Task

ChangeUserPasswordAsync(IManagementClient, string, string, CancellationToken)

Update the password of an user.

public static Task ChangeUserPasswordAsync(this IManagementClient client, string userName, string newPassword, CancellationToken cancellationToken = default)

Parameters

client IManagementClient: The client
userName string: The name of a user
newPassword string: The new password to set
cancellationToken CancellationToken

Returns

Task

Check(IManagementClient, RelativePath, CancellationToken)

public static bool Check(this IManagementClient client, RelativePath path, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
path RelativePath
cancellationToken CancellationToken

Returns

bool

CloseConnection(IManagementClient, Connection, CancellationToken)

public static void CloseConnection(this IManagementClient client, Connection connection, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
connection Connection
cancellationToken CancellationToken

CloseConnection(IManagementClient, string, CancellationToken)

public static void CloseConnection(this IManagementClient client, string connectionName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
connectionName string
cancellationToken CancellationToken

CloseConnectionAsync(IManagementClient, Connection, CancellationToken)

public static Task CloseConnectionAsync(this IManagementClient client, Connection connection, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
connection Connection
cancellationToken CancellationToken

Returns

Task

CloseConnectionAsync(IManagementClient, string, CancellationToken)

Closes the given connection

public static Task CloseConnectionAsync(this IManagementClient client, string connectionName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
connectionName string
cancellationToken CancellationToken

Returns

Task

CreateExchange(IManagementClient, ExchangeName, ExchangeInfo, CancellationToken)

public static void CreateExchange(this IManagementClient client, ExchangeName exchange, ExchangeInfo exchangeInfo, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
exchange ExchangeName
exchangeInfo ExchangeInfo
cancellationToken CancellationToken

CreateExchange(IManagementClient, Vhost, string, ExchangeInfo, CancellationToken)

public static void CreateExchange(this IManagementClient client, Vhost vhost, string exchangeName, ExchangeInfo exchangeInfo, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
exchangeName string
exchangeInfo ExchangeInfo
cancellationToken CancellationToken

CreateExchange(IManagementClient, string, string, ExchangeInfo, CancellationToken)

public static void CreateExchange(this IManagementClient client, string vhostName, string exchangeName, ExchangeInfo exchangeInfo, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
exchangeName string
exchangeInfo ExchangeInfo
cancellationToken CancellationToken

CreateExchangeAsync(IManagementClient, ExchangeName, ExchangeInfo, CancellationToken)

public static Task CreateExchangeAsync(this IManagementClient client, ExchangeName exchange, ExchangeInfo exchangeInfo, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
exchange ExchangeName
exchangeInfo ExchangeInfo
cancellationToken CancellationToken

Returns

Task

CreateExchangeAsync(IManagementClient, Vhost, string, ExchangeInfo, CancellationToken)

public static Task CreateExchangeAsync(this IManagementClient client, Vhost vhost, string exchangeName, ExchangeInfo exchangeInfo, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
exchangeName string
exchangeInfo ExchangeInfo
cancellationToken CancellationToken

Returns

Task

CreateExchangeAsync(IManagementClient, string, string, ExchangeInfo, CancellationToken)

Creates the given exchange

public static Task CreateExchangeAsync(this IManagementClient client, string vhostName, string exchangeName, ExchangeInfo exchangeInfo, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
exchangeName string
exchangeInfo ExchangeInfo
cancellationToken CancellationToken

Returns

Task

CreateExchangeBinding(IManagementClient, ExchangeName, ExchangeName, BindingInfo, CancellationToken)

public static void CreateExchangeBinding(this IManagementClient client, ExchangeName sourceExchange, ExchangeName destinationExchange, BindingInfo bindingInfo, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
sourceExchange ExchangeName
destinationExchange ExchangeName
bindingInfo BindingInfo
cancellationToken CancellationToken

CreateExchangeBinding(IManagementClient, Vhost, string, string, BindingInfo, CancellationToken)

public static void CreateExchangeBinding(this IManagementClient client, Vhost vhost, string sourceExchangeName, string destinationExchangeName, BindingInfo bindingInfo, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
sourceExchangeName string
destinationExchangeName string
bindingInfo BindingInfo
cancellationToken CancellationToken

CreateExchangeBinding(IManagementClient, string, string, string, BindingInfo, CancellationToken)

public static void CreateExchangeBinding(this IManagementClient client, string vhostName, string sourceExchangeName, string destinationExchangeName, BindingInfo bindingInfo, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
sourceExchangeName string
destinationExchangeName string
bindingInfo BindingInfo
cancellationToken CancellationToken

CreateExchangeBindingAsync(IManagementClient, ExchangeName, ExchangeName, BindingInfo, CancellationToken)

public static Task CreateExchangeBindingAsync(this IManagementClient client, ExchangeName sourceExchange, ExchangeName destinationExchange, BindingInfo bindingInfo, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
sourceExchange ExchangeName
destinationExchange ExchangeName
bindingInfo BindingInfo
cancellationToken CancellationToken

Returns

Task

CreateExchangeBindingAsync(IManagementClient, Vhost, string, string, BindingInfo, CancellationToken)

public static Task CreateExchangeBindingAsync(this IManagementClient client, Vhost vhost, string sourceExchangeName, string destinationExchangeName, BindingInfo bindingInfo, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
sourceExchangeName string
destinationExchangeName string
bindingInfo BindingInfo
cancellationToken CancellationToken

Returns

Task

CreateExchangeBindingAsync(IManagementClient, string, string, string, BindingInfo, CancellationToken)

Create a binding between an exchange and an exchange

public static Task CreateExchangeBindingAsync(this IManagementClient client, string vhostName, string sourceExchangeName, string destinationExchangeName, BindingInfo bindingInfo, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string: the vhost
sourceExchangeName string: the source exchange
destinationExchangeName string: the destination exchange
bindingInfo BindingInfo: properties of the binding
cancellationToken CancellationToken

Returns

Task

CreateFederationUpstream(IManagementClient, Vhost, string, ParameterFederationValue, CancellationToken)

public static void CreateFederationUpstream(this IManagementClient client, Vhost vhost, string federationUpstreamName, ParameterFederationValue federationUpstreamDescription, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
federationUpstreamName string
federationUpstreamDescription ParameterFederationValue
cancellationToken CancellationToken

CreateFederationUpstream(IManagementClient, string, string, ParameterFederationValue, CancellationToken)

public static void CreateFederationUpstream(this IManagementClient client, string vhostName, string federationUpstreamName, ParameterFederationValue federationUpstreamDescription, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
federationUpstreamName string
federationUpstreamDescription ParameterFederationValue
cancellationToken CancellationToken

CreateFederationUpstreamAsync(IManagementClient, Vhost, string, ParameterFederationValue, CancellationToken)

public static Task CreateFederationUpstreamAsync(this IManagementClient client, Vhost vhost, string federationUpstreamName, ParameterFederationValue federationUpstreamDescription, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
federationUpstreamName string
federationUpstreamDescription ParameterFederationValue
cancellationToken CancellationToken

Returns

Task

CreateFederationUpstreamAsync(IManagementClient, string, string, ParameterFederationValue, CancellationToken)

Creates a federation upstream in a specific vhost

public static Task CreateFederationUpstreamAsync(this IManagementClient client, string vhostName, string federationUpstreamName, ParameterFederationValue federationUpstreamDescription, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
federationUpstreamName string
federationUpstreamDescription ParameterFederationValue
cancellationToken CancellationToken

Returns

Task

CreateParameter(IManagementClient, Parameter, object, CancellationToken)

public static void CreateParameter(this IManagementClient client, Parameter parameter, object parameterValue, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
parameter Parameter
parameterValue object
cancellationToken CancellationToken

CreateParameter(IManagementClient, Parameter, CancellationToken)

public static void CreateParameter(this IManagementClient client, Parameter parameter, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
parameter Parameter
cancellationToken CancellationToken

CreateParameter(IManagementClient, string, Vhost, string, object, CancellationToken)

public static void CreateParameter(this IManagementClient client, string componentName, Vhost vhost, string parameterName, object parameterValue, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
componentName string
vhost Vhost
parameterName string
parameterValue object
cancellationToken CancellationToken

CreateParameter(IManagementClient, string, string, string, object, CancellationToken)

public static void CreateParameter(this IManagementClient client, string componentName, string vhostName, string parameterName, object parameterValue, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
componentName string
vhostName string
parameterName string
parameterValue object
cancellationToken CancellationToken

CreateParameterAsync(IManagementClient, Parameter, object, CancellationToken)

public static Task CreateParameterAsync(this IManagementClient client, Parameter parameter, object parameterValue, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
parameter Parameter
parameterValue object
cancellationToken CancellationToken

Returns

Task

CreateParameterAsync(IManagementClient, Parameter, CancellationToken)

public static Task CreateParameterAsync(this IManagementClient client, Parameter parameter, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
parameter Parameter
cancellationToken CancellationToken

Returns

Task

CreateParameterAsync(IManagementClient, string, Vhost, string, object, CancellationToken)

public static Task CreateParameterAsync(this IManagementClient client, string componentName, Vhost vhost, string parameterName, object parameterValue, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
componentName string
vhost Vhost
parameterName string
parameterValue object
cancellationToken CancellationToken

Returns

Task

CreateParameterAsync(IManagementClient, string, string, string, object, CancellationToken)

Creates a parameter on the cluster

public static Task CreateParameterAsync(this IManagementClient client, string componentName, string vhostName, string parameterName, object parameterValue, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
componentName string
vhostName string
parameterName string
parameterValue object
cancellationToken CancellationToken

Returns

Task

CreatePermission(IManagementClient, Vhost, User, PermissionInfo, CancellationToken)

public static void CreatePermission(this IManagementClient client, Vhost vhost, User user, PermissionInfo permissionInfo, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
user User
permissionInfo PermissionInfo
cancellationToken CancellationToken

CreatePermission(IManagementClient, Vhost, string, PermissionInfo, CancellationToken)

public static void CreatePermission(this IManagementClient client, Vhost vhost, string userName, PermissionInfo permissionInfo, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
userName string
permissionInfo PermissionInfo
cancellationToken CancellationToken

CreatePermission(IManagementClient, string, User, PermissionInfo, CancellationToken)

public static void CreatePermission(this IManagementClient client, string vhostName, User user, PermissionInfo permissionInfo, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
user User
permissionInfo PermissionInfo
cancellationToken CancellationToken

CreatePermission(IManagementClient, string, string, PermissionInfo, CancellationToken)

public static void CreatePermission(this IManagementClient client, string vhostName, string userName, PermissionInfo permissionInfo, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
userName string
permissionInfo PermissionInfo
cancellationToken CancellationToken

CreatePermissionAsync(IManagementClient, Vhost, User, PermissionInfo, CancellationToken)

public static Task CreatePermissionAsync(this IManagementClient client, Vhost vhost, User user, PermissionInfo permissionInfo, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
user User
permissionInfo PermissionInfo
cancellationToken CancellationToken

Returns

Task

CreatePermissionAsync(IManagementClient, Vhost, string, PermissionInfo, CancellationToken)

public static Task CreatePermissionAsync(this IManagementClient client, Vhost vhost, string userName, PermissionInfo permissionInfo, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
userName string
permissionInfo PermissionInfo
cancellationToken CancellationToken

Returns

Task

CreatePermissionAsync(IManagementClient, string, User, PermissionInfo, CancellationToken)

public static Task CreatePermissionAsync(this IManagementClient client, string vhostName, User user, PermissionInfo permissionInfo, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
user User
permissionInfo PermissionInfo
cancellationToken CancellationToken

Returns

Task

CreatePermissionAsync(IManagementClient, string, string, PermissionInfo, CancellationToken)

Create a permission

public static Task CreatePermissionAsync(this IManagementClient client, string vhostName, string userName, PermissionInfo permissionInfo, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
userName string
permissionInfo PermissionInfo
cancellationToken CancellationToken

Returns

Task

CreatePolicy(IManagementClient, Policy, CancellationToken)

public static void CreatePolicy(this IManagementClient client, Policy policy, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
policy Policy
cancellationToken CancellationToken

CreatePolicy(IManagementClient, Vhost, string, PolicyInfo, CancellationToken)

public static void CreatePolicy(this IManagementClient client, Vhost vhost, string policyName, PolicyInfo policyInfo, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
policyName string
policyInfo PolicyInfo
cancellationToken CancellationToken

CreatePolicy(IManagementClient, string, string, PolicyInfo, CancellationToken)

public static void CreatePolicy(this IManagementClient client, string vhostName, string policyName, PolicyInfo policyInfo, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
policyName string
policyInfo PolicyInfo
cancellationToken CancellationToken

CreatePolicyAsync(IManagementClient, Policy, CancellationToken)

Creates a policy on the cluster

public static Task CreatePolicyAsync(this IManagementClient client, Policy policy, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
policy Policy: Policy to create
cancellationToken CancellationToken

Returns

Task

CreatePolicyAsync(IManagementClient, Vhost, string, PolicyInfo, CancellationToken)

public static Task CreatePolicyAsync(this IManagementClient client, Vhost vhost, string policyName, PolicyInfo policyInfo, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
policyName string
policyInfo PolicyInfo
cancellationToken CancellationToken

Returns

Task

CreatePolicyAsync(IManagementClient, string, string, PolicyInfo, CancellationToken)

Creates a policy on the cluster

public static Task CreatePolicyAsync(this IManagementClient client, string vhostName, string policyName, PolicyInfo policyInfo, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
policyName string
policyInfo PolicyInfo
cancellationToken CancellationToken

Returns

Task

CreateQueue(IManagementClient, QueueName, QueueInfo, CancellationToken)

public static void CreateQueue(this IManagementClient client, QueueName queue, QueueInfo queueInfo, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
queue QueueName
queueInfo QueueInfo
cancellationToken CancellationToken

CreateQueue(IManagementClient, Vhost, string, QueueInfo, CancellationToken)

public static void CreateQueue(this IManagementClient client, Vhost vhost, string queueName, QueueInfo queueInfo, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
queueName string
queueInfo QueueInfo
cancellationToken CancellationToken

CreateQueue(IManagementClient, string, string, QueueInfo, CancellationToken)

public static void CreateQueue(this IManagementClient client, string vhostName, string queueName, QueueInfo queueInfo, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
queueName string
queueInfo QueueInfo
cancellationToken CancellationToken

CreateQueueAsync(IManagementClient, QueueName, QueueInfo, CancellationToken)

public static Task CreateQueueAsync(this IManagementClient client, QueueName queue, QueueInfo queueInfo, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
queue QueueName
queueInfo QueueInfo
cancellationToken CancellationToken

Returns

Task

CreateQueueAsync(IManagementClient, Vhost, string, QueueInfo, CancellationToken)

public static Task CreateQueueAsync(this IManagementClient client, Vhost vhost, string queueName, QueueInfo queueInfo, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
queueName string
queueInfo QueueInfo
cancellationToken CancellationToken

Returns

Task

CreateQueueAsync(IManagementClient, string, string, QueueInfo, CancellationToken)

Create the given queue

public static Task CreateQueueAsync(this IManagementClient client, string vhostName, string queueName, QueueInfo queueInfo, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
queueName string
queueInfo QueueInfo
cancellationToken CancellationToken

Returns

Task

CreateQueueBinding(IManagementClient, ExchangeName, QueueName, BindingInfo, CancellationToken)

public static void CreateQueueBinding(this IManagementClient client, ExchangeName exchange, QueueName queue, BindingInfo bindingInfo, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
exchange ExchangeName
queue QueueName
bindingInfo BindingInfo
cancellationToken CancellationToken

CreateQueueBinding(IManagementClient, ExchangeName, string, BindingInfo, CancellationToken)

public static void CreateQueueBinding(this IManagementClient client, ExchangeName exchange, string queueName, BindingInfo bindingInfo, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
exchange ExchangeName
queueName string
bindingInfo BindingInfo
cancellationToken CancellationToken

CreateQueueBinding(IManagementClient, Vhost, string, string, BindingInfo, CancellationToken)

public static void CreateQueueBinding(this IManagementClient client, Vhost vhost, string exchangeName, string queueName, BindingInfo bindingInfo, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
exchangeName string
queueName string
bindingInfo BindingInfo
cancellationToken CancellationToken

CreateQueueBinding(IManagementClient, string, QueueName, BindingInfo, CancellationToken)

public static void CreateQueueBinding(this IManagementClient client, string exchangeName, QueueName queue, BindingInfo bindingInfo, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
exchangeName string
queue QueueName
bindingInfo BindingInfo
cancellationToken CancellationToken

CreateQueueBinding(IManagementClient, string, string, string, BindingInfo, CancellationToken)

public static void CreateQueueBinding(this IManagementClient client, string vhostName, string exchangeName, string queueName, BindingInfo bindingInfo, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
exchangeName string
queueName string
bindingInfo BindingInfo
cancellationToken CancellationToken

CreateQueueBindingAsync(IManagementClient, ExchangeName, QueueName, BindingInfo, CancellationToken)

public static Task CreateQueueBindingAsync(this IManagementClient client, ExchangeName exchange, QueueName queue, BindingInfo bindingInfo, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
exchange ExchangeName
queue QueueName
bindingInfo BindingInfo
cancellationToken CancellationToken

Returns

Task

CreateQueueBindingAsync(IManagementClient, ExchangeName, string, BindingInfo, CancellationToken)

public static Task CreateQueueBindingAsync(this IManagementClient client, ExchangeName exchange, string queueName, BindingInfo bindingInfo, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
exchange ExchangeName
queueName string
bindingInfo BindingInfo
cancellationToken CancellationToken

Returns

Task

CreateQueueBindingAsync(IManagementClient, Vhost, string, string, BindingInfo, CancellationToken)

public static Task CreateQueueBindingAsync(this IManagementClient client, Vhost vhost, string exchangeName, string queueName, BindingInfo bindingInfo, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
exchangeName string
queueName string
bindingInfo BindingInfo
cancellationToken CancellationToken

Returns

Task

CreateQueueBindingAsync(IManagementClient, string, QueueName, BindingInfo, CancellationToken)

public static Task CreateQueueBindingAsync(this IManagementClient client, string exchangeName, QueueName queue, BindingInfo bindingInfo, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
exchangeName string
queue QueueName
bindingInfo BindingInfo
cancellationToken CancellationToken

Returns

Task

CreateQueueBindingAsync(IManagementClient, string, string, string, BindingInfo, CancellationToken)

Create a binding between an exchange and a queue

public static Task CreateQueueBindingAsync(this IManagementClient client, string vhostName, string exchangeName, string queueName, BindingInfo bindingInfo, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string: the vhost
exchangeName string: the exchange
queueName string: the queue
bindingInfo BindingInfo: properties of the binding
cancellationToken CancellationToken

Returns

Task: The binding that was created

CreateShovel(IManagementClient, Vhost, string, ParameterShovelValue, CancellationToken)

public static void CreateShovel(this IManagementClient client, Vhost vhost, string shovelName, ParameterShovelValue shovelDescription, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
shovelName string
shovelDescription ParameterShovelValue
cancellationToken CancellationToken

CreateShovel(IManagementClient, string, string, ParameterShovelValue, CancellationToken)

public static void CreateShovel(this IManagementClient client, string vhostName, string shovelName, ParameterShovelValue shovelDescription, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
shovelName string
shovelDescription ParameterShovelValue
cancellationToken CancellationToken

CreateShovelAsync(IManagementClient, Vhost, string, ParameterShovelValue, CancellationToken)

public static Task CreateShovelAsync(this IManagementClient client, Vhost vhost, string shovelName, ParameterShovelValue shovelDescription, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
shovelName string
shovelDescription ParameterShovelValue
cancellationToken CancellationToken

Returns

Task

CreateShovelAsync(IManagementClient, string, string, ParameterShovelValue, CancellationToken)

Creates a shovel in a specific vhost

public static Task CreateShovelAsync(this IManagementClient client, string vhostName, string shovelName, ParameterShovelValue shovelDescription, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
shovelName string
shovelDescription ParameterShovelValue
cancellationToken CancellationToken

Returns

Task

CreateTopicPermission(IManagementClient, Vhost, User, TopicPermissionInfo, CancellationToken)

public static void CreateTopicPermission(this IManagementClient client, Vhost vhost, User user, TopicPermissionInfo topicPermissionInfo, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
user User
topicPermissionInfo TopicPermissionInfo
cancellationToken CancellationToken

CreateTopicPermission(IManagementClient, Vhost, string, TopicPermissionInfo, CancellationToken)

public static void CreateTopicPermission(this IManagementClient client, Vhost vhost, string userName, TopicPermissionInfo topicPermissionInfo, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
userName string
topicPermissionInfo TopicPermissionInfo
cancellationToken CancellationToken

CreateTopicPermission(IManagementClient, string, User, TopicPermissionInfo, CancellationToken)

public static void CreateTopicPermission(this IManagementClient client, string vhostName, User user, TopicPermissionInfo topicPermissionInfo, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
user User
topicPermissionInfo TopicPermissionInfo
cancellationToken CancellationToken

CreateTopicPermission(IManagementClient, string, string, TopicPermissionInfo, CancellationToken)

public static void CreateTopicPermission(this IManagementClient client, string vhostName, string userName, TopicPermissionInfo topicPermissionInfo, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
userName string
topicPermissionInfo TopicPermissionInfo
cancellationToken CancellationToken

CreateTopicPermissionAsync(IManagementClient, Vhost, User, TopicPermissionInfo, CancellationToken)

public static Task CreateTopicPermissionAsync(this IManagementClient client, Vhost vhost, User user, TopicPermissionInfo topicPermissionInfo, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
user User
topicPermissionInfo TopicPermissionInfo
cancellationToken CancellationToken

Returns

Task

CreateTopicPermissionAsync(IManagementClient, Vhost, string, TopicPermissionInfo, CancellationToken)

public static Task CreateTopicPermissionAsync(this IManagementClient client, Vhost vhost, string userName, TopicPermissionInfo topicPermissionInfo, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
userName string
topicPermissionInfo TopicPermissionInfo
cancellationToken CancellationToken

Returns

Task

CreateTopicPermissionAsync(IManagementClient, string, User, TopicPermissionInfo, CancellationToken)

public static Task CreateTopicPermissionAsync(this IManagementClient client, string vhostName, User user, TopicPermissionInfo topicPermissionInfo, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
user User
topicPermissionInfo TopicPermissionInfo
cancellationToken CancellationToken

Returns

Task

CreateTopicPermissionAsync(IManagementClient, string, string, TopicPermissionInfo, CancellationToken)

Create a topic permission

public static Task CreateTopicPermissionAsync(this IManagementClient client, string vhostName, string userName, TopicPermissionInfo topicPermissionInfo, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
userName string
topicPermissionInfo TopicPermissionInfo
cancellationToken CancellationToken

Returns

Task

CreateUser(IManagementClient, User, UserInfo, CancellationToken)

public static void CreateUser(this IManagementClient client, User user, UserInfo userInfo, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
user User
userInfo UserInfo
cancellationToken CancellationToken

CreateUser(IManagementClient, string, UserInfo, CancellationToken)

public static void CreateUser(this IManagementClient client, string userName, UserInfo userInfo, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
userName string
userInfo UserInfo
cancellationToken CancellationToken

CreateUserAsync(IManagementClient, User, UserInfo, CancellationToken)

public static Task CreateUserAsync(this IManagementClient client, User user, UserInfo userInfo, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
user User
userInfo UserInfo
cancellationToken CancellationToken

Returns

Task

CreateUserAsync(IManagementClient, string, UserInfo, CancellationToken)

Create a new user

public static Task CreateUserAsync(this IManagementClient client, string userName, UserInfo userInfo, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
userName string: The user name to create
userInfo UserInfo: The user info to create
cancellationToken CancellationToken

Returns

Task

CreateVhost(IManagementClient, Vhost, CancellationToken)

public static void CreateVhost(this IManagementClient client, Vhost vhost, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
cancellationToken CancellationToken

CreateVhost(IManagementClient, string, CancellationToken)

public static void CreateVhost(this IManagementClient client, string vhostName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
cancellationToken CancellationToken

CreateVhostAsync(IManagementClient, Vhost, CancellationToken)

public static Task CreateVhostAsync(this IManagementClient client, Vhost vhost, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
cancellationToken CancellationToken

Returns

Task

CreateVhostAsync(IManagementClient, string, CancellationToken)

Create a new virtual host

public static Task CreateVhostAsync(this IManagementClient client, string vhostName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string: The name of the new virtual host
cancellationToken CancellationToken

Returns

Task

Delete(IManagementClient, RelativePath, IEnumerable<KeyValuePair<string, string>>?, CancellationToken)

public static void Delete(this IManagementClient client, RelativePath path, IEnumerable<KeyValuePair<string, string>>? queryParameters, CancellationToken cancellationToken = default)

Parameters

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

Delete(IManagementClient, RelativePath, CancellationToken)

public static void Delete(this IManagementClient client, RelativePath path, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
path RelativePath
cancellationToken CancellationToken

DeleteAsync(IManagementClient, RelativePath, CancellationToken)

public static Task DeleteAsync(this IManagementClient client, RelativePath path, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
path RelativePath
cancellationToken CancellationToken

Returns

Task

DeleteBinding(IManagementClient, Binding, CancellationToken)

public static void DeleteBinding(this IManagementClient client, Binding binding, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
binding Binding
cancellationToken CancellationToken

DeleteBindingAsync(IManagementClient, Binding, CancellationToken)

Delete the given binding

public static Task DeleteBindingAsync(this IManagementClient client, Binding binding, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
binding Binding
cancellationToken CancellationToken

Returns

Task

DeleteExchange(IManagementClient, ExchangeName, DeleteExchangeCriteria?, CancellationToken)

public static void DeleteExchange(this IManagementClient client, ExchangeName exchange, DeleteExchangeCriteria? deleteExchangeCriteria = null, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
exchange ExchangeName
deleteExchangeCriteria DeleteExchangeCriteria
cancellationToken CancellationToken

DeleteExchange(IManagementClient, Vhost, string, DeleteExchangeCriteria?, CancellationToken)

public static void DeleteExchange(this IManagementClient client, Vhost vhost, string exchangeName, DeleteExchangeCriteria? deleteExchangeCriteria = null, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
exchangeName string
deleteExchangeCriteria DeleteExchangeCriteria
cancellationToken CancellationToken

DeleteExchange(IManagementClient, string, string, DeleteExchangeCriteria?, CancellationToken)

public static void DeleteExchange(this IManagementClient client, string vhostName, string exchangeName, DeleteExchangeCriteria? deleteExchangeCriteria = null, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
exchangeName string
deleteExchangeCriteria DeleteExchangeCriteria
cancellationToken CancellationToken

DeleteExchangeAsync(IManagementClient, ExchangeName, DeleteExchangeCriteria?, CancellationToken)

public static Task DeleteExchangeAsync(this IManagementClient client, ExchangeName exchange, DeleteExchangeCriteria? deleteExchangeCriteria = null, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
exchange ExchangeName
deleteExchangeCriteria DeleteExchangeCriteria
cancellationToken CancellationToken

Returns

Task

DeleteExchangeAsync(IManagementClient, Vhost, string, DeleteExchangeCriteria?, CancellationToken)

public static Task DeleteExchangeAsync(this IManagementClient client, Vhost vhost, string exchangeName, DeleteExchangeCriteria? deleteExchangeCriteria = null, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
exchangeName string
deleteExchangeCriteria DeleteExchangeCriteria
cancellationToken CancellationToken

Returns

Task

DeleteExchangeAsync(IManagementClient, string, string, DeleteExchangeCriteria?, CancellationToken)

Delete the given exchange

public static Task DeleteExchangeAsync(this IManagementClient client, string vhostName, string exchangeName, DeleteExchangeCriteria? deleteExchangeCriteria = null, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
exchangeName string
deleteExchangeCriteria DeleteExchangeCriteria
cancellationToken CancellationToken

Returns

Task

DeleteExchangeBinding(IManagementClient, ExchangeName, ExchangeName, string, CancellationToken)

public static void DeleteExchangeBinding(this IManagementClient client, ExchangeName sourceExchange, ExchangeName destinationExchange, string propertiesKey, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
sourceExchange ExchangeName
destinationExchange ExchangeName
propertiesKey string
cancellationToken CancellationToken

DeleteExchangeBinding(IManagementClient, Vhost, string, string, string, CancellationToken)

public static void DeleteExchangeBinding(this IManagementClient client, Vhost vhost, string sourceExchangeName, string destinationExchangeName, string propertiesKey, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
sourceExchangeName string
destinationExchangeName string
propertiesKey string
cancellationToken CancellationToken

DeleteExchangeBinding(IManagementClient, string, string, string, string, CancellationToken)

public static void DeleteExchangeBinding(this IManagementClient client, string vhostName, string sourceExchangeName, string destinationExchangeName, string propertiesKey, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
sourceExchangeName string
destinationExchangeName string
propertiesKey string
cancellationToken CancellationToken

DeleteExchangeBindingAsync(IManagementClient, ExchangeName, ExchangeName, string, CancellationToken)

public static Task DeleteExchangeBindingAsync(this IManagementClient client, ExchangeName sourceExchange, ExchangeName destinationExchange, string propertiesKey, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
sourceExchange ExchangeName
destinationExchange ExchangeName
propertiesKey string
cancellationToken CancellationToken

Returns

Task

DeleteExchangeBindingAsync(IManagementClient, Vhost, string, string, string, CancellationToken)

public static Task DeleteExchangeBindingAsync(this IManagementClient client, Vhost vhost, string sourceExchangeName, string destinationExchangeName, string propertiesKey, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
sourceExchangeName string
destinationExchangeName string
propertiesKey string
cancellationToken CancellationToken

Returns

Task

DeleteExchangeBindingAsync(IManagementClient, string, string, string, string, CancellationToken)

Delete the given binding

public static Task DeleteExchangeBindingAsync(this IManagementClient client, string vhostName, string sourceExchangeName, string destinationExchangeName, string propertiesKey, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
sourceExchangeName string
destinationExchangeName string
propertiesKey string
cancellationToken CancellationToken

Returns

Task

DeleteParameter(IManagementClient, Parameter, CancellationToken)

public static void DeleteParameter(this IManagementClient client, Parameter parameter, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
parameter Parameter
cancellationToken CancellationToken

DeleteParameter(IManagementClient, string, Vhost, string, CancellationToken)

public static void DeleteParameter(this IManagementClient client, string componentName, Vhost vhost, string parameterName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
componentName string
vhost Vhost
parameterName string
cancellationToken CancellationToken

DeleteParameter(IManagementClient, string, string, string, CancellationToken)

public static void DeleteParameter(this IManagementClient client, string componentName, string vhostName, string parameterName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
componentName string
vhostName string
parameterName string
cancellationToken CancellationToken

DeleteParameterAsync(IManagementClient, Parameter, CancellationToken)

public static Task DeleteParameterAsync(this IManagementClient client, Parameter parameter, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
parameter Parameter
cancellationToken CancellationToken

Returns

Task

DeleteParameterAsync(IManagementClient, string, Vhost, string, CancellationToken)

public static Task DeleteParameterAsync(this IManagementClient client, string componentName, Vhost vhost, string parameterName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
componentName string
vhost Vhost
parameterName string
cancellationToken CancellationToken

Returns

Task

DeleteParameterAsync(IManagementClient, string, string, string, CancellationToken)

Delete a parameter from the cluster

public static Task DeleteParameterAsync(this IManagementClient client, string componentName, string vhostName, string parameterName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
componentName string
vhostName string
parameterName string
cancellationToken CancellationToken

Returns

Task

DeletePermission(IManagementClient, Permission, CancellationToken)

public static void DeletePermission(this IManagementClient client, Permission permission, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
permission Permission
cancellationToken CancellationToken

DeletePermission(IManagementClient, Vhost, User, CancellationToken)

public static void DeletePermission(this IManagementClient client, Vhost vhost, User user, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
user User
cancellationToken CancellationToken

DeletePermission(IManagementClient, Vhost, string, CancellationToken)

public static void DeletePermission(this IManagementClient client, Vhost vhost, string userName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
userName string
cancellationToken CancellationToken

DeletePermission(IManagementClient, string, User, CancellationToken)

public static void DeletePermission(this IManagementClient client, string vhostName, User user, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
user User
cancellationToken CancellationToken

DeletePermission(IManagementClient, string, string, CancellationToken)

public static void DeletePermission(this IManagementClient client, string vhostName, string userName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
userName string
cancellationToken CancellationToken

DeletePermissionAsync(IManagementClient, Permission, CancellationToken)

Delete a permission

public static Task DeletePermissionAsync(this IManagementClient client, Permission permission, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
permission Permission
cancellationToken CancellationToken

Returns

Task

DeletePermissionAsync(IManagementClient, Vhost, User, CancellationToken)

public static Task DeletePermissionAsync(this IManagementClient client, Vhost vhost, User user, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
user User
cancellationToken CancellationToken

Returns

Task

DeletePermissionAsync(IManagementClient, Vhost, string, CancellationToken)

public static Task DeletePermissionAsync(this IManagementClient client, Vhost vhost, string userName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
userName string
cancellationToken CancellationToken

Returns

Task

DeletePermissionAsync(IManagementClient, string, User, CancellationToken)

public static Task DeletePermissionAsync(this IManagementClient client, string vhostName, User user, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
user User
cancellationToken CancellationToken

Returns

Task

DeletePermissionAsync(IManagementClient, string, string, CancellationToken)

Delete a permission

public static Task DeletePermissionAsync(this IManagementClient client, string vhostName, string userName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
userName string
cancellationToken CancellationToken

Returns

Task

DeletePolicy(IManagementClient, Vhost, string, CancellationToken)

public static void DeletePolicy(this IManagementClient client, Vhost vhost, string policyName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
policyName string
cancellationToken CancellationToken

DeletePolicy(IManagementClient, string, string, CancellationToken)

public static void DeletePolicy(this IManagementClient client, string vhostName, string policyName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
policyName string
cancellationToken CancellationToken

DeletePolicyAsync(IManagementClient, Vhost, string, CancellationToken)

public static Task DeletePolicyAsync(this IManagementClient client, Vhost vhost, string policyName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
policyName string
cancellationToken CancellationToken

Returns

Task

DeletePolicyAsync(IManagementClient, string, string, CancellationToken)

Delete a policy from the cluster

public static Task DeletePolicyAsync(this IManagementClient client, string vhostName, string policyName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string: vhost on which the policy resides
policyName string: Policy name
cancellationToken CancellationToken

Returns

Task

DeleteQueue(IManagementClient, QueueName, DeleteQueueCriteria?, CancellationToken)

public static void DeleteQueue(this IManagementClient client, QueueName queue, DeleteQueueCriteria? deleteQueueCriteria = null, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
queue QueueName
deleteQueueCriteria DeleteQueueCriteria
cancellationToken CancellationToken

DeleteQueue(IManagementClient, Vhost, string, DeleteQueueCriteria?, CancellationToken)

public static void DeleteQueue(this IManagementClient client, Vhost vhost, string queueName, DeleteQueueCriteria? deleteQueueCriteria = null, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
queueName string
deleteQueueCriteria DeleteQueueCriteria
cancellationToken CancellationToken

DeleteQueue(IManagementClient, string, string, DeleteQueueCriteria?, CancellationToken)

public static void DeleteQueue(this IManagementClient client, string vhostName, string queueName, DeleteQueueCriteria? deleteQueueCriteria = null, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
queueName string
deleteQueueCriteria DeleteQueueCriteria
cancellationToken CancellationToken

DeleteQueueAsync(IManagementClient, QueueName, DeleteQueueCriteria?, CancellationToken)

public static Task DeleteQueueAsync(this IManagementClient client, QueueName queue, DeleteQueueCriteria? deleteQueueCriteria = null, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
queue QueueName
deleteQueueCriteria DeleteQueueCriteria
cancellationToken CancellationToken

Returns

Task

DeleteQueueAsync(IManagementClient, Vhost, string, DeleteQueueCriteria?, CancellationToken)

public static Task DeleteQueueAsync(this IManagementClient client, Vhost vhost, string queueName, DeleteQueueCriteria? deleteQueueCriteria = null, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
queueName string
deleteQueueCriteria DeleteQueueCriteria
cancellationToken CancellationToken

Returns

Task

DeleteQueueAsync(IManagementClient, string, string, DeleteQueueCriteria?, CancellationToken)

Delete the given queue

public static Task DeleteQueueAsync(this IManagementClient client, string vhostName, string queueName, DeleteQueueCriteria? deleteQueueCriteria = null, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
queueName string
deleteQueueCriteria DeleteQueueCriteria
cancellationToken CancellationToken

Returns

Task

DeleteQueueBinding(IManagementClient, ExchangeName, QueueName, string, CancellationToken)

public static void DeleteQueueBinding(this IManagementClient client, ExchangeName exchange, QueueName queue, string propertiesKey, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
exchange ExchangeName
queue QueueName
propertiesKey string
cancellationToken CancellationToken

DeleteQueueBinding(IManagementClient, ExchangeName, string, string, CancellationToken)

public static void DeleteQueueBinding(this IManagementClient client, ExchangeName exchange, string queueName, string propertiesKey, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
exchange ExchangeName
queueName string
propertiesKey string
cancellationToken CancellationToken

DeleteQueueBinding(IManagementClient, Vhost, string, string, string, CancellationToken)

public static void DeleteQueueBinding(this IManagementClient client, Vhost vhost, string exchangeName, string queueName, string propertiesKey, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
exchangeName string
queueName string
propertiesKey string
cancellationToken CancellationToken

DeleteQueueBinding(IManagementClient, string, QueueName, string, CancellationToken)

public static void DeleteQueueBinding(this IManagementClient client, string exchangeName, QueueName queue, string propertiesKey, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
exchangeName string
queue QueueName
propertiesKey string
cancellationToken CancellationToken

DeleteQueueBinding(IManagementClient, string, string, string, string, CancellationToken)

public static void DeleteQueueBinding(this IManagementClient client, string vhostName, string exchangeName, string queueName, string propertiesKey, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
exchangeName string
queueName string
propertiesKey string
cancellationToken CancellationToken

DeleteQueueBindingAsync(IManagementClient, ExchangeName, QueueName, string, CancellationToken)

public static Task DeleteQueueBindingAsync(this IManagementClient client, ExchangeName exchange, QueueName queue, string propertiesKey, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
exchange ExchangeName
queue QueueName
propertiesKey string
cancellationToken CancellationToken

Returns

Task

DeleteQueueBindingAsync(IManagementClient, ExchangeName, string, string, CancellationToken)

public static Task DeleteQueueBindingAsync(this IManagementClient client, ExchangeName exchange, string queueName, string propertiesKey, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
exchange ExchangeName
queueName string
propertiesKey string
cancellationToken CancellationToken

Returns

Task

DeleteQueueBindingAsync(IManagementClient, Vhost, string, string, string, CancellationToken)

public static Task DeleteQueueBindingAsync(this IManagementClient client, Vhost vhost, string exchangeName, string queueName, string propertiesKey, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
exchangeName string
queueName string
propertiesKey string
cancellationToken CancellationToken

Returns

Task

DeleteQueueBindingAsync(IManagementClient, string, QueueName, string, CancellationToken)

public static Task DeleteQueueBindingAsync(this IManagementClient client, string exchangeName, QueueName queue, string propertiesKey, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
exchangeName string
queue QueueName
propertiesKey string
cancellationToken CancellationToken

Returns

Task

DeleteQueueBindingAsync(IManagementClient, string, string, string, string, CancellationToken)

Delete the given binding

public static Task DeleteQueueBindingAsync(this IManagementClient client, string vhostName, string exchangeName, string queueName, string propertiesKey, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
exchangeName string
queueName string
propertiesKey string
cancellationToken CancellationToken

Returns

Task

DeleteTopicPermission(IManagementClient, TopicPermission, CancellationToken)

public static void DeleteTopicPermission(this IManagementClient client, TopicPermission topicPermission, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
topicPermission TopicPermission
cancellationToken CancellationToken

DeleteTopicPermission(IManagementClient, Vhost, User, CancellationToken)

public static void DeleteTopicPermission(this IManagementClient client, Vhost vhost, User user, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
user User
cancellationToken CancellationToken

DeleteTopicPermission(IManagementClient, Vhost, string, CancellationToken)

public static void DeleteTopicPermission(this IManagementClient client, Vhost vhost, string userName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
userName string
cancellationToken CancellationToken

DeleteTopicPermission(IManagementClient, string, User, CancellationToken)

public static void DeleteTopicPermission(this IManagementClient client, string vhostName, User user, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
user User
cancellationToken CancellationToken

DeleteTopicPermission(IManagementClient, string, string, CancellationToken)

public static void DeleteTopicPermission(this IManagementClient client, string vhostName, string userName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
userName string
cancellationToken CancellationToken

DeleteTopicPermissionAsync(IManagementClient, TopicPermission, CancellationToken)

Delete a topic permission

public static Task DeleteTopicPermissionAsync(this IManagementClient client, TopicPermission topicPermission, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
topicPermission TopicPermission
cancellationToken CancellationToken

Returns

Task

DeleteTopicPermissionAsync(IManagementClient, Vhost, User, CancellationToken)

public static Task DeleteTopicPermissionAsync(this IManagementClient client, Vhost vhost, User user, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
user User
cancellationToken CancellationToken

Returns

Task

DeleteTopicPermissionAsync(IManagementClient, Vhost, string, CancellationToken)

public static Task DeleteTopicPermissionAsync(this IManagementClient client, Vhost vhost, string userName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
userName string
cancellationToken CancellationToken

Returns

Task

DeleteTopicPermissionAsync(IManagementClient, string, User, CancellationToken)

public static Task DeleteTopicPermissionAsync(this IManagementClient client, string vhostName, User user, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
user User
cancellationToken CancellationToken

Returns

Task

DeleteTopicPermissionAsync(IManagementClient, string, string, CancellationToken)

Delete a topic permission

public static Task DeleteTopicPermissionAsync(this IManagementClient client, string vhostName, string userName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
userName string
cancellationToken CancellationToken

Returns

Task

DeleteUser(IManagementClient, User, CancellationToken)

public static void DeleteUser(this IManagementClient client, User user, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
user User
cancellationToken CancellationToken

DeleteUser(IManagementClient, string, CancellationToken)

public static void DeleteUser(this IManagementClient client, string userName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
userName string
cancellationToken CancellationToken

DeleteUserAsync(IManagementClient, User, CancellationToken)

public static Task DeleteUserAsync(this IManagementClient client, User user, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
user User
cancellationToken CancellationToken

Returns

Task

DeleteUserAsync(IManagementClient, string, CancellationToken)

Delete a user

public static Task DeleteUserAsync(this IManagementClient client, string userName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
userName string: The user to delete
cancellationToken CancellationToken

Returns

Task

DeleteVhost(IManagementClient, Vhost, CancellationToken)

public static void DeleteVhost(this IManagementClient client, Vhost vhost, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
cancellationToken CancellationToken

DeleteVhost(IManagementClient, string, CancellationToken)

public static void DeleteVhost(this IManagementClient client, string vhostName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
cancellationToken CancellationToken

DeleteVhostAsync(IManagementClient, Vhost, CancellationToken)

public static Task DeleteVhostAsync(this IManagementClient client, Vhost vhost, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
cancellationToken CancellationToken

Returns

Task

DeleteVhostAsync(IManagementClient, string, CancellationToken)

Delete a virtual host

public static Task DeleteVhostAsync(this IManagementClient client, string vhostName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string: The virtual host to delete
cancellationToken CancellationToken

Returns

Task

DisableTracing(IManagementClient, Vhost, CancellationToken)

public static void DisableTracing(this IManagementClient client, Vhost vhost, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
cancellationToken CancellationToken

DisableTracing(IManagementClient, string, CancellationToken)

public static void DisableTracing(this IManagementClient client, string vhostName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
cancellationToken CancellationToken

DisableTracingAsync(IManagementClient, Vhost, CancellationToken)

public static Task DisableTracingAsync(this IManagementClient client, Vhost vhost, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
cancellationToken CancellationToken

Returns

Task

DisableTracingAsync(IManagementClient, string, CancellationToken)

Disables tracing on given virtual host.

public static Task DisableTracingAsync(this IManagementClient client, string vhostName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string: The virtual host on which to disable tracing
cancellationToken CancellationToken

Returns

Task

EnableTracing(IManagementClient, Vhost, CancellationToken)

public static void EnableTracing(this IManagementClient client, Vhost vhost, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
cancellationToken CancellationToken

EnableTracing(IManagementClient, string, CancellationToken)

public static void EnableTracing(this IManagementClient client, string vhostName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
cancellationToken CancellationToken

EnableTracingAsync(IManagementClient, Vhost, CancellationToken)

public static Task EnableTracingAsync(this IManagementClient client, Vhost vhost, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
cancellationToken CancellationToken

Returns

Task

EnableTracingAsync(IManagementClient, string, CancellationToken)

Enable tracing on given virtual host.

public static Task EnableTracingAsync(this IManagementClient client, string vhostName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string: The virtual host on which to enable tracing
cancellationToken CancellationToken

Returns

Task

GetAsync<TResult>(IManagementClient, RelativePath, CancellationToken)

public static Task<TResult> GetAsync<TResult>(this IManagementClient client, RelativePath path, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
path RelativePath
cancellationToken CancellationToken

Returns

Task<TResult>

Type Parameters

TResult

GetBindings(IManagementClient, Vhost, CancellationToken)

public static IReadOnlyList<Binding> GetBindings(this IManagementClient client, Vhost vhost, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
cancellationToken CancellationToken

Returns

IReadOnlyList<Binding>

GetBindings(IManagementClient, string, CancellationToken)

public static IReadOnlyList<Binding> GetBindings(this IManagementClient client, string vhostName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
cancellationToken CancellationToken

Returns

IReadOnlyList<Binding>

GetBindings(IManagementClient, CancellationToken)

public static IReadOnlyList<Binding> GetBindings(this IManagementClient client, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
cancellationToken CancellationToken

Returns

IReadOnlyList<Binding>

GetBindingsAsync(IManagementClient, Vhost, CancellationToken)

public static Task<IReadOnlyList<Binding>> GetBindingsAsync(this IManagementClient client, Vhost vhost, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
cancellationToken CancellationToken

Returns

Task<IReadOnlyList<Binding>>

GetBindingsAsync(IManagementClient, string, CancellationToken)

A list of all bindings within the specified VHost.

public static Task<IReadOnlyList<Binding>> GetBindingsAsync(this IManagementClient client, string vhostName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
cancellationToken CancellationToken

Returns

Task<IReadOnlyList<Binding>>

GetBindingsAsync(IManagementClient, CancellationToken)

A list of all bindings.

public static Task<IReadOnlyList<Binding>> GetBindingsAsync(this IManagementClient client, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
cancellationToken CancellationToken

Returns

Task<IReadOnlyList<Binding>>

GetBindingsForQueue(IManagementClient, QueueName, CancellationToken)

public static IReadOnlyList<Binding> GetBindingsForQueue(this IManagementClient client, QueueName queue, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
queue QueueName
cancellationToken CancellationToken

Returns

IReadOnlyList<Binding>

GetBindingsForQueue(IManagementClient, Vhost, string, CancellationToken)

public static IReadOnlyList<Binding> GetBindingsForQueue(this IManagementClient client, Vhost vhost, string queueName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
queueName string
cancellationToken CancellationToken

Returns

IReadOnlyList<Binding>

GetBindingsForQueue(IManagementClient, string, string, CancellationToken)

public static IReadOnlyList<Binding> GetBindingsForQueue(this IManagementClient client, string vhostName, string queueName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
queueName string
cancellationToken CancellationToken

Returns

IReadOnlyList<Binding>

GetBindingsForQueueAsync(IManagementClient, QueueName, CancellationToken)

public static Task<IReadOnlyList<Binding>> GetBindingsForQueueAsync(this IManagementClient client, QueueName queue, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
queue QueueName
cancellationToken CancellationToken

Returns

Task<IReadOnlyList<Binding>>

GetBindingsForQueueAsync(IManagementClient, Vhost, string, CancellationToken)

public static Task<IReadOnlyList<Binding>> GetBindingsForQueueAsync(this IManagementClient client, Vhost vhost, string queueName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
queueName string
cancellationToken CancellationToken

Returns

Task<IReadOnlyList<Binding>>

GetBindingsForQueueAsync(IManagementClient, string, string, CancellationToken)

A list of all bindings on a given queue.

public static Task<IReadOnlyList<Binding>> GetBindingsForQueueAsync(this IManagementClient client, string vhostName, string queueName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
queueName string
cancellationToken CancellationToken

Returns

Task<IReadOnlyList<Binding>>

GetBindingsWithDestination(IManagementClient, ExchangeName, CancellationToken)

public static IReadOnlyList<Binding> GetBindingsWithDestination(this IManagementClient client, ExchangeName exchange, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
exchange ExchangeName
cancellationToken CancellationToken

Returns

IReadOnlyList<Binding>

GetBindingsWithDestination(IManagementClient, Vhost, string, CancellationToken)

public static IReadOnlyList<Binding> GetBindingsWithDestination(this IManagementClient client, Vhost vhost, string exchangeName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
exchangeName string
cancellationToken CancellationToken

Returns

IReadOnlyList<Binding>

GetBindingsWithDestination(IManagementClient, string, string, CancellationToken)

public static IReadOnlyList<Binding> GetBindingsWithDestination(this IManagementClient client, string vhostName, string exchangeName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
exchangeName string
cancellationToken CancellationToken

Returns

IReadOnlyList<Binding>

GetBindingsWithDestinationAsync(IManagementClient, ExchangeName, CancellationToken)

public static Task<IReadOnlyList<Binding>> GetBindingsWithDestinationAsync(this IManagementClient client, ExchangeName exchange, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
exchange ExchangeName
cancellationToken CancellationToken

Returns

Task<IReadOnlyList<Binding>>

GetBindingsWithDestinationAsync(IManagementClient, Vhost, string, CancellationToken)

public static Task<IReadOnlyList<Binding>> GetBindingsWithDestinationAsync(this IManagementClient client, Vhost vhost, string exchangeName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
exchangeName string
cancellationToken CancellationToken

Returns

Task<IReadOnlyList<Binding>>

GetBindingsWithDestinationAsync(IManagementClient, string, string, CancellationToken)

A list of all bindings in which a given exchange is the destination.

public static Task<IReadOnlyList<Binding>> GetBindingsWithDestinationAsync(this IManagementClient client, string vhostName, string exchangeName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
exchangeName string
cancellationToken CancellationToken

Returns

Task<IReadOnlyList<Binding>>

GetBindingsWithSource(IManagementClient, ExchangeName, CancellationToken)

public static IReadOnlyList<Binding> GetBindingsWithSource(this IManagementClient client, ExchangeName exchange, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
exchange ExchangeName
cancellationToken CancellationToken

Returns

IReadOnlyList<Binding>

GetBindingsWithSource(IManagementClient, Vhost, string, CancellationToken)

public static IReadOnlyList<Binding> GetBindingsWithSource(this IManagementClient client, Vhost vhost, string exchangeName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
exchangeName string
cancellationToken CancellationToken

Returns

IReadOnlyList<Binding>

GetBindingsWithSource(IManagementClient, string, string, CancellationToken)

public static IReadOnlyList<Binding> GetBindingsWithSource(this IManagementClient client, string vhostName, string exchangeName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
exchangeName string
cancellationToken CancellationToken

Returns

IReadOnlyList<Binding>

GetBindingsWithSourceAsync(IManagementClient, ExchangeName, CancellationToken)

public static Task<IReadOnlyList<Binding>> GetBindingsWithSourceAsync(this IManagementClient client, ExchangeName exchange, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
exchange ExchangeName
cancellationToken CancellationToken

Returns

Task<IReadOnlyList<Binding>>

GetBindingsWithSourceAsync(IManagementClient, Vhost, string, CancellationToken)

public static Task<IReadOnlyList<Binding>> GetBindingsWithSourceAsync(this IManagementClient client, Vhost vhost, string exchangeName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
exchangeName string
cancellationToken CancellationToken

Returns

Task<IReadOnlyList<Binding>>

GetBindingsWithSourceAsync(IManagementClient, string, string, CancellationToken)

A list of all bindings in which a given exchange is the source.

public static Task<IReadOnlyList<Binding>> GetBindingsWithSourceAsync(this IManagementClient client, string vhostName, string exchangeName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
exchangeName string
cancellationToken CancellationToken

Returns

Task<IReadOnlyList<Binding>>

GetChannel(IManagementClient, string, RatesCriteria?, CancellationToken)

public static Channel GetChannel(this IManagementClient client, string channelName, RatesCriteria? ratesCriteria = null, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
channelName string
ratesCriteria RatesCriteria
cancellationToken CancellationToken

Returns

Channel

GetChannelAsync(IManagementClient, string, RatesCriteria?, CancellationToken)

Gets the channel. This returns more detail, including consumers than the GetChannels method.

public static Task<Channel> GetChannelAsync(this IManagementClient client, string channelName, RatesCriteria? ratesCriteria = null, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
channelName string: Channel name.
ratesCriteria RatesCriteria: Criteria for getting samples of rate data
cancellationToken CancellationToken

Returns

Task<Channel>: The channel.

GetChannels(IManagementClient, Connection, CancellationToken)

public static IReadOnlyList<Channel> GetChannels(this IManagementClient client, Connection connection, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
connection Connection
cancellationToken CancellationToken

Returns

IReadOnlyList<Channel>

GetChannels(IManagementClient, string, CancellationToken)

public static IReadOnlyList<Channel> GetChannels(this IManagementClient client, string connectionName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
connectionName string
cancellationToken CancellationToken

Returns

IReadOnlyList<Channel>

GetChannels(IManagementClient, CancellationToken)

public static IReadOnlyList<Channel> GetChannels(this IManagementClient client, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
cancellationToken CancellationToken

Returns

IReadOnlyList<Channel>

GetChannelsAsync(IManagementClient, Connection, CancellationToken)

public static Task<IReadOnlyList<Channel>> GetChannelsAsync(this IManagementClient client, Connection connection, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
connection Connection
cancellationToken CancellationToken

Returns

Task<IReadOnlyList<Channel>>

GetChannelsAsync(IManagementClient, string, CancellationToken)

A list of all open channels for the given connection.

public static Task<IReadOnlyList<Channel>> GetChannelsAsync(this IManagementClient client, string connectionName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
connectionName string
cancellationToken CancellationToken

Returns

Task<IReadOnlyList<Channel>>

GetChannelsAsync(IManagementClient, CancellationToken)

A list of all open channels.

public static Task<IReadOnlyList<Channel>> GetChannelsAsync(this IManagementClient client, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
cancellationToken CancellationToken

Returns

Task<IReadOnlyList<Channel>>

GetConnections(IManagementClient, Vhost, CancellationToken)

public static IReadOnlyList<Connection> GetConnections(this IManagementClient client, Vhost vhost, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
cancellationToken CancellationToken

Returns

IReadOnlyList<Connection>

GetConnections(IManagementClient, string, CancellationToken)

public static IReadOnlyList<Connection> GetConnections(this IManagementClient client, string vhostName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
cancellationToken CancellationToken

Returns

IReadOnlyList<Connection>

GetConnections(IManagementClient, CancellationToken)

public static IReadOnlyList<Connection> GetConnections(this IManagementClient client, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
cancellationToken CancellationToken

Returns

IReadOnlyList<Connection>

GetConnectionsAsync(IManagementClient, Vhost, CancellationToken)

public static Task<IReadOnlyList<Connection>> GetConnectionsAsync(this IManagementClient client, Vhost vhost, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
cancellationToken CancellationToken

Returns

Task<IReadOnlyList<Connection>>

GetConnectionsAsync(IManagementClient, string, CancellationToken)

A list of all open connections on the specified VHost.

public static Task<IReadOnlyList<Connection>> GetConnectionsAsync(this IManagementClient client, string vhostName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
cancellationToken CancellationToken

Returns

Task<IReadOnlyList<Connection>>

GetConnectionsAsync(IManagementClient, CancellationToken)

A list of all open connections.

public static Task<IReadOnlyList<Connection>> GetConnectionsAsync(this IManagementClient client, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
cancellationToken CancellationToken

Returns

Task<IReadOnlyList<Connection>>

GetConsumers(IManagementClient, Vhost, CancellationToken)

public static IReadOnlyList<Consumer> GetConsumers(this IManagementClient client, Vhost vhost, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
cancellationToken CancellationToken

Returns

IReadOnlyList<Consumer>

GetConsumers(IManagementClient, string, CancellationToken)

public static IReadOnlyList<Consumer> GetConsumers(this IManagementClient client, string vhostName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
cancellationToken CancellationToken

Returns

IReadOnlyList<Consumer>

GetConsumers(IManagementClient, CancellationToken)

public static IReadOnlyList<Consumer> GetConsumers(this IManagementClient client, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
cancellationToken CancellationToken

Returns

IReadOnlyList<Consumer>

GetConsumersAsync(IManagementClient, Vhost, CancellationToken)

public static Task<IReadOnlyList<Consumer>> GetConsumersAsync(this IManagementClient client, Vhost vhost, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
cancellationToken CancellationToken

Returns

Task<IReadOnlyList<Consumer>>

GetConsumersAsync(IManagementClient, string, CancellationToken)

A list of all consumers for the specified VHost.

public static Task<IReadOnlyList<Consumer>> GetConsumersAsync(this IManagementClient client, string vhostName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
cancellationToken CancellationToken

Returns

Task<IReadOnlyList<Consumer>>

GetConsumersAsync(IManagementClient, CancellationToken)

A list of all consumers.

public static Task<IReadOnlyList<Consumer>> GetConsumersAsync(this IManagementClient client, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
cancellationToken CancellationToken

Returns

Task<IReadOnlyList<Consumer>>

GetDefinitions(IManagementClient, CancellationToken)

public static Definitions GetDefinitions(this IManagementClient client, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
cancellationToken CancellationToken

Returns

Definitions

GetDefinitionsAsync(IManagementClient, CancellationToken)

The server definitions - exchanges, queues, bindings, users, virtual hosts, permissions, topic permissions, policies and parameters. Everything apart from messages.

public static Task<Definitions> GetDefinitionsAsync(this IManagementClient client, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
cancellationToken CancellationToken

Returns

Task<Definitions>

GetExchange(IManagementClient, ExchangeName, RatesCriteria?, CancellationToken)

public static Exchange GetExchange(this IManagementClient client, ExchangeName exchange, RatesCriteria? ratesCriteria = null, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
exchange ExchangeName
ratesCriteria RatesCriteria
cancellationToken CancellationToken

Returns

Exchange

GetExchange(IManagementClient, Vhost, string, RatesCriteria?, CancellationToken)

public static Exchange GetExchange(this IManagementClient client, Vhost vhost, string exchangeName, RatesCriteria? ratesCriteria = null, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
exchangeName string
ratesCriteria RatesCriteria
cancellationToken CancellationToken

Returns

Exchange

GetExchange(IManagementClient, string, string, RatesCriteria?, CancellationToken)

public static Exchange GetExchange(this IManagementClient client, string vhostName, string exchangeName, RatesCriteria? ratesCriteria = null, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
exchangeName string
ratesCriteria RatesCriteria
cancellationToken CancellationToken

Returns

Exchange

GetExchangeAsync(IManagementClient, ExchangeName, RatesCriteria?, CancellationToken)

public static Task<Exchange> GetExchangeAsync(this IManagementClient client, ExchangeName exchange, RatesCriteria? ratesCriteria = null, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
exchange ExchangeName
ratesCriteria RatesCriteria
cancellationToken CancellationToken

Returns

Task<Exchange>

GetExchangeAsync(IManagementClient, Vhost, string, RatesCriteria?, CancellationToken)

public static Task<Exchange> GetExchangeAsync(this IManagementClient client, Vhost vhost, string exchangeName, RatesCriteria? ratesCriteria = null, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
exchangeName string
ratesCriteria RatesCriteria
cancellationToken CancellationToken

Returns

Task<Exchange>

GetExchangeAsync(IManagementClient, string, string, RatesCriteria?, CancellationToken)

Get an individual exchange by name

public static Task<Exchange> GetExchangeAsync(this IManagementClient client, string vhostName, string exchangeName, RatesCriteria? ratesCriteria = null, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string: The virtual host that contains the exchange
exchangeName string: The name of the exchange
ratesCriteria RatesCriteria: Criteria for getting samples of rate data
cancellationToken CancellationToken

Returns

Task<Exchange>: The exchange

GetExchangeBindings(IManagementClient, ExchangeName, ExchangeName, CancellationToken)

public static IReadOnlyList<Binding> GetExchangeBindings(this IManagementClient client, ExchangeName sourceExchange, ExchangeName destinationExchange, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
sourceExchange ExchangeName
destinationExchange ExchangeName
cancellationToken CancellationToken

Returns

IReadOnlyList<Binding>

GetExchangeBindings(IManagementClient, Vhost, string, string, CancellationToken)

public static IReadOnlyList<Binding> GetExchangeBindings(this IManagementClient client, Vhost vhost, string sourceExchangeName, string destinationExchangeName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
sourceExchangeName string
destinationExchangeName string
cancellationToken CancellationToken

Returns

IReadOnlyList<Binding>

GetExchangeBindings(IManagementClient, string, string, string, CancellationToken)

public static IReadOnlyList<Binding> GetExchangeBindings(this IManagementClient client, string vhostName, string sourceExchangeName, string destinationExchangeName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
sourceExchangeName string
destinationExchangeName string
cancellationToken CancellationToken

Returns

IReadOnlyList<Binding>

GetExchangeBindingsAsync(IManagementClient, ExchangeName, ExchangeName, CancellationToken)

public static Task<IReadOnlyList<Binding>> GetExchangeBindingsAsync(this IManagementClient client, ExchangeName sourceExchange, ExchangeName destinationExchange, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
sourceExchange ExchangeName
destinationExchange ExchangeName
cancellationToken CancellationToken

Returns

Task<IReadOnlyList<Binding>>

GetExchangeBindingsAsync(IManagementClient, Vhost, string, string, CancellationToken)

public static Task<IReadOnlyList<Binding>> GetExchangeBindingsAsync(this IManagementClient client, Vhost vhost, string sourceExchangeName, string destinationExchangeName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
sourceExchangeName string
destinationExchangeName string
cancellationToken CancellationToken

Returns

Task<IReadOnlyList<Binding>>

GetExchangeBindingsAsync(IManagementClient, string, string, string, CancellationToken)

A list of all bindings between an exchange and an exchange. Remember, an exchange and a exchange can be bound together many times!

public static Task<IReadOnlyList<Binding>> GetExchangeBindingsAsync(this IManagementClient client, string vhostName, string sourceExchangeName, string destinationExchangeName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
sourceExchangeName string
destinationExchangeName string
cancellationToken CancellationToken

Returns

Task<IReadOnlyList<Binding>>

GetExchanges(IManagementClient, Vhost, CancellationToken)

public static IReadOnlyList<Exchange> GetExchanges(this IManagementClient client, Vhost vhost, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
cancellationToken CancellationToken

Returns

IReadOnlyList<Exchange>

GetExchanges(IManagementClient, string, CancellationToken)

public static IReadOnlyList<Exchange> GetExchanges(this IManagementClient client, string vhostName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
cancellationToken CancellationToken

Returns

IReadOnlyList<Exchange>

GetExchanges(IManagementClient, CancellationToken)

public static IReadOnlyList<Exchange> GetExchanges(this IManagementClient client, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
cancellationToken CancellationToken

Returns

IReadOnlyList<Exchange>

GetExchangesAsync(IManagementClient, Vhost, CancellationToken)

public static Task<IReadOnlyList<Exchange>> GetExchangesAsync(this IManagementClient client, Vhost vhost, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
cancellationToken CancellationToken

Returns

Task<IReadOnlyList<Exchange>>

GetExchangesAsync(IManagementClient, string, CancellationToken)

A list of all exchanges for a virtual host.

public static Task<IReadOnlyList<Exchange>> GetExchangesAsync(this IManagementClient client, string vhostName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
cancellationToken CancellationToken

Returns

Task<IReadOnlyList<Exchange>>

GetExchangesAsync(IManagementClient, CancellationToken)

A list of all exchanges.

public static Task<IReadOnlyList<Exchange>> GetExchangesAsync(this IManagementClient client, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
cancellationToken CancellationToken

Returns

Task<IReadOnlyList<Exchange>>

GetExchangesByPage(IManagementClient, Vhost, PageCriteria, CancellationToken)

public static PageResult<Exchange> GetExchangesByPage(this IManagementClient client, Vhost vhost, PageCriteria pageCriteria, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
pageCriteria PageCriteria
cancellationToken CancellationToken

Returns

PageResult<Exchange>

GetExchangesByPage(IManagementClient, PageCriteria, CancellationToken)

public static PageResult<Exchange> GetExchangesByPage(this IManagementClient client, PageCriteria pageCriteria, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
pageCriteria PageCriteria
cancellationToken CancellationToken

Returns

PageResult<Exchange>

GetExchangesByPage(IManagementClient, string, PageCriteria, CancellationToken)

public static PageResult<Exchange> GetExchangesByPage(this IManagementClient client, string vhostName, PageCriteria pageCriteria, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
pageCriteria PageCriteria
cancellationToken CancellationToken

Returns

PageResult<Exchange>

GetExchangesByPageAsync(IManagementClient, Vhost, PageCriteria, CancellationToken)

public static Task<PageResult<Exchange>> GetExchangesByPageAsync(this IManagementClient client, Vhost vhost, PageCriteria pageCriteria, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
pageCriteria PageCriteria
cancellationToken CancellationToken

Returns

Task<PageResult<Exchange>>

GetExchangesByPageAsync(IManagementClient, PageCriteria, CancellationToken)

A list of exchanges for a page.

public static Task<PageResult<Exchange>> GetExchangesByPageAsync(this IManagementClient client, PageCriteria pageCriteria, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
pageCriteria PageCriteria
cancellationToken CancellationToken

Returns

Task<PageResult<Exchange>>

GetExchangesByPageAsync(IManagementClient, string, PageCriteria, CancellationToken)

A list of exchanges for a page for a virtual host.

public static Task<PageResult<Exchange>> GetExchangesByPageAsync(this IManagementClient client, string vhostName, PageCriteria pageCriteria, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
pageCriteria PageCriteria
cancellationToken CancellationToken

Returns

Task<PageResult<Exchange>>

GetFederationUpstream(IManagementClient, Vhost, string, CancellationToken)

public static Parameter GetFederationUpstream(this IManagementClient client, Vhost vhost, string federationUpstreamName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
federationUpstreamName string
cancellationToken CancellationToken

Returns

Parameter

GetFederationUpstream(IManagementClient, string, string, CancellationToken)

public static Parameter GetFederationUpstream(this IManagementClient client, string vhostName, string federationUpstreamName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
federationUpstreamName string
cancellationToken CancellationToken

Returns

Parameter

GetFederationUpstreamAsync(IManagementClient, Vhost, string, CancellationToken)

public static Task<Parameter> GetFederationUpstreamAsync(this IManagementClient client, Vhost vhost, string federationUpstreamName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
federationUpstreamName string
cancellationToken CancellationToken

Returns

Task<Parameter>

GetFederationUpstreamAsync(IManagementClient, string, string, CancellationToken)

Get a specific federation upstream in a specific vhost

public static Task<Parameter> GetFederationUpstreamAsync(this IManagementClient client, string vhostName, string federationUpstreamName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
federationUpstreamName string
cancellationToken CancellationToken

Returns

Task<Parameter>

GetFederations(IManagementClient, CancellationToken)

public static IReadOnlyList<Federation> GetFederations(this IManagementClient client, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
cancellationToken CancellationToken

Returns

IReadOnlyList<Federation>

GetFederationsAsync(IManagementClient, CancellationToken)

Get list of federations

public static Task<IReadOnlyList<Federation>> GetFederationsAsync(this IManagementClient client, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
cancellationToken CancellationToken

Returns

Task<IReadOnlyList<Federation>>

GetMessagesFromQueue(IManagementClient, QueueName, GetMessagesFromQueueInfo, CancellationToken)

public static IReadOnlyList<Message> GetMessagesFromQueue(this IManagementClient client, QueueName queue, GetMessagesFromQueueInfo getMessagesFromQueueInfo, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
queue QueueName
getMessagesFromQueueInfo GetMessagesFromQueueInfo
cancellationToken CancellationToken

Returns

IReadOnlyList<Message>

GetMessagesFromQueue(IManagementClient, Vhost, string, GetMessagesFromQueueInfo, CancellationToken)

public static IReadOnlyList<Message> GetMessagesFromQueue(this IManagementClient client, Vhost vhost, string queueName, GetMessagesFromQueueInfo getMessagesFromQueueInfo, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
queueName string
getMessagesFromQueueInfo GetMessagesFromQueueInfo
cancellationToken CancellationToken

Returns

IReadOnlyList<Message>

GetMessagesFromQueue(IManagementClient, string, string, GetMessagesFromQueueInfo, CancellationToken)

public static IReadOnlyList<Message> GetMessagesFromQueue(this IManagementClient client, string vhostName, string queueName, GetMessagesFromQueueInfo getMessagesFromQueueInfo, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
queueName string
getMessagesFromQueueInfo GetMessagesFromQueueInfo
cancellationToken CancellationToken

Returns

IReadOnlyList<Message>

GetMessagesFromQueueAsync(IManagementClient, QueueName, GetMessagesFromQueueInfo, CancellationToken)

public static Task<IReadOnlyList<Message>> GetMessagesFromQueueAsync(this IManagementClient client, QueueName queue, GetMessagesFromQueueInfo getMessagesFromQueueInfo, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
queue QueueName
getMessagesFromQueueInfo GetMessagesFromQueueInfo
cancellationToken CancellationToken

Returns

Task<IReadOnlyList<Message>>

GetMessagesFromQueueAsync(IManagementClient, Vhost, string, GetMessagesFromQueueInfo, CancellationToken)

public static Task<IReadOnlyList<Message>> GetMessagesFromQueueAsync(this IManagementClient client, Vhost vhost, string queueName, GetMessagesFromQueueInfo getMessagesFromQueueInfo, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
queueName string
getMessagesFromQueueInfo GetMessagesFromQueueInfo
cancellationToken CancellationToken

Returns

Task<IReadOnlyList<Message>>

GetMessagesFromQueueAsync(IManagementClient, string, string, GetMessagesFromQueueInfo, CancellationToken)

Get messages from a queue. Please note that the publish / get paths in the HTTP API are intended for injecting test messages, diagnostics etc - they do not implement reliable delivery and so should be treated as a sysadmin's tool rather than a general API for messaging.

public static Task<IReadOnlyList<Message>> GetMessagesFromQueueAsync(this IManagementClient client, string vhostName, string queueName, GetMessagesFromQueueInfo getMessagesFromQueueInfo, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
queueName string: The queue to retrieve from
getMessagesFromQueueInfo GetMessagesFromQueueInfo: The criteria for the retrieve
cancellationToken CancellationToken

Returns

Task<IReadOnlyList<Message>>: Messages

GetNodes(IManagementClient, CancellationToken)

public static IReadOnlyList<Node> GetNodes(this IManagementClient client, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
cancellationToken CancellationToken

Returns

IReadOnlyList<Node>

GetNodesAsync(IManagementClient, CancellationToken)

A list of nodes in the RabbitMQ cluster.

public static Task<IReadOnlyList<Node>> GetNodesAsync(this IManagementClient client, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
cancellationToken CancellationToken

Returns

Task<IReadOnlyList<Node>>

GetOverview(IManagementClient, LengthsCriteria?, RatesCriteria?, CancellationToken)

public static Overview GetOverview(this IManagementClient client, LengthsCriteria? lengthsCriteria = null, RatesCriteria? ratesCriteria = null, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
lengthsCriteria LengthsCriteria
ratesCriteria RatesCriteria
cancellationToken CancellationToken

Returns

Overview

GetOverviewAsync(IManagementClient, LengthsCriteria?, RatesCriteria?, CancellationToken)

Various random bits of information that describe the whole system.

public static Task<Overview> GetOverviewAsync(this IManagementClient client, LengthsCriteria? lengthsCriteria = null, RatesCriteria? ratesCriteria = null, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
lengthsCriteria LengthsCriteria: Criteria for getting samples of queue length data
ratesCriteria RatesCriteria: Criteria for getting samples of rate data
cancellationToken CancellationToken

Returns

Task<Overview>

GetParameter(IManagementClient, Parameter, CancellationToken)

public static Parameter GetParameter(this IManagementClient client, Parameter parameter, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
parameter Parameter
cancellationToken CancellationToken

Returns

Parameter

GetParameter(IManagementClient, Vhost, string, string, CancellationToken)

public static Parameter GetParameter(this IManagementClient client, Vhost vhost, string componentName, string parameterName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
componentName string
parameterName string
cancellationToken CancellationToken

Returns

Parameter

GetParameter(IManagementClient, string, string, string, CancellationToken)

public static Parameter GetParameter(this IManagementClient client, string vhostName, string componentName, string parameterName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
componentName string
parameterName string
cancellationToken CancellationToken

Returns

Parameter

GetParameterAsync(IManagementClient, Parameter, CancellationToken)

public static Task<Parameter> GetParameterAsync(this IManagementClient client, Parameter parameter, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
parameter Parameter
cancellationToken CancellationToken

Returns

Task<Parameter>

GetParameterAsync(IManagementClient, Vhost, string, string, CancellationToken)

public static Task<Parameter> GetParameterAsync(this IManagementClient client, Vhost vhost, string componentName, string parameterName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
componentName string
parameterName string
cancellationToken CancellationToken

Returns

Task<Parameter>

GetParameterAsync(IManagementClient, string, string, string, CancellationToken)

Get specific parameters on the cluster

public static Task<Parameter> GetParameterAsync(this IManagementClient client, string vhostName, string componentName, string parameterName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
componentName string
parameterName string
cancellationToken CancellationToken

Returns

Task<Parameter>

GetParameters(IManagementClient, string, Vhost, CancellationToken)

public static IReadOnlyList<Parameter> GetParameters(this IManagementClient client, string componentName, Vhost vhost, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
componentName string
vhost Vhost
cancellationToken CancellationToken

Returns

IReadOnlyList<Parameter>

GetParameters(IManagementClient, string, string, CancellationToken)

public static IReadOnlyList<Parameter> GetParameters(this IManagementClient client, string componentName, string vhostName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
componentName string
vhostName string
cancellationToken CancellationToken

Returns

IReadOnlyList<Parameter>

GetParameters(IManagementClient, string, CancellationToken)

public static IReadOnlyList<Parameter> GetParameters(this IManagementClient client, string componentName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
componentName string
cancellationToken CancellationToken

Returns

IReadOnlyList<Parameter>

GetParameters(IManagementClient, CancellationToken)

public static IReadOnlyList<Parameter> GetParameters(this IManagementClient client, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
cancellationToken CancellationToken

Returns

IReadOnlyList<Parameter>

GetParametersAsync(IManagementClient, string, Vhost, CancellationToken)

public static Task<IReadOnlyList<Parameter>> GetParametersAsync(this IManagementClient client, string componentName, Vhost vhost, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
componentName string
vhost Vhost
cancellationToken CancellationToken

Returns

Task<IReadOnlyList<Parameter>>

GetParametersAsync(IManagementClient, string, string, CancellationToken)

Get all parameters for a given component and virtual host on the cluster

public static Task<IReadOnlyList<Parameter>> GetParametersAsync(this IManagementClient client, string componentName, string vhostName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
componentName string
vhostName string
cancellationToken CancellationToken

Returns

Task<IReadOnlyList<Parameter>>

GetParametersAsync(IManagementClient, string, CancellationToken)

Get all parameters for a given component on the cluster

public static Task<IReadOnlyList<Parameter>> GetParametersAsync(this IManagementClient client, string componentName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
componentName string
cancellationToken CancellationToken

Returns

Task<IReadOnlyList<Parameter>>

GetParametersAsync(IManagementClient, CancellationToken)

Get all parameters on the cluster

public static Task<IReadOnlyList<Parameter>> GetParametersAsync(this IManagementClient client, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
cancellationToken CancellationToken

Returns

Task<IReadOnlyList<Parameter>>

GetPermissions(IManagementClient, CancellationToken)

public static IReadOnlyList<Permission> GetPermissions(this IManagementClient client, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
cancellationToken CancellationToken

Returns

IReadOnlyList<Permission>

GetPermissionsAsync(IManagementClient, CancellationToken)

A list of all permissions for all users.

public static Task<IReadOnlyList<Permission>> GetPermissionsAsync(this IManagementClient client, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
cancellationToken CancellationToken

Returns

Task<IReadOnlyList<Permission>>

GetPolicies(IManagementClient, CancellationToken)

public static IReadOnlyList<Policy> GetPolicies(this IManagementClient client, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
cancellationToken CancellationToken

Returns

IReadOnlyList<Policy>

GetPoliciesAsync(IManagementClient, CancellationToken)

Get collection of Policies on the cluster

public static Task<IReadOnlyList<Policy>> GetPoliciesAsync(this IManagementClient client, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
cancellationToken CancellationToken

Returns

Task<IReadOnlyList<Policy>>: Policies

GetQueue(IManagementClient, QueueName, LengthsCriteria?, RatesCriteria?, CancellationToken)

public static Queue GetQueue(this IManagementClient client, QueueName queue, LengthsCriteria? lengthsCriteria = null, RatesCriteria? ratesCriteria = null, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
queue QueueName
lengthsCriteria LengthsCriteria
ratesCriteria RatesCriteria
cancellationToken CancellationToken

Returns

Queue

GetQueue(IManagementClient, Vhost, string, LengthsCriteria?, RatesCriteria?, CancellationToken)

public static Queue GetQueue(this IManagementClient client, Vhost vhost, string queueName, LengthsCriteria? lengthsCriteria = null, RatesCriteria? ratesCriteria = null, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
queueName string
lengthsCriteria LengthsCriteria
ratesCriteria RatesCriteria
cancellationToken CancellationToken

Returns

Queue

GetQueue(IManagementClient, string, string, LengthsCriteria?, RatesCriteria?, CancellationToken)

public static Queue GetQueue(this IManagementClient client, string vhostName, string queueName, LengthsCriteria? lengthsCriteria = null, RatesCriteria? ratesCriteria = null, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
queueName string
lengthsCriteria LengthsCriteria
ratesCriteria RatesCriteria
cancellationToken CancellationToken

Returns

Queue

GetQueueAsync(IManagementClient, QueueName, LengthsCriteria?, RatesCriteria?, CancellationToken)

public static Task<Queue> GetQueueAsync(this IManagementClient client, QueueName queue, LengthsCriteria? lengthsCriteria = null, RatesCriteria? ratesCriteria = null, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
queue QueueName
lengthsCriteria LengthsCriteria
ratesCriteria RatesCriteria
cancellationToken CancellationToken

Returns

Task<Queue>

GetQueueAsync(IManagementClient, Vhost, string, LengthsCriteria?, RatesCriteria?, CancellationToken)

public static Task<Queue> GetQueueAsync(this IManagementClient client, Vhost vhost, string queueName, LengthsCriteria? lengthsCriteria = null, RatesCriteria? ratesCriteria = null, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
queueName string
lengthsCriteria LengthsCriteria
ratesCriteria RatesCriteria
cancellationToken CancellationToken

Returns

Task<Queue>

GetQueueAsync(IManagementClient, string, string, LengthsCriteria?, RatesCriteria?, CancellationToken)

Get an individual queue by name

public static Task<Queue> GetQueueAsync(this IManagementClient client, string vhostName, string queueName, LengthsCriteria? lengthsCriteria = null, RatesCriteria? ratesCriteria = null, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string: The virtual host that contains the queue
queueName string: The name of the queue
lengthsCriteria LengthsCriteria: Criteria for getting samples of queue length data
ratesCriteria RatesCriteria: Criteria for getting samples of rate data
cancellationToken CancellationToken

Returns

Task<Queue>: The Queue

GetQueueBindings(IManagementClient, ExchangeName, QueueName, CancellationToken)

public static IReadOnlyList<Binding> GetQueueBindings(this IManagementClient client, ExchangeName exchange, QueueName queue, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
exchange ExchangeName
queue QueueName
cancellationToken CancellationToken

Returns

IReadOnlyList<Binding>

GetQueueBindings(IManagementClient, ExchangeName, string, CancellationToken)

public static IReadOnlyList<Binding> GetQueueBindings(this IManagementClient client, ExchangeName exchange, string queueName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
exchange ExchangeName
queueName string
cancellationToken CancellationToken

Returns

IReadOnlyList<Binding>

GetQueueBindings(IManagementClient, Vhost, string, string, CancellationToken)

public static IReadOnlyList<Binding> GetQueueBindings(this IManagementClient client, Vhost vhost, string exchangeName, string queueName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
exchangeName string
queueName string
cancellationToken CancellationToken

Returns

IReadOnlyList<Binding>

GetQueueBindings(IManagementClient, string, QueueName, CancellationToken)

public static IReadOnlyList<Binding> GetQueueBindings(this IManagementClient client, string exchangeName, QueueName queue, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
exchangeName string
queue QueueName
cancellationToken CancellationToken

Returns

IReadOnlyList<Binding>

GetQueueBindings(IManagementClient, string, string, string, CancellationToken)

public static IReadOnlyList<Binding> GetQueueBindings(this IManagementClient client, string vhostName, string exchangeName, string queueName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
exchangeName string
queueName string
cancellationToken CancellationToken

Returns

IReadOnlyList<Binding>

GetQueueBindingsAsync(IManagementClient, ExchangeName, QueueName, CancellationToken)

public static Task<IReadOnlyList<Binding>> GetQueueBindingsAsync(this IManagementClient client, ExchangeName exchange, QueueName queue, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
exchange ExchangeName
queue QueueName
cancellationToken CancellationToken

Returns

Task<IReadOnlyList<Binding>>

GetQueueBindingsAsync(IManagementClient, ExchangeName, string, CancellationToken)

public static Task<IReadOnlyList<Binding>> GetQueueBindingsAsync(this IManagementClient client, ExchangeName exchange, string queueName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
exchange ExchangeName
queueName string
cancellationToken CancellationToken

Returns

Task<IReadOnlyList<Binding>>

GetQueueBindingsAsync(IManagementClient, Vhost, string, string, CancellationToken)

public static Task<IReadOnlyList<Binding>> GetQueueBindingsAsync(this IManagementClient client, Vhost vhost, string exchangeName, string queueName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
exchangeName string
queueName string
cancellationToken CancellationToken

Returns

Task<IReadOnlyList<Binding>>

GetQueueBindingsAsync(IManagementClient, string, QueueName, CancellationToken)

public static Task<IReadOnlyList<Binding>> GetQueueBindingsAsync(this IManagementClient client, string exchangeName, QueueName queue, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
exchangeName string
queue QueueName
cancellationToken CancellationToken

Returns

Task<IReadOnlyList<Binding>>

GetQueueBindingsAsync(IManagementClient, string, string, string, CancellationToken)

A list of all bindings between an exchange and a queue. Remember, an exchange and a queue can be bound together many times!

public static Task<IReadOnlyList<Binding>> GetQueueBindingsAsync(this IManagementClient client, string vhostName, string exchangeName, string queueName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
exchangeName string
queueName string
cancellationToken CancellationToken

Returns

Task<IReadOnlyList<Binding>>

GetQueues(IManagementClient, Vhost, StatsCriteria?, CancellationToken)

public static IReadOnlyList<Queue> GetQueues(this IManagementClient client, Vhost vhost, StatsCriteria? statsCriteria = null, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
statsCriteria StatsCriteria
cancellationToken CancellationToken

Returns

IReadOnlyList<Queue>

GetQueues(IManagementClient, StatsCriteria?, CancellationToken)

public static IReadOnlyList<Queue> GetQueues(this IManagementClient client, StatsCriteria? statsCriteria = null, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
statsCriteria StatsCriteria
cancellationToken CancellationToken

Returns

IReadOnlyList<Queue>

GetQueues(IManagementClient, string, StatsCriteria?, CancellationToken)

public static IReadOnlyList<Queue> GetQueues(this IManagementClient client, string vhostName, StatsCriteria? statsCriteria = null, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
statsCriteria StatsCriteria
cancellationToken CancellationToken

Returns

IReadOnlyList<Queue>

GetQueuesAsync(IManagementClient, Vhost, StatsCriteria?, CancellationToken)

public static Task<IReadOnlyList<Queue>> GetQueuesAsync(this IManagementClient client, Vhost vhost, StatsCriteria? statsCriteria = null, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
statsCriteria StatsCriteria
cancellationToken CancellationToken

Returns

Task<IReadOnlyList<Queue>>

GetQueuesAsync(IManagementClient, StatsCriteria?, CancellationToken)

A list of all queues.

public static Task<IReadOnlyList<Queue>> GetQueuesAsync(this IManagementClient client, StatsCriteria? statsCriteria = null, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
statsCriteria StatsCriteria
cancellationToken CancellationToken

Returns

Task<IReadOnlyList<Queue>>

GetQueuesAsync(IManagementClient, string, StatsCriteria?, CancellationToken)

A list of all queues for a virtual host.

public static Task<IReadOnlyList<Queue>> GetQueuesAsync(this IManagementClient client, string vhostName, StatsCriteria? statsCriteria = null, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
statsCriteria StatsCriteria
cancellationToken CancellationToken

Returns

Task<IReadOnlyList<Queue>>

GetQueuesByPage(IManagementClient, Vhost, PageCriteria, CancellationToken)

public static PageResult<Queue> GetQueuesByPage(this IManagementClient client, Vhost vhost, PageCriteria pageCriteria, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
pageCriteria PageCriteria
cancellationToken CancellationToken

Returns

PageResult<Queue>

GetQueuesByPage(IManagementClient, PageCriteria, CancellationToken)

public static PageResult<Queue> GetQueuesByPage(this IManagementClient client, PageCriteria pageCriteria, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
pageCriteria PageCriteria
cancellationToken CancellationToken

Returns

PageResult<Queue>

GetQueuesByPage(IManagementClient, string, PageCriteria, CancellationToken)

public static PageResult<Queue> GetQueuesByPage(this IManagementClient client, string vhostName, PageCriteria pageCriteria, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
pageCriteria PageCriteria
cancellationToken CancellationToken

Returns

PageResult<Queue>

GetQueuesByPageAsync(IManagementClient, Vhost, PageCriteria, CancellationToken)

public static Task<PageResult<Queue>> GetQueuesByPageAsync(this IManagementClient client, Vhost vhost, PageCriteria pageCriteria, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
pageCriteria PageCriteria
cancellationToken CancellationToken

Returns

Task<PageResult<Queue>>

GetQueuesByPageAsync(IManagementClient, PageCriteria, CancellationToken)

A list of queues for a page.

public static Task<PageResult<Queue>> GetQueuesByPageAsync(this IManagementClient client, PageCriteria pageCriteria, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
pageCriteria PageCriteria
cancellationToken CancellationToken

Returns

Task<PageResult<Queue>>

GetQueuesByPageAsync(IManagementClient, string, PageCriteria, CancellationToken)

A list of queues for a page for a virtual host.

public static Task<PageResult<Queue>> GetQueuesByPageAsync(this IManagementClient client, string vhostName, PageCriteria pageCriteria, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
pageCriteria PageCriteria
cancellationToken CancellationToken

Returns

Task<PageResult<Queue>>

GetShovel(IManagementClient, Vhost, string, CancellationToken)

public static Parameter GetShovel(this IManagementClient client, Vhost vhost, string shovelName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
shovelName string
cancellationToken CancellationToken

Returns

Parameter

GetShovel(IManagementClient, string, string, CancellationToken)

public static Parameter GetShovel(this IManagementClient client, string vhostName, string shovelName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
shovelName string
cancellationToken CancellationToken

Returns

Parameter

GetShovelAsync(IManagementClient, Vhost, string, CancellationToken)

public static Task<Parameter> GetShovelAsync(this IManagementClient client, Vhost vhost, string shovelName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
shovelName string
cancellationToken CancellationToken

Returns

Task<Parameter>

GetShovelAsync(IManagementClient, string, string, CancellationToken)

Get specific shovel parameters from a specific vhost

public static Task<Parameter> GetShovelAsync(this IManagementClient client, string vhostName, string shovelName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
shovelName string
cancellationToken CancellationToken

Returns

Task<Parameter>

GetShovelStatuses(IManagementClient, Vhost, CancellationToken)

public static IReadOnlyList<ShovelStatus> GetShovelStatuses(this IManagementClient client, Vhost vhost, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
cancellationToken CancellationToken

Returns

IReadOnlyList<ShovelStatus>

GetShovelStatuses(IManagementClient, string, CancellationToken)

public static IReadOnlyList<ShovelStatus> GetShovelStatuses(this IManagementClient client, string vhostName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
cancellationToken CancellationToken

Returns

IReadOnlyList<ShovelStatus>

GetShovelStatuses(IManagementClient, CancellationToken)

public static IReadOnlyList<ShovelStatus> GetShovelStatuses(this IManagementClient client, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
cancellationToken CancellationToken

Returns

IReadOnlyList<ShovelStatus>

GetShovelStatusesAsync(IManagementClient, Vhost, CancellationToken)

public static Task<IReadOnlyList<ShovelStatus>> GetShovelStatusesAsync(this IManagementClient client, Vhost vhost, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
cancellationToken CancellationToken

Returns

Task<IReadOnlyList<ShovelStatus>>

GetShovelStatusesAsync(IManagementClient, string, CancellationToken)

A list of all shovel statuses for a virtual host.

public static Task<IReadOnlyList<ShovelStatus>> GetShovelStatusesAsync(this IManagementClient client, string vhostName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
cancellationToken CancellationToken

Returns

Task<IReadOnlyList<ShovelStatus>>

GetShovelStatusesAsync(IManagementClient, CancellationToken)

A list of all shovel statuses.

public static Task<IReadOnlyList<ShovelStatus>> GetShovelStatusesAsync(this IManagementClient client, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
cancellationToken CancellationToken

Returns

Task<IReadOnlyList<ShovelStatus>>

GetTopicPermissions(IManagementClient, CancellationToken)

public static IReadOnlyList<TopicPermission> GetTopicPermissions(this IManagementClient client, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
cancellationToken CancellationToken

Returns

IReadOnlyList<TopicPermission>

GetTopicPermissionsAsync(IManagementClient, CancellationToken)

A list of all topic permissions for all users.

public static Task<IReadOnlyList<TopicPermission>> GetTopicPermissionsAsync(this IManagementClient client, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
cancellationToken CancellationToken

Returns

Task<IReadOnlyList<TopicPermission>>

GetUser(IManagementClient, User, CancellationToken)

public static User GetUser(this IManagementClient client, User user, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
user User
cancellationToken CancellationToken

Returns

User

GetUser(IManagementClient, string, CancellationToken)

public static User GetUser(this IManagementClient client, string userName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
userName string
cancellationToken CancellationToken

Returns

User

GetUserAsync(IManagementClient, User, CancellationToken)

public static Task<User> GetUserAsync(this IManagementClient client, User user, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
user User
cancellationToken CancellationToken

Returns

Task<User>

GetUserAsync(IManagementClient, string, CancellationToken)

Get a user by name

public static Task<User> GetUserAsync(this IManagementClient client, string userName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
userName string: The name of the user
cancellationToken CancellationToken

Returns

Task<User>: The User

GetUsers(IManagementClient, CancellationToken)

public static IReadOnlyList<User> GetUsers(this IManagementClient client, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
cancellationToken CancellationToken

Returns

IReadOnlyList<User>

GetUsersAsync(IManagementClient, CancellationToken)

A list of all users.

public static Task<IReadOnlyList<User>> GetUsersAsync(this IManagementClient client, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
cancellationToken CancellationToken

Returns

Task<IReadOnlyList<User>>

GetVhost(IManagementClient, Vhost, CancellationToken)

public static Vhost GetVhost(this IManagementClient client, Vhost vhost, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
cancellationToken CancellationToken

Returns

Vhost

GetVhost(IManagementClient, string, CancellationToken)

public static Vhost GetVhost(this IManagementClient client, string vhostName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
cancellationToken CancellationToken

Returns

Vhost

GetVhostAsync(IManagementClient, Vhost, CancellationToken)

public static Task<Vhost> GetVhostAsync(this IManagementClient client, Vhost vhost, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
cancellationToken CancellationToken

Returns

Task<Vhost>

GetVhostAsync(IManagementClient, string, CancellationToken)

Get an individual vhost by name

public static Task<Vhost> GetVhostAsync(this IManagementClient client, string vhostName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string: The VHost
cancellationToken CancellationToken

Returns

Task<Vhost>

GetVhosts(IManagementClient, CancellationToken)

public static IReadOnlyList<Vhost> GetVhosts(this IManagementClient client, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
cancellationToken CancellationToken

Returns

IReadOnlyList<Vhost>

GetVhostsAsync(IManagementClient, CancellationToken)

A list of all vhosts.

public static Task<IReadOnlyList<Vhost>> GetVhostsAsync(this IManagementClient client, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
cancellationToken CancellationToken

Returns

Task<IReadOnlyList<Vhost>>

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

public static TResult Get<TResult>(this IManagementClient client, RelativePath path, IEnumerable<KeyValuePair<string, string>>? queryParameters, CancellationToken cancellationToken = default)

Parameters

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

Returns

TResult

Type Parameters

TResult

Get<TResult>(IManagementClient, RelativePath, CancellationToken)

public static TResult Get<TResult>(this IManagementClient client, RelativePath path, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
path RelativePath
cancellationToken CancellationToken

Returns

TResult

Type Parameters

TResult

HaveAnyClassicQueuesWithoutSynchronisedMirrors(IManagementClient, CancellationToken)

public static bool HaveAnyClassicQueuesWithoutSynchronisedMirrors(this IManagementClient client, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
cancellationToken CancellationToken

Returns

bool

HaveAnyClassicQueuesWithoutSynchronisedMirrorsAsync(IManagementClient, CancellationToken)

Returns true if there are classic mirrored queues without synchronised mirrors online (queues that would potentially lose data if the target node is shut down).

public static Task<bool> HaveAnyClassicQueuesWithoutSynchronisedMirrorsAsync(this IManagementClient client, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
cancellationToken CancellationToken

Returns

Task<bool>

HaveAnyClusterAlarms(IManagementClient, CancellationToken)

public static bool HaveAnyClusterAlarms(this IManagementClient client, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
cancellationToken CancellationToken

Returns

bool

HaveAnyClusterAlarmsAsync(IManagementClient, CancellationToken)

Returns true if there are any alarms in effect in the cluster

public static Task<bool> HaveAnyClusterAlarmsAsync(this IManagementClient client, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
cancellationToken CancellationToken

Returns

Task<bool>

HaveAnyLocalAlarms(IManagementClient, CancellationToken)

public static bool HaveAnyLocalAlarms(this IManagementClient client, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
cancellationToken CancellationToken

Returns

bool

HaveAnyLocalAlarmsAsync(IManagementClient, CancellationToken)

Returns true if there are any alarms in effect in on a target node

public static Task<bool> HaveAnyLocalAlarmsAsync(this IManagementClient client, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
cancellationToken CancellationToken

Returns

Task<bool>

HaveAnyQuorumQueuesInCriticalState(IManagementClient, CancellationToken)

public static bool HaveAnyQuorumQueuesInCriticalState(this IManagementClient client, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
cancellationToken CancellationToken

Returns

bool

HaveAnyQuorumQueuesInCriticalStateAsync(IManagementClient, CancellationToken)

Returns true if there are quorum queues with minimum online quorum (queues that would lose their quorum and availability if the target node is shut down)

public static Task<bool> HaveAnyQuorumQueuesInCriticalStateAsync(this IManagementClient client, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
cancellationToken CancellationToken

Returns

Task<bool>

IsAlive(IManagementClient, Vhost, CancellationToken)

public static bool IsAlive(this IManagementClient client, Vhost vhost, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
cancellationToken CancellationToken

Returns

bool

IsAlive(IManagementClient, string, CancellationToken)

public static bool IsAlive(this IManagementClient client, string vhostName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
cancellationToken CancellationToken

Returns

bool

IsAliveAsync(IManagementClient, Vhost, CancellationToken)

public static Task<bool> IsAliveAsync(this IManagementClient client, Vhost vhost, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
cancellationToken CancellationToken

Returns

Task<bool>

IsAliveAsync(IManagementClient, string, CancellationToken)

Declares a test queue, then publishes and consumes a message. Intended for use by monitoring tools. If everything is working correctly, will return true. Note: the test queue will not be deleted (to prevent queue churn if this is repeatedly pinged).

public static Task<bool> IsAliveAsync(this IManagementClient client, string vhostName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
cancellationToken CancellationToken

Returns

Task<bool>

Post(IManagementClient, RelativePath, CancellationToken)

public static void Post(this IManagementClient client, RelativePath path, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
path RelativePath
cancellationToken CancellationToken

Post<TBody>(IManagementClient, RelativePath, TBody, CancellationToken)

public static void Post<TBody>(this IManagementClient client, RelativePath path, TBody item, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
path RelativePath
item TBody
cancellationToken CancellationToken

Type Parameters

TBody

Post<TBody, TResult>(IManagementClient, RelativePath, TBody, CancellationToken)

public static TResult Post<TBody, TResult>(this IManagementClient client, RelativePath path, TBody item, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
path RelativePath
item TBody
cancellationToken CancellationToken

Returns

TResult

Type Parameters

TBody
TResult

Publish(IManagementClient, ExchangeName, PublishInfo, CancellationToken)

public static PublishResult Publish(this IManagementClient client, ExchangeName exchange, PublishInfo publishInfo, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
exchange ExchangeName
publishInfo PublishInfo
cancellationToken CancellationToken

Returns

PublishResult

Publish(IManagementClient, Vhost, string, PublishInfo, CancellationToken)

public static PublishResult Publish(this IManagementClient client, Vhost vhost, string exchangeName, PublishInfo publishInfo, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
exchangeName string
publishInfo PublishInfo
cancellationToken CancellationToken

Returns

PublishResult

Publish(IManagementClient, string, string, PublishInfo, CancellationToken)

public static PublishResult Publish(this IManagementClient client, string vhostName, string exchangeName, PublishInfo publishInfo, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
exchangeName string
publishInfo PublishInfo
cancellationToken CancellationToken

Returns

PublishResult

PublishAsync(IManagementClient, ExchangeName, PublishInfo, CancellationToken)

public static Task<PublishResult> PublishAsync(this IManagementClient client, ExchangeName exchange, PublishInfo publishInfo, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
exchange ExchangeName
publishInfo PublishInfo
cancellationToken CancellationToken

Returns

Task<PublishResult>

PublishAsync(IManagementClient, Vhost, string, PublishInfo, CancellationToken)

public static Task<PublishResult> PublishAsync(this IManagementClient client, Vhost vhost, string exchangeName, PublishInfo publishInfo, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
exchangeName string
publishInfo PublishInfo
cancellationToken CancellationToken

Returns

Task<PublishResult>

PublishAsync(IManagementClient, string, string, PublishInfo, CancellationToken)

Publish a message to a given exchange. Please note that the publish / get paths in the HTTP API are intended for injecting test messages, diagnostics etc - they do not implement reliable delivery and so should be treated as a sysadmin's tool rather than a general API for messaging.

public static Task<PublishResult> PublishAsync(this IManagementClient client, string vhostName, string exchangeName, PublishInfo publishInfo, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string: The vhost
exchangeName string: The exchange
publishInfo PublishInfo: The publication parameters
cancellationToken CancellationToken

Returns

Task<PublishResult>: A PublishResult, routed == true if the message was sent to at least one queue

Purge(IManagementClient, QueueName, CancellationToken)

public static void Purge(this IManagementClient client, QueueName queue, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
queue QueueName
cancellationToken CancellationToken

Purge(IManagementClient, Vhost, string, CancellationToken)

public static void Purge(this IManagementClient client, Vhost vhost, string queueName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
queueName string
cancellationToken CancellationToken

Purge(IManagementClient, string, string, CancellationToken)

public static void Purge(this IManagementClient client, string vhostName, string queueName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
queueName string
cancellationToken CancellationToken

PurgeAsync(IManagementClient, QueueName, CancellationToken)

public static Task PurgeAsync(this IManagementClient client, QueueName queue, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
queue QueueName
cancellationToken CancellationToken

Returns

Task

PurgeAsync(IManagementClient, Vhost, string, CancellationToken)

public static Task PurgeAsync(this IManagementClient client, Vhost vhost, string queueName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhost Vhost
queueName string
cancellationToken CancellationToken

Returns

Task

PurgeAsync(IManagementClient, string, string, CancellationToken)

Purge a queue of all messages

public static Task PurgeAsync(this IManagementClient client, string vhostName, string queueName, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
vhostName string
queueName string
cancellationToken CancellationToken

Returns

Task

Put(IManagementClient, RelativePath, CancellationToken)

public static void Put(this IManagementClient client, RelativePath path, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
path RelativePath
cancellationToken CancellationToken

Put<TBody>(IManagementClient, RelativePath, TBody, CancellationToken)

public static void Put<TBody>(this IManagementClient client, RelativePath path, TBody item, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
path RelativePath
item TBody
cancellationToken CancellationToken

Type Parameters

TBody

RebalanceQueues(IManagementClient, CancellationToken)

public static void RebalanceQueues(this IManagementClient client, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
cancellationToken CancellationToken

RebalanceQueuesAsync(IManagementClient, CancellationToken)

Rebalances all queues in all vhosts. This operation is asynchronous therefore please check the RabbitMQ log file for messages regarding the success or failure of the operation.

public static Task RebalanceQueuesAsync(this IManagementClient client, CancellationToken cancellationToken = default)

Parameters

client IManagementClient
cancellationToken CancellationToken

Returns

Task

Table of Contents

Class IManagementClientExtensions

Methods

ChangeUserPassword(IManagementClient, User, string, CancellationToken)

Parameters

ChangeUserPassword(IManagementClient, string, string, CancellationToken)

Parameters

ChangeUserPasswordAsync(IManagementClient, User, string, CancellationToken)

Parameters

Returns

ChangeUserPasswordAsync(IManagementClient, string, string, CancellationToken)

Parameters

Returns

Check(IManagementClient, RelativePath, CancellationToken)

Parameters

Returns

CloseConnection(IManagementClient, Connection, CancellationToken)

Parameters

CloseConnection(IManagementClient, string, CancellationToken)

Parameters

CloseConnectionAsync(IManagementClient, Connection, CancellationToken)

Parameters

Returns

CloseConnectionAsync(IManagementClient, string, CancellationToken)

Parameters

Returns

CreateExchange(IManagementClient, ExchangeName, ExchangeInfo, CancellationToken)

Parameters

CreateExchange(IManagementClient, Vhost, string, ExchangeInfo, CancellationToken)

Parameters

CreateExchange(IManagementClient, string, string, ExchangeInfo, CancellationToken)

Parameters

CreateExchangeAsync(IManagementClient, ExchangeName, ExchangeInfo, CancellationToken)

Parameters

Returns

CreateExchangeAsync(IManagementClient, Vhost, string, ExchangeInfo, CancellationToken)

Parameters

Returns

CreateExchangeAsync(IManagementClient, string, string, ExchangeInfo, CancellationToken)

Parameters

Returns

CreateExchangeBinding(IManagementClient, ExchangeName, ExchangeName, BindingInfo, CancellationToken)

Parameters

CreateExchangeBinding(IManagementClient, Vhost, string, string, BindingInfo, CancellationToken)

Parameters

CreateExchangeBinding(IManagementClient, string, string, string, BindingInfo, CancellationToken)

Parameters

CreateExchangeBindingAsync(IManagementClient, ExchangeName, ExchangeName, BindingInfo, CancellationToken)

Parameters

Returns

CreateExchangeBindingAsync(IManagementClient, Vhost, string, string, BindingInfo, CancellationToken)

Parameters

Returns

CreateExchangeBindingAsync(IManagementClient, string, string, string, BindingInfo, CancellationToken)

Parameters

Returns

CreateFederationUpstream(IManagementClient, Vhost, string, ParameterFederationValue, CancellationToken)

Parameters

CreateFederationUpstream(IManagementClient, string, string, ParameterFederationValue, CancellationToken)

Parameters

CreateFederationUpstreamAsync(IManagementClient, Vhost, string, ParameterFederationValue, CancellationToken)

Parameters

Returns

CreateFederationUpstreamAsync(IManagementClient, string, string, ParameterFederationValue, CancellationToken)

Parameters

Returns

CreateParameter(IManagementClient, Parameter, object, CancellationToken)

Parameters

CreateParameter(IManagementClient, Parameter, CancellationToken)

Parameters

CreateParameter(IManagementClient, string, Vhost, string, object, CancellationToken)

Parameters

CreateParameter(IManagementClient, string, string, string, object, CancellationToken)

Parameters

CreateParameterAsync(IManagementClient, Parameter, object, CancellationToken)

Parameters

Returns

CreateParameterAsync(IManagementClient, Parameter, CancellationToken)

Parameters

Returns