SALES: 1-800-867-1380

NamespaceManager Class

Represents 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.

System.Object
  Microsoft.ServiceBus.NamespaceManager

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

public final class NamespaceManager

The NamespaceManager type exposes the following members.

  NameDescription
Public methodNamespaceManager(IEnumerable(String))Initializes a new instance of the NamespaceManager class with the given addresses.
Public methodNamespaceManager(IEnumerable(Uri))Initializes a new instance of the NamespaceManager class with the given service namespace URI base addresses.
Public methodNamespaceManager(String)Initializes a new instance of the NamespaceManager class with the given service namespace address.
Public methodNamespaceManager(Uri)Initializes a new instance of the NamespaceManager class with the given service namespace URI base address.
Public methodNamespaceManager(IEnumerable(String), NamespaceManagerSettings)Initializes a new instance of the NamespaceManager class with the given addresses and settings.
Public methodNamespaceManager(IEnumerable(String), TokenProvider)Initializes a new instance of the NamespaceManager class with the given addresses and token provider.
Public methodNamespaceManager(IEnumerable(Uri), NamespaceManagerSettings)Initializes a new instance of the NamespaceManager class with the given service namespace URI base addresses and settings.
Public methodNamespaceManager(IEnumerable(Uri), TokenProvider)Initializes a new instance of the NamespaceManager class with the given service namespace URI base addresses and token provider.
Public methodNamespaceManager(String, NamespaceManagerSettings)Initializes a new instance of the NamespaceManager class with the given service namespace base address and NamespaceManagerSettings object.
Public methodNamespaceManager(String, TokenProvider)Initializes a new instance of the NamespaceManager class with the given service namespace base address and token provider.
Public methodNamespaceManager(Uri, NamespaceManagerSettings)Initializes a new instance of the NamespaceManager class with the given service namespace URI base address and NamespaceManagerSettings object.
Public methodNamespaceManager(Uri, TokenProvider)Initializes a new instance of the NamespaceManager class with the given service namespace URI base address and TokenProvider object.
Top

  NameDescription
Public propertyAddressGets the service namespace base address.
Public propertySettingsGets the service namespace client settings.
Top

  NameDescription
Public methodBeginCreateQueue(String, AsyncCallback, Object)Asynchronous version of CreateQueue(String).
Public methodBeginCreateQueue(QueueDescription, AsyncCallback, Object)Asynchronous version of CreateQueue(QueueDescription).
Public methodBeginCreateSubscription(SubscriptionDescription, AsyncCallback, Object)Asynchronous version of CreateSubscription method.
Public methodBeginCreateSubscription(String, String, AsyncCallback, Object)Asynchronous version of CreateSubscription(String, String) method.
Public methodBeginCreateSubscription(SubscriptionDescription, Filter, AsyncCallback, Object)Asynchronous version of CreateSubscription method.
Public methodBeginCreateSubscription(SubscriptionDescription, RuleDescription, AsyncCallback, Object)Asynchronous version of CreateSubscription method.
Public methodBeginCreateSubscription(String, String, Filter, AsyncCallback, Object)Asynchronous version of CreateSubscription method.
Public methodBeginCreateSubscription(String, String, RuleDescription, AsyncCallback, Object)Asynchronous version of CreateSubscription method.
Public methodBeginCreateTopic(String, AsyncCallback, Object)Asynchronous version of CreateTopic(String) method.
Public methodBeginCreateTopic(TopicDescription, AsyncCallback, Object)Asynchronous version of CreateTopic(TopicDescription) method.
Public methodBeginDeleteQueueAsynchronous version of DeleteQueue(String) method.
Public methodBeginDeleteSubscriptionAsynchronous version of DeleteSubscription(String, String) method.
Public methodBeginDeleteTopicAsynchronous version of DeleteTopic(String) method.
Public methodBeginGetQueueAsynchronous version of GetQueue(String) method.
Public methodBeginGetQueues(AsyncCallback, Object)Asynchronous version of GetQueues().
Public methodBeginGetQueues(String, AsyncCallback, Object)Asynchronous version of GetQueues(String) method.
Public methodBeginGetRules(String, String, AsyncCallback, Object)Asynchronous version of GetRules(String, String) method.
Public methodBeginGetRules(String, String, String, AsyncCallback, Object)Asynchronous version of GetRules(String, String, String) method.
Public methodBeginGetSubscriptionAsynchronous version of GetSubscription(String, String) method.
Public methodBeginGetSubscriptions(String, AsyncCallback, Object)Asynchronous version of GetSubscriptions(String) method.
Public methodBeginGetSubscriptions(String, String, AsyncCallback, Object)Asynchronous version of GetSubscriptions(String, String).
Public methodBeginGetTopicAsynchronous version of GetTopic(String) method.
Public methodBeginGetTopics(AsyncCallback, Object)Asynchronous version of GetTopics() method.
Public methodBeginGetTopics(String, AsyncCallback, Object)Asynchronous version of GetTopics(String) method.
Public methodBeginGetVersionInfoAsynchronous version of GetVersionInfo(String) method.
Public methodBeginQueueExistsAsynchronous version of QueueExists(String) method.
Public methodBeginSubscriptionExistsAsynchronous version of SubscriptionExists(String, String) method.
Public methodBeginTopicExistsAsynchronous version of TopicExists(String) method.
Public methodBeginUpdateQueueAsynchronous version of UpdateQueue(String) method.
Public methodBeginUpdateSubscriptionAsynchronous version of UpdateSubscription(String) method.
Public methodBeginUpdateTopicAsynchronous version of UpdateTopic(String) method.
Public methodStatic memberCreateCreates a new instance of NamespaceManager.
Public methodCreateConsumerGroup(ConsumerGroupDescription)Creates an Event Hubs consumer group using the specified ConsumerGroupDescription.
Public methodCreateConsumerGroup(String, String)Creates an Event Hubs consumer group using default values, with the specified Event Hubs path and a name for the consumer group.
Public methodCreateConsumerGroupAsync(ConsumerGroupDescription)Asynchronous version of CreateConsumerGroup(ConsumerGroupDescription).
Public methodCreateConsumerGroupAsync(String, String)Asynchronous version of CreateConsumerGroup(String, String).
Public methodCreateConsumerGroupIfNotExists(ConsumerGroupDescription)Creates a consumer group if it does not already exist, using the specified ConsumerGroupDescription as metadata. If the group already exists, then return the stored ConsumerGroupDescription.
Public methodCreateConsumerGroupIfNotExists(String, String)Creates a consumer group if it does not already exist, using the specified Event Hubs path and group name. If the group already exists, then return the stored ConsumerGroupDescription.
Public methodCreateConsumerGroupIfNotExistsAsync(ConsumerGroupDescription)Asynchronous version of CreateConsumerGroupIfNotExists(ConsumerGroupDescription).
Public methodCreateConsumerGroupIfNotExistsAsync(String, String)Asynchronous version of CreateConsumerGroupIfNotExists(String, String).
Public methodCreateEventHub(String)Creates a new Event Hub using default values, for the given input path.
Public methodCreateEventHub(EventHubDescription)Creates a new Event Hub using the specified EventHubDescription.
Public methodCreateEventHubAsync(String)Asynchronously creates an event hub.
Public methodCreateEventHubAsync(EventHubDescription)Asynchronously creates an event hub.
Public methodCreateEventHubIfNotExists(String)Creates an Event Hub if it does not exist.
Public methodCreateEventHubIfNotExists(EventHubDescription)Creates an Event Hub if it does not exist.
Public methodCreateEventHubIfNotExistsAsync(String)Asynchronously creates an Event Hub if it does not exist.
Public methodCreateEventHubIfNotExistsAsync(EventHubDescription)Asynchronously creates an Event Hub if it does not exist.
Public methodStatic memberCreateFromConnectionStringCreates a new instance of NamespaceManager using a specified connection string.
Public methodCreateNotificationHubCreates a new notification hub with the properties specified in the description parameter.
Public methodCreateNotificationHubAsyncAsynchronously creates a new notification hub with the properties specified in the description parameter.
Public methodCreateQueue(String)Creates a new queue in the service namespace with the given path.
Public methodCreateQueue(QueueDescription)Creates a new queue in the service namespace with the specified queue description.
Public methodCreateQueueAsync(String)Asynchronously creates a new queue in the service namespace with the given path.
Public methodCreateQueueAsync(QueueDescription)Asynchronously creates a new queue in the service namespace with the specified queue description.
Public methodCreateRelayAsync(RelayDescription)Asynchronously creates a new relay in the service namespace with the specified queue description.
Public methodCreateRelayAsync(String, RelayType)Asynchronously creates a new queue in the service namespace with the given path and type.
Public methodCreateSubscription(SubscriptionDescription)Creates a new subscription in the service namespace with the specified subscription description.
Public methodCreateSubscription(String, String)Creates a new subscription in the service namespace with the specified topic path and subscription name.
Public methodCreateSubscription(SubscriptionDescription, Filter)Creates a new subscription in the service namespace with the specified subscription description and filter expression.
Public methodCreateSubscription(SubscriptionDescription, RuleDescription)Creates a new subscription in the service namespace with the specified subscription description and rule description.
Public methodCreateSubscription(String, String, Filter)Creates a new subscription in the service namespace with the specified topic path, subscription name, and filter expression.
Public methodCreateSubscription(String, String, RuleDescription)Creates a new subscription in the service namespace with the specified topic path, subscription name, and rule description.
Public methodCreateSubscriptionAsync(SubscriptionDescription)Asynchronously creates a new subscription in the service namespace with the specified subscription description.
Public methodCreateSubscriptionAsync(String, String)Asynchronously creates a new subscription in the service namespace with the specified topic path and subscription name.
Public methodCreateSubscriptionAsync(SubscriptionDescription, Filter)Asynchronously creates a new subscription in the service namespace with the specified subscription description and filter expression.
Public methodCreateSubscriptionAsync(SubscriptionDescription, RuleDescription)Asynchronously creates a new subscription in the service namespace with the specified subscription description and rule description.
Public methodCreateSubscriptionAsync(String, String, Filter)Asynchronously creates a new subscription in the service namespace with the specified topic path, subscription name, and filter expression.
Public methodCreateSubscriptionAsync(String, String, RuleDescription)Asynchronously creates a new subscription in the service namespace with the specified topic path, subscription name, and rule description.
Public methodCreateTopic(String)Creates a new topic inside the service namespace with the given service namespace path.
Public methodCreateTopic(TopicDescription)Creates a new topic inside the service namespace with the specified topic description.
Public methodCreateTopicAsync(String)Asynchronously creates a new topic inside the service namespace with the given service namespace path.
Public methodCreateTopicAsync(TopicDescription)Asynchronously creates a new topic inside the service namespace with the specified topic description.
Public methodDeleteConsumerGroupDeletes a consumer group.
Public methodDeleteConsumerGroupAsyncAsynchronously deletes a consumer group.
Public methodDeleteEventHubDeletes an Event Hub.
Public methodDeleteEventHubAsyncAsynchronously deletes an Event Hub.
Public methodDeleteNotificationHubDeletes a notification hub at the provided path.
Public methodDeleteNotificationHubAsyncAsynchronously deletes a notification hub at the provided path.
Public methodDeleteQueueDeletes the queue described by the path relative to the service namespace base address.
Public methodDeleteQueueAsyncAsynchronously deletes the queue described by the path relative to the service namespace base address.
Public methodDeleteRelayAsyncAsynchronously deletes the relay described by the path relative to the service namespace base address.
Public methodDeleteSubscriptionDeletes the subscription with the specified topic path and subscription name.
Public methodDeleteSubscriptionAsyncAsynchronously deletes the subscription with the specified topic path and subscription name.
Public methodDeleteTopicDeletes the topic described by path relative to the service namespace base address.
Public methodDeleteTopicAsyncAsynchronously deletes the topic described by path relative to the service namespace base address.
Public methodEndCreateQueueEnds an asynchronous request to create a queue.
Public methodEndCreateSubscriptionEnds an asynchronous request to create a subscription.
Public methodEndCreateTopicEnds an asynchronous request to create a topic.
Public methodEndDeleteQueueEnds an asynchronous request to delete a queue.
Public methodEndDeleteRegistrationEnds an asynchronous request to delete a registration.
Public methodEndDeleteSubscriptionEnds an asynchronous request to delete a subscription.
Public methodEndDeleteTopicEnds an asynchronous request to delete a topic.
Public methodEndGetQueueEnds an asynchronous request to get a queue.
Public methodEndGetQueuesEnds an asynchronous request to retrieve all queues from the service namespace.
Public methodEndGetRulesEnds an asynchronous request to retrieve all rules from the service namespace.
Public methodEndGetSubscriptionEnds an asynchronous request to get a subscription.
Public methodEndGetSubscriptionsEnds an asynchronous request to retrieve all subscriptions from the service namespace.
Public methodEndGetTopicEnds an asynchronous request to get a topic.
Public methodEndGetTopicsEnds an asynchronous request to retrieve all topics from the service namespace.
Public methodEndGetVersionInfoEnds an asynchronous request to get version information.
Public methodEndQueueExistsEnds an asynchronous request to determine whether a queue exists from the service namespace.
Public methodEndSubscriptionExistsEnds an asynchronous request to determine whether a subscription exists from the service namespace.
Public methodEndTopicExistsEnds an asynchronous request to determine whether a topic exists from the service namespace.
Public methodEndUpdateQueueEnds an asynchronous request to update queue.
Public methodEndUpdateSubscriptionEnds an asynchronous request to update subscription.
Public methodEndUpdateTopicEnds an asynchronous request to update topic.
Public methodEquals (Inherited from Object.)
Public methodEventHubExistsIndicates whether or not an Event Hub exists.
Public methodEventHubExistsAsyncAsynchronously determines whether the event hub exists from the service namespace.
Public methodGetConsumerGroupGets an Event Hubs consumer group.
Public methodGetConsumerGroupAsyncAsynchronously gets a consumer group.
Public methodGetConsumerGroupsGets a collection representing a set of consumer groups.
Public methodGetConsumerGroupsAsyncAsynchronously gets a set of consumer groups.
Public methodGetEventHubGets information about an Event Hub.
Public methodGetEventHubAsyncAsynchronously gets information about an Event Hub.
Public methodGetEventHubPartitionReturns information about the specified Event Hub partition. This method assumes that you want partition information for the partition specified by the name parameter that belongs to the default consumer group pointed to by eventHubPath.
Public methodGetEventHubPartitionAsyncAsynchronous version of GetEventHubPartition(String, String).
Public methodGetEventHubsGets a collection representing a set of Event Hubs.
Public methodGetEventHubsAsyncAsynchronously gets a list of Event Hubs.
Public methodGetHashCode (Inherited from Object.)
Public methodGetNotificationHubRetrieves the description of a notification hub from the service namespace.
Public methodGetNotificationHubAsyncAsynchronously retrieves the description of a notification hub from the service namespace.
Public methodGetNotificationHubJobAsyncAsynchronously gets a specified notification hubs job.
Public methodGetNotificationHubJobsAsyncAsynchronously gets a set of all notification hubs jobs.
Public methodGetNotificationHubsRetrieves the description of a notification hub from the service namespace.
Public methodGetNotificationHubsAsyncAsynchronously retrieves the description of a notification hub from the service namespace.
Public methodGetQueueRetrieves a queue from the service namespace.
Public methodGetQueueAsyncAsynchronously retrieves a queue from the service namespace.
Public methodGetQueues()Retrieves an enumerable collection of all queues in the service namespace.
Public methodGetQueues(String)Retrieves an enumerable collection of all queues in the service namespace with the specified filter. You can filter by a combination of entity name (including starts with), entity length (Gt or Lt), created, updated, and accessed time (Gt or Lt).
Public methodGetQueuesAsync()Asynchronously retrieves an enumerable collection of all queues in the service namespace.
Public methodGetQueuesAsync(String)Asynchronously retrieves an enumerable collection of all queues in the service namespace with specified filter.
Public methodGetRelayAsyncAsynchronously retrieves an enumerable collection of all relays in the service namespace with specified path.
Public methodGetRelaysAsyncAsynchronously retrieves an enumerable collection of all relays in the service namespace.
Public methodGetRules(String, String)Retrieves an enumerable collection of all rules in the service namespace.
Public methodGetRules(String, String, String)Retrieves an enumerable collection of all rules in the service namespace with specified topic path, subscription name and filter.
Public methodGetRulesAsync(String, String)Asynchronously retrieves an enumerable collection of all rules in the service namespace.
Public methodGetRulesAsync(String, String, String)Asynchronously retrieves an enumerable collection of all rules in the service namespace with specified topic path, subscription name and filter.
Public methodGetSubscriptionRetrieves the topic from the service namespace.
Public methodGetSubscriptionAsyncAsynchronously retrieves the topic from the service namespace.
Public methodGetSubscriptions(String)Retrieves an enumerable collection of all subscriptions in the service namespace.
Public methodGetSubscriptions(String, String)Retrieves an enumerable collection of all subscriptions in the service namespace with specified topic path and filter.
Public methodGetSubscriptionsAsync(String)Asynchronously retrieves an enumerable collection of all subscriptions in the service namespace.
Public methodGetSubscriptionsAsync(String, String)Asynchronously retrieves an enumerable collection of all subscriptions in the service namespace.
Public methodGetTopicRetrieves the topic from the service namespace.
Public methodGetTopicAsyncAsynchronously retrieves the topic from the service namespace.
Public methodGetTopics()Retrieves a collection of topics in a service namespace.
Public methodGetTopics(String)Retrieves a collection of topics in a service namespace with the specified filter. You can filter by a combination of entity name (including starts with), entity length (Gt or Lt), created, updated, and accessed time (Gt or Lt).
Public methodGetTopicsAsync()Asynchronously retrieves a collection of topics in a service namespace.
Public methodGetTopicsAsync(String)Asynchronously retrieves a collection of topics in a service namespace.
Public methodGetType (Inherited from Object.)
Public methodGetVersionInfoRetrieves a string of the format "YYYY-MM" that indicates the maximum supported protocol version that the server or service can handle.
Public methodGetVersionInfoAsyncAsynchronously retrieves a string of the format "YYYY-MM" that indicates the maximum supported protocol version that the server or service can handle.
Public methodNotificationHubExistsDetermines whether there is a notification hub at the specified path in the service namespace.
Public methodNotificationHubExistsAsyncAsynchronously determines whether there is a notification hub at the specified path in the service namespace.
Public methodQueueExistsDetermines whether a queue exists in the service namespace.
Public methodQueueExistsAsyncAsynchronously determines whether a queue exists in the service namespace.
Public methodRelayExistsAsyncAsynchronously determines whether a relay exists in the service namespace.
Public methodSubmitNotificationHubJobAsyncSubmits a notification hub job for processing.
Public methodSubscriptionExistsDetermines whether a subscription exists in the service namespace.
Public methodSubscriptionExistsAsyncAsynchronously determines whether a subscription exists in the service namespace.
Public methodTopicExistsDetermines whether a topic exists in the service namespace.
Public methodTopicExistsAsyncAsynchronously determines whether a topic exists in the service namespace.
Public methodToString (Inherited from Object.)
Public methodUpdateConsumerGroupUpdates an Event Hubs consumer group.
Public methodUpdateConsumerGroupAsyncAsynchronously updates the consumer group.
Public methodUpdateEventHubUpdates an Event Hub.
Public methodUpdateEventHubAsyncAsynchronously updates the event hub.
Public methodUpdateNotificationHubUpdates an existing notification hub at the path specified in the description parameter. All the notification hub properties are overwritten with the ones specified in the description parameter.
Public methodUpdateNotificationHubAsyncAsynchronously updates an existing notification hub at the path specified in the description parameter. All the notification hub properties are overwritten with the ones specified in the description parameter.
Public methodUpdateQueueEnables you to update the queue.
Public methodUpdateQueueAsyncAsynchronously enables you to update the queue.
Public methodUpdateRelayAsyncAsynchronously enables you to update the relay.
Public methodUpdateSubscriptionEnables you to update the subscription.
Public methodUpdateSubscriptionAsyncAsynchronously enables you to update the subscription.
Public methodUpdateTopicEnables you to update the topic.
Public methodUpdateTopicAsyncAsynchronously enables you to update the topic.
Top

  NameDescription
Public fieldStatic memberProtocolVersionSpecifies the string of the format "YYYY-MM" that indicates the client's protocol version.
Top

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

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft