Class ServiceBusClient | Azure SDK for .NET

Inheritance

System.Object

ServiceBusClient

Namespace: System.Dynamic.ExpandoObject

Assembly: Azure.Messaging.ServiceBus.dll

Syntax

public class ServiceBusClient : IAsyncDisposable

Constructors

ServiceBusClient()

Can be used for mocking.

Declaration

protected ServiceBusClient ();

ServiceBusClient(String)

Declaration

public ServiceBusClient (string connectionString);

Parameters

System.String connectionString The connection string to use for connecting to the Service Bus namespace.

ServiceBusClient(String, TokenCredential)

Declaration

public ServiceBusClient (string fullyQualifiedNamespace, Azure.Core.TokenCredential credential);

Parameters

System.String fullyQualifiedNamespace The fully qualified Service Bus namespace to connect to. This is likely to be similar to {yournamespace}.servicebus.windows.net.

Azure.Core.TokenCredential credential The Azure managed identity credential to use for authorization. Access controls may be specified by the Service Bus namespace.

ServiceBusClient(String, ServiceBusClientOptions)

Declaration

public ServiceBusClient (string connectionString, Azure.Messaging.ServiceBus.ServiceBusClientOptions options);

Parameters

ServiceBusClient(String, TokenCredential, ServiceBusClientOptions)

Declaration

public ServiceBusClient (string fullyQualifiedNamespace, Azure.Core.TokenCredential credential, Azure.Messaging.ServiceBus.ServiceBusClientOptions options);

Parameters

System.String fullyQualifiedNamespace The fully qualified Service Bus namespace to connect to. This is likely to be similar to {yournamespace}.servicebus.windows.net.

Azure.Core.TokenCredential credential The Azure managed identity credential to use for authorization. Access controls may be specified by the Service Bus namespace.

ServiceBusClientOptions options The set of ServiceBusClientOptions to use for configuring this ServiceBusClient.

Properties

FullyQualifiedNamespace

The fully qualified Service Bus namespace that the connection is associated with. This is likely to be similar to {yournamespace}.servicebus.windows.net.

Declaration

public virtual string FullyQualifiedNamespace { get; }

Property Value

System.String

IsClosed

Declaration

public bool IsClosed { get; }

Property Value

System.Boolean true if the client is closed; otherwise, false.

TransportType

Declaration

public Azure.Messaging.ServiceBus.ServiceBusTransportType TransportType { get; }

Property Value

Methods

AcceptNextSessionAsync(String, ServiceBusSessionReceiverOptions, CancellationToken)

Declaration

[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Messaging.ServiceBus.ServiceBusSessionReceiver> AcceptNextSessionAsync (string queueName, Azure.Messaging.ServiceBus.ServiceBusSessionReceiverOptions options = null, System.Threading.CancellationToken cancellationToken = null);

Parameters

Returns

AcceptNextSessionAsync(String, String, ServiceBusSessionReceiverOptions, CancellationToken)

Declaration

[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Messaging.ServiceBus.ServiceBusSessionReceiver> AcceptNextSessionAsync (string topicName, string subscriptionName, Azure.Messaging.ServiceBus.ServiceBusSessionReceiverOptions options = null, System.Threading.CancellationToken cancellationToken = null);

Parameters

Returns

AcceptSessionAsync(String, String, ServiceBusSessionReceiverOptions, CancellationToken)

Declaration

[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Messaging.ServiceBus.ServiceBusSessionReceiver> AcceptSessionAsync (string queueName, string sessionId, Azure.Messaging.ServiceBus.ServiceBusSessionReceiverOptions options = null, System.Threading.CancellationToken cancellationToken = null);

Parameters

Returns

AcceptSessionAsync(String, String, String, ServiceBusSessionReceiverOptions, CancellationToken)

Declaration

[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Messaging.ServiceBus.ServiceBusSessionReceiver> AcceptSessionAsync (string topicName, string subscriptionName, string sessionId, Azure.Messaging.ServiceBus.ServiceBusSessionReceiverOptions options = null, System.Threading.CancellationToken cancellationToken = null);

Parameters

Returns

CreateProcessor(String, String, ServiceBusProcessorOptions)

Declaration

public virtual Azure.Messaging.ServiceBus.ServiceBusProcessor CreateProcessor (string topicName, string subscriptionName, Azure.Messaging.ServiceBus.ServiceBusProcessorOptions options);

Parameters

Returns

CreateProcessor(String, String)

Declaration

public virtual Azure.Messaging.ServiceBus.ServiceBusProcessor CreateProcessor (string topicName, string subscriptionName);

Parameters

Returns

CreateProcessor(String)

Declaration

public virtual Azure.Messaging.ServiceBus.ServiceBusProcessor CreateProcessor (string queueName);

Parameters

Returns

CreateProcessor(String, ServiceBusProcessorOptions)

Declaration

public virtual Azure.Messaging.ServiceBus.ServiceBusProcessor CreateProcessor (string queueName, Azure.Messaging.ServiceBus.ServiceBusProcessorOptions options);

Parameters

Returns

CreateReceiver(String)

Declaration

public virtual Azure.Messaging.ServiceBus.ServiceBusReceiver CreateReceiver (string queueName);

Parameters

Returns

CreateReceiver(String, ServiceBusReceiverOptions)

Declaration

public virtual Azure.Messaging.ServiceBus.ServiceBusReceiver CreateReceiver (string queueName, Azure.Messaging.ServiceBus.ServiceBusReceiverOptions options);

Parameters

Returns

CreateReceiver(String, String)

Declaration

public virtual Azure.Messaging.ServiceBus.ServiceBusReceiver CreateReceiver (string topicName, string subscriptionName);

Parameters

System.String topicName The topic to create a ServiceBusReceiver for.

System.String subscriptionName The subscription specific to the specified topic to create a ServiceBusReceiver for.

Returns

CreateReceiver(String, String, ServiceBusReceiverOptions)

Declaration

public virtual Azure.Messaging.ServiceBus.ServiceBusReceiver CreateReceiver (string topicName, string subscriptionName, Azure.Messaging.ServiceBus.ServiceBusReceiverOptions options);

Parameters

Returns

CreateSender(String)

Creates a ServiceBusSender instance that can be used for sending messages to a specific queue or topic.

Declaration

public virtual Azure.Messaging.ServiceBus.ServiceBusSender CreateSender (string queueOrTopicName);

Parameters

System.String queueOrTopicName The queue or topic to create a ServiceBusSenderfor.

Returns

CreateSessionProcessor(String, ServiceBusSessionProcessorOptions)

Declaration

public virtual Azure.Messaging.ServiceBus.ServiceBusSessionProcessor CreateSessionProcessor (string queueName, Azure.Messaging.ServiceBus.ServiceBusSessionProcessorOptions options = null);

Parameters

Returns

CreateSessionProcessor(String, String, ServiceBusSessionProcessorOptions)

Declaration

public virtual Azure.Messaging.ServiceBus.ServiceBusSessionProcessor CreateSessionProcessor (string topicName, string subscriptionName, Azure.Messaging.ServiceBus.ServiceBusSessionProcessorOptions options = null);

Parameters

Returns

DisposeAsync()

Performs the task needed to clean up resources used by the Azure.Messaging.ServiceBus.ServiceBusConnection, including ensuring that the connection itself has been closed.

Declaration

[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.ValueTask DisposeAsync ();

Returns

System.Threading.Tasks.ValueTask A task to be resolved on when the operation has completed.