ServiceBusNamespaceClient Class

An anchor class used in managing entities, such as queues, topics, subscriptions, and rules, in your service namespace. You must provide service namespace address and access credentials in order to manage your service namespace.

Inheritance Hierarchy

System.Object
  Microsoft.ServiceBus.ServiceBusNamespaceClient

Namespace:  Microsoft.ServiceBus
Assembly:  Microsoft.ServiceBus.Messaging (in Microsoft.ServiceBus.Messaging.dll)

Syntax

'Declaration
Public Class ServiceBusNamespaceClient
'Usage
Dim instance As ServiceBusNamespaceClient
public class ServiceBusNamespaceClient
public ref class ServiceBusNamespaceClient
type ServiceBusNamespaceClient =  class end
public class ServiceBusNamespaceClient

The ServiceBusNamespaceClient type exposes the following members.

Constructors

  Name Description
Public method ServiceBusNamespaceClient(String, TransportClientCredentialBase) Initializes a new instance of the ServiceBusNamespaceClient class with the given service namespace base address and credentials.
Public method ServiceBusNamespaceClient(String, ServiceBusNamespaceClientSettings) Initializes a new instance of the ServiceBusNamespaceClient class with the given service namespace base address and ServiceBusNamespaceClientSettings object.
Public method ServiceBusNamespaceClient(Uri, TransportClientCredentialBase) Initializes a new instance of the ServiceBusNamespaceClient class with the given service namespace URI base address and credentials.
Public method ServiceBusNamespaceClient(Uri, ServiceBusNamespaceClientSettings) Initializes a new instance of the ServiceBusNamespaceClient class with the given service namespace URI base address and ServiceBusNamespaceClientSettings object.

Top

Properties

  Name Description
Public property Address Gets the service namespace base address.
Public property Settings Gets the service namespace client settings.

Top

Methods

  Name Description
Public method BeginCreateQueue(String, AsyncCallback, Object) Asynchronous version of CreateQueue(String).
Public method BeginCreateQueue(String, QueueDescription, AsyncCallback, Object) Asynchronous version of CreateQueue(String, QueueDescription).
Public method BeginCreateTopic(String, AsyncCallback, Object) Asynchronous version of CreateTopic(String).
Public method BeginCreateTopic(String, TopicDescription, AsyncCallback, Object) Asynchronous version of CreateTopic(String, TopicDescription).
Public method BeginDeleteQueue Asynchronous version of DeleteQueue(String).
Public method BeginDeleteTopic Asynchronous version of DeleteTopic(String).
Public method BeginGetQueue Asynchronous version of GetQueue(String).
Public method BeginGetQueues Asynchronous version of GetQueues().
Public method BeginGetTopic Asynchronous version of GetTopic(String).
Public method BeginGetTopics Asynchronous version of GetTopics().
Public method CreateQueue(String) Creates a new queue in the service namespace with the given path.
Public method CreateQueue(String, QueueDescription) Creates a new queue in the service namespace with the given path and queue description.
Public method CreateTopic(String) Creates a new topic with the given service namespace path.
Public method CreateTopic(String, TopicDescription) Creates a new topic with the given service namespace path and description.
Public method DeleteQueue Deletes the queue described by the relative path of the service namespace base address.
Public method DeleteTopic Deletes the topic described by path.
Public method EndCreateQueue Ends an asynchronous request to create a queue.
Public method EndCreateTopic Ends an asynchronous request to create a topic.
Public method EndDeleteQueue Ends an asynchronous request to delete a queue.
Public method EndDeleteTopic Ends an asynchronous request to delete a topic.
Public method EndGetQueue Ends an asynchronous request to a get queue.
Public method EndGetQueues Ends an asynchronous request to retrieve all queues from the service namespace.
Public method EndGetTopic Ends an asynchronous request to get a topic.
Public method EndGetTopics Ends an asynchronous request to retrieve all topics from the service namespace.
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetHashCode (Inherited from Object.)
Public method GetQueue Retrieves the queue from the service namespace.
Public method GetQueues Retrieves an enumerable collection of all queues in the namespace.
Public method GetTopic Retrieves the topic from the service namespace.
Public method GetTopics Retrieves a collection of topics in a service namespace.
Public method GetType (Inherited from Object.)
Protected method MemberwiseClone (Inherited from Object.)
Public method ToString (Inherited from Object.)

Top

Examples

ServiceBusNamespaceSettings nsSettings =  new ServiceBusNamespaceSettings(); // with credentials and operation timeout
ServiceBusNamespaceClient client = new ServiceBusNamespaceClient(new Uri("baseUri"), NsSettings);

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.ServiceBus Namespace