NamespaceManager Class

Definition

Namespace:

Microsoft.ServiceBus

Assembly:

Microsoft.ServiceBus.dll

Package:

WindowsAzure.ServiceBus v6.2.2

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.

public sealed class NamespaceManager

type NamespaceManager = class

Public NotInheritable Class NamespaceManager

Inheritance

Object

NamespaceManager

Examples

NamespaceManagerSettings nsSettings = new NamespaceManagerSettings(); // with credentials and operation timeout
NamespaceManager manager = new NamespaceManager(new Uri("baseUri"), nsSettings);

Constructors

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

Properties

Address	Gets the service namespace base address.
ProtocolVersion	Specifies the string of the format "YYYY-MM" that indicates the client protocol version.
Settings	Gets the service namespace client settings.

Methods

Create()	Creates a new instance of NamespaceManager.
CreateConsumerGroup(ConsumerGroupDescription)	Creates an Event Hubs consumer group using the specified ConsumerGroupDescription.
CreateConsumerGroup(String, String)	Creates an Event Hubs consumer group using default values, with the specified Event Hubs path and a name for the consumer group.
CreateConsumerGroupAsync(ConsumerGroupDescription)	Asynchronous version of CreateConsumerGroup(ConsumerGroupDescription).
CreateConsumerGroupAsync(String, String)	Asynchronous version of CreateConsumerGroup(String, String).
CreateConsumerGroupIfNotExists(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.
CreateConsumerGroupIfNotExists(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.
CreateConsumerGroupIfNotExistsAsync(ConsumerGroupDescription)	Asynchronous version of CreateConsumerGroupIfNotExists(ConsumerGroupDescription).
CreateConsumerGroupIfNotExistsAsync(String, String)	Asynchronous version of CreateConsumerGroupIfNotExists(String, String).
CreateEventHub(EventHubDescription)	Creates a new Event Hub using the specified EventHubDescription.
CreateEventHub(String)	Creates a new Event Hub using default values, for the given input path.
CreateEventHubAsync(EventHubDescription)	Asynchronously creates an event hub.
CreateEventHubAsync(String)	Asynchronously creates an event hub.
CreateEventHubIfNotExists(EventHubDescription)	Creates an Event Hub if it does not exist.
CreateEventHubIfNotExists(String)	Creates an Event Hub if it does not exist.
CreateEventHubIfNotExistsAsync(EventHubDescription)	Asynchronously creates an Event Hub if it does not exist.
CreateEventHubIfNotExistsAsync(String)	Asynchronously creates an Event Hub if it does not exist.
CreateFromConnectionString(String)	Creates a new instance of NamespaceManager using a specified connection string.
CreateOrUpdateQueueCoreAsync(NamespaceManager, QueueDescription, Boolean, CancellationToken)
CreateQueue(QueueDescription)	Creates a new queue in the service namespace with the specified queue description.
CreateQueue(String)	Creates a new queue in the service namespace with the given path.
CreateQueueAsync(QueueDescription)	Asynchronously creates a new queue in the service namespace with the specified queue description.
CreateQueueAsync(String)	Asynchronously creates a new queue in the service namespace with the given path.
CreateRelay(RelayDescription)	Creates a new relay in the service namespace with the specified relay description.
CreateRelay(String, RelayType)	Creates a new relay in the service namespace with the given path and type.
CreateRelayAsync(RelayDescription)	Asynchronously creates a new relay in the service namespace with the specified relay description.
CreateRelayAsync(String, RelayType)	Asynchronously creates a new relay in the service namespace with the given path and type.
CreateSubscription(String, String, Filter)	Creates a new subscription in the service namespace with the specified topic path, subscription name, and filter expression.
CreateSubscription(String, String, RuleDescription)	Creates a new subscription in the service namespace with the specified topic path, subscription name, and rule description.
CreateSubscription(String, String)	Creates a new subscription in the service namespace with the specified topic path and subscription name.
CreateSubscription(SubscriptionDescription, Filter)	Creates a new subscription in the service namespace with the specified subscription description and filter expression.
CreateSubscription(SubscriptionDescription, RuleDescription)	Creates a new subscription in the service namespace with the specified subscription description and rule description.
CreateSubscription(SubscriptionDescription)	Creates a new subscription in the service namespace with the specified subscription description.
CreateSubscriptionAsync(String, String, Filter)	Asynchronously creates a new subscription in the service namespace with the specified topic path, subscription name, and filter expression.
CreateSubscriptionAsync(String, String, RuleDescription)	Asynchronously creates a new subscription in the service namespace with the specified topic path, subscription name, and rule description.
CreateSubscriptionAsync(String, String)	Asynchronously creates a new subscription in the service namespace with the specified topic path and subscription name.
CreateSubscriptionAsync(SubscriptionDescription, Filter)	Asynchronously creates a new subscription in the service namespace with the specified subscription description and filter expression.
CreateSubscriptionAsync(SubscriptionDescription, RuleDescription)	Asynchronously creates a new subscription in the service namespace with the specified subscription description and rule description.
CreateSubscriptionAsync(SubscriptionDescription)	Asynchronously creates a new subscription in the service namespace with the specified subscription description.
CreateTopic(String)	Creates a new topic inside the service namespace with the given service namespace path.
CreateTopic(TopicDescription)	Creates a new topic inside the service namespace with the specified topic description.
CreateTopicAsync(String)	Asynchronously creates a new topic inside the service namespace with the given service namespace path.
CreateTopicAsync(TopicDescription)	Asynchronously creates a new topic inside the service namespace with the specified topic description.
DeleteConsumerGroup(String, String)	Deletes a consumer group.
DeleteConsumerGroupAsync(String, String)	Asynchronously deletes a consumer group.
DeleteEventHub(String)	Deletes an Event Hub.
DeleteEventHubAsync(String)	Asynchronously deletes an Event Hub.
DeleteQueue(String)	Deletes the queue described by the path relative to the service namespace base address.
DeleteQueueAsync(String)	Asynchronously deletes the queue described by the path relative to the service namespace base address.
DeleteRelay(String)	Deletes the relay described by the path relative to the service namespace base address.
DeleteRelayAsync(String)	Asynchronously deletes the relay described by the path relative to the service namespace base address.
DeleteSubscription(String, String)	Deletes the subscription with the specified topic path and subscription name.
DeleteSubscriptionAsync(String, String)	Asynchronously deletes the subscription with the specified topic path and subscription name.
DeleteTopic(String)	Deletes the topic described by path relative to the service namespace base address.
DeleteTopicAsync(String)	Asynchronously deletes the topic described by path relative to the service namespace base address.
EventHubExists(String)	Indicates whether or not an Event Hub exists.
EventHubExistsAsync(String)	Asynchronously determines whether the event hub exists from the service namespace.
GetConsumerGroup(String, String)	Gets an Event Hubs consumer group.
GetConsumerGroupAsync(String, String)	Asynchronously gets a consumer group.
GetConsumerGroups(String)	Gets a collection representing a set of consumer groups.
GetConsumerGroupsAsync(String)	Asynchronously gets a set of consumer groups.
GetEventHub(String)	Gets information about an Event Hub.
GetEventHubAsync(String)	Asynchronously gets information about an Event Hub.
GetEventHubPartition(String, String, String)
GetEventHubPartition(String, String)	Returns 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.
GetEventHubPartitionAsync(String, String, String)	Asynchronous version of GetEventHubPartition(String, String).
GetEventHubPartitionAsync(String, String)	Asynchronous version of GetEventHubPartition(String, String).
GetEventHubs()	Gets a collection representing a set of Event Hubs.
GetEventHubsAsync()	Asynchronously gets a list of Event Hubs.
GetNamespaceInfo()	Gets information related to namespace
GetNamespaceInfoAsync()	Asynchronously gets information related to namespace
GetQueue(String)	Retrieves a queue from the service namespace.
GetQueueAsync(String)	Asynchronously retrieves a queue from the service namespace.
GetQueues()	Retrieves an enumerable collection of all queues in the service namespace.
GetQueues(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).
GetQueuesAsync()	Asynchronously retrieves an enumerable collection of all queues in the service namespace.
GetQueuesAsync(String)	Asynchronously retrieves an enumerable collection of all queues in the service namespace with specified filter.
GetRelay(String)	Retrieves the details of a given relay endpoint.
GetRelayAsync(String)	Asynchronously retrieves the details of a given relay endpoint.
GetRelays()	Retrieves a collection of all relays in the service namespace.
GetRelaysAsync()	Asynchronously retrieves a collection of all relays in the service namespace.
GetRevokedPublishers(String)	Returns all revoked publishers in an Event Hub.
GetRevokedPublishersAsync(String)	Asynchronous version of GetRevokedPublishers(String).
GetRules(String, String, String)	Retrieves an enumerable collection of all rules in the service namespace with specified topic path, subscription name and filter.
GetRules(String, String)	Retrieves an enumerable collection of all rules in the service namespace.
GetRulesAsync(String, String, String)	Asynchronously retrieves an enumerable collection of all rules in the service namespace with specified topic path, subscription name and filter.
GetRulesAsync(String, String)	Asynchronously retrieves an enumerable collection of all rules in the service namespace.
GetSubscription(String, String)	Retrieves the topic from the service namespace.
GetSubscriptionAsync(String, String)	Asynchronously retrieves the topic from the service namespace.
GetSubscriptions(String, String)	Retrieves an enumerable collection of all subscriptions in the service namespace with specified topic path and filter.
GetSubscriptions(String)	Retrieves an enumerable collection of all subscriptions in the service namespace.
GetSubscriptionsAsync(String, String)	Asynchronously retrieves an enumerable collection of all subscriptions in the service namespace.
GetSubscriptionsAsync(String)	Asynchronously retrieves an enumerable collection of all subscriptions in the service namespace.
GetTopic(String)	Retrieves the topic from the service namespace.
GetTopicAsync(String)	Asynchronously retrieves the topic from the service namespace.
GetTopics()	Retrieves a collection of topics in a service namespace.
GetTopics(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).
GetTopicsAsync()	Asynchronously retrieves a collection of topics in a service namespace.
GetTopicsAsync(String)	Asynchronously retrieves a collection of topics in a service namespace.
GetVersionInfo()	Retrieves a string of the format "YYYY-MM" that indicates the maximum supported protocol version that the server or service can handle.
GetVersionInfoAsync()	Asynchronously retrieves a string of the format "YYYY-MM" that indicates the maximum supported protocol version that the server or service can handle.
QueueExists(String)	Determines whether a queue exists in the service namespace.
QueueExistsAsync(String)	Asynchronously determines whether a queue exists in the service namespace.
RelayExists(String)	Determines whether a relay exists in the service namespace.
RelayExistsAsync(String)	Asynchronously determines whether a relay exists in the service namespace.
RenameQueue(String, String)	Renames a queue inside a namespace. This is currently NOT supported with Premium Service Bus SKU.
RenameQueueAsync(String, String)	Asynchronous version of RenameQueue(String, String). This is currently NOT supported with Premium Service Bus SKU.
RenameTopic(String, String)	Renames a topic inside a namespace. This is currently NOT supported with Premium Service Bus SKU.
RenameTopicAsync(String, String)	Asynchronous version of RenameTopic(String, String). This is currently NOT supported with Premium Service Bus SKU.
RestorePublisher(String, String)	Removes the publisher from the Event Hubs revocation list.
RestorePublisherAsync(String, String)	Asynchronous version of RestorePublisher(String, String).
RevokePublisher(String, String)	Adds the publisher to the Event Hubs revocation list.
RevokePublisherAsync(String, String)	Asynchronous version of RevokePublisher(String, String).
SubscriptionExists(String, String)	Determines whether a subscription exists in the service namespace.
SubscriptionExistsAsync(String, String)	Asynchronously determines whether a subscription exists in the service namespace.
TopicExists(String)	Determines whether a topic exists in the service namespace.
TopicExistsAsync(String)	Asynchronously determines whether a topic exists in the service namespace.
UpdateConsumerGroup(ConsumerGroupDescription)	Updates an Event Hubs consumer group.
UpdateConsumerGroupAsync(ConsumerGroupDescription)	Asynchronously updates the consumer group.
UpdateEventHub(EventHubDescription)	Updates an Event Hub.
UpdateEventHubAsync(EventHubDescription)	Asynchronously updates the event hub.
UpdateQueue(QueueDescription)	Enables you to update the queue.
UpdateQueueAsync(QueueDescription)	Asynchronously enables you to update the queue.
UpdateRelay(RelayDescription)	Upddates a relay endpoint.
UpdateRelayAsync(RelayDescription)	Asynchronously upddates a relay endpoint.
UpdateSubscription(SubscriptionDescription)	Enables you to update the subscription.
UpdateSubscriptionAsync(SubscriptionDescription)	Asynchronously enables you to update the subscription.
UpdateTopic(TopicDescription)	Enables you to update the topic.
UpdateTopicAsync(TopicDescription)	Asynchronously enables you to update the topic.