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

Syntax

Declaration

public sealed class NamespaceManagerPublic NotInheritable Class NamespaceManager

Inheritance Hierarchy

Constructors summary

Initializes a new instance of the NamespaceManager class with the given addresses.

Initializes a new instance of the NamespaceManager class with the given addresses and settings.

Initializes a new instance of the NamespaceManager class with the given addresses and token provider.

Initializes a new instance of the NamespaceManager class with the given service namespace URI base addresses.

Initializes a new instance of the NamespaceManager class with the given service namespace URI base addresses and settings.

Initializes a new instance of the NamespaceManager class with the given service namespace URI base addresses and token provider.

Initializes a new instance of the NamespaceManager class with the given service namespace address.

Initializes a new instance of the NamespaceManager class with the given service namespace base address and NamespaceManagerSettings object.

Initializes a new instance of the NamespaceManager class with the given service namespace base address and token provider.

Initializes a new instance of the NamespaceManager class with the given service namespace URI base address.

Initializes a new instance of the NamespaceManager class with the given service namespace URI base address and NamespaceManagerSettings object.

Initializes a new instance of the NamespaceManager class with the given service namespace URI base address and TokenProvider object.

Fields summary

Specifies the string of the format "YYYY-MM" that indicates the client protocol version.

Properties summary

Gets the service namespace base address.

Gets the service namespace client settings.

Methods summary

Creates a new instance of NamespaceManager.

Creates an Event Hubs consumer group using the specified ConsumerGroupDescription.

Creates an Event Hubs consumer group using default values, with the specified Event Hubs path and a name for the consumer group.

Asynchronous version of CreateConsumerGroup(ConsumerGroupDescription).

Asynchronous version of CreateConsumerGroup(String, String).

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.

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.

Asynchronous version of CreateConsumerGroupIfNotExists(ConsumerGroupDescription).

Asynchronous version of CreateConsumerGroupIfNotExists(String, String).

Creates a new Event Hub using the specified EventHubDescription.

Creates a new Event Hub using default values, for the given input path.

Asynchronously creates an event hub.

Asynchronously creates an event hub.

Creates an Event Hub if it does not exist.

Creates an Event Hub if it does not exist.

Asynchronously creates an Event Hub if it does not exist.

Asynchronously creates an Event Hub if it does not exist.

Creates a new instance of NamespaceManager using a specified connection string.

Creates a new HybridConnection in the service namespace.

Asynchronously creates a new HybridConnection in the service namespace.

Creates a new queue in the service namespace with the specified queue description.

Creates a new queue in the service namespace with the given path.

Asynchronously creates a new queue in the service namespace with the specified queue description.

Asynchronously creates a new queue in the service namespace with the given path.

Asynchronously creates a new relay in the service namespace with the specified queue description.

Asynchronously creates a new relay in the service namespace with the given path and type.

Creates a new subscription in the service namespace with the specified subscription description.

Creates a new subscription in the service namespace with the specified subscription description and filter expression.

Creates a new subscription in the service namespace with the specified subscription description and rule description.

Creates a new subscription in the service namespace with the specified topic path and subscription name.

Creates a new subscription in the service namespace with the specified topic path, subscription name, and filter expression.

Creates a new subscription in the service namespace with the specified topic path, subscription name, and rule description.

Asynchronously creates a new subscription in the service namespace with the specified subscription description.

Asynchronously creates a new subscription in the service namespace with the specified subscription description and filter expression.

Asynchronously creates a new subscription in the service namespace with the specified subscription description and rule description.

Asynchronously creates a new subscription in the service namespace with the specified topic path and subscription name.

Asynchronously creates a new subscription in the service namespace with the specified topic path, subscription name, and filter expression.

Asynchronously creates a new subscription in the service namespace with the specified topic path, subscription name, and rule description.

Creates a new topic inside the service namespace with the specified topic description.

Creates a new topic inside the service namespace with the given service namespace path.

Asynchronously creates a new topic inside the service namespace with the specified topic description.

Asynchronously creates a new topic inside the service namespace with the given service namespace path.

Deletes a consumer group.

Asynchronously deletes a consumer group.

Deletes an Event Hub.

Asynchronously deletes an Event Hub.

Deletes the HybridConnection described by the path relative to the service namespace base address.

Asynchronously deletes the HybridConnection described by the path relative to the service namespace base address.

Deletes the queue described by the path relative to the service namespace base address.

Asynchronously deletes the queue described by the path relative to the service namespace base address.

Asynchronously deletes the relay described by the path relative to the service namespace base address.

Deletes the subscription with the specified topic path and subscription name.

Asynchronously deletes the subscription with the specified topic path and subscription name.

Deletes the topic described by path relative to the service namespace base address.

Asynchronously deletes the topic described by path relative to the service namespace base address.

Indicates whether or not an Event Hub exists.

Asynchronously determines whether the event hub exists from the service namespace.

Gets an Event Hubs consumer group.

Asynchronously gets a consumer group.

Gets a collection representing a set of consumer groups.

Asynchronously gets a set of consumer groups.

Gets information about an Event Hub.

Asynchronously gets information about an Event Hub.

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.

Asynchronous version of GetEventHubPartition(String, String).

Asynchronous version of GetEventHubPartition(String, String).

Gets a collection representing a set of Event Hubs.

Asynchronously gets a list of Event Hubs.

Retrieves a HybridConnection in the service namespace with specified path.

Asynchronously retrieves a HybridConnection in the service namespace with specified path.

Retrieves a collection of all HybridConnections in the namespace.

Asynchronously retrieves a collection of all HybridConnections in the namespace.

Retrieves a queue from the service namespace.

Asynchronously retrieves a queue from the service namespace.

Retrieves an enumerable collection of all queues in the service namespace.

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

Asynchronously retrieves an enumerable collection of all queues in the service namespace.

Asynchronously retrieves an enumerable collection of all queues in the service namespace with specified filter.

Asynchronously retrieves an enumerable collection of all relays in the service namespace with specified path.

Asynchronously retrieves an enumerable collection of all relays in the service namespace.

Returns all revoked publishers in an Event Hub.

Asynchronous version of GetRevokedPublishers(String).

Retrieves an enumerable collection of all rules in the service namespace.

Retrieves an enumerable collection of all rules in the service namespace with specified topic path, subscription name and filter.

Asynchronously retrieves an enumerable collection of all rules in the service namespace.

Asynchronously retrieves an enumerable collection of all rules in the service namespace with specified topic path, subscription name and filter.

Retrieves the topic from the service namespace.

Asynchronously retrieves the topic from the service namespace.

Retrieves an enumerable collection of all subscriptions in the service namespace.

Retrieves an enumerable collection of all subscriptions in the service namespace with specified topic path and filter.

Asynchronously retrieves an enumerable collection of all subscriptions in the service namespace.

Asynchronously retrieves an enumerable collection of all subscriptions in the service namespace.

Retrieves the topic from the service namespace.

Asynchronously retrieves the topic from the service namespace.

Retrieves a collection of topics in a service namespace.

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

Asynchronously retrieves a collection of topics in a service namespace.

Asynchronously retrieves a collection of topics in a service namespace.

Retrieves a string of the format "YYYY-MM" that indicates the maximum supported protocol version that the server or service can handle.

Asynchronously retrieves a string of the format "YYYY-MM" that indicates the maximum supported protocol version that the server or service can handle.

Determines whether a HybridConnection exists in the service namespace.

Asynchronously determines whether a HybridConnection exists in the service namespace.

Determines whether a queue exists in the service namespace.

Asynchronously determines whether a queue exists in the service namespace.

Asynchronously determines whether a relay exists in the service namespace.

Renames a queue inside a namespace.

Asynchronous version of RenameQueue(String, String).

Renames a topic inside a namespace.

Asynchronous version of RenameTopic(String, String).

Removes the publisher from the Event Hubs revocation list.

Asynchronous version of RestorePublisher(String, String).

Adds the publisher to the Event Hubs revocation list.

Asynchronous version of RevokePublisher(String, String).

Determines whether a subscription exists in the service namespace.

Asynchronously determines whether a subscription exists in the service namespace.

Determines whether a topic exists in the service namespace.

Asynchronously determines whether a topic exists in the service namespace.

Updates an Event Hubs consumer group.

Asynchronously updates the consumer group.

Updates an Event Hub.

Asynchronously updates the event hub.

Updates the HybridConnection.

Asynchronously updates the HybridConnection.

Enables you to update the queue.

Asynchronously enables you to update the queue.

Asynchronously enables you to update the relay.

Enables you to update the subscription.

Asynchronously enables you to update the subscription.

Enables you to update the topic.

Asynchronously enables you to update the topic.

Constructors

  • NamespaceManager(IEnumerable<String>)
    NamespaceManager(IEnumerable(Of String))

    Initializes a new instance of the NamespaceManager class with the given addresses.

    public NamespaceManager(IEnumerable<string> addresses)Public Sub New(addresses As IEnumerable(Of String))

    Parameters

  • NamespaceManager(IEnumerable<String>, NamespaceManagerSettings)
    NamespaceManager(IEnumerable(Of String), NamespaceManagerSettings)

    Initializes a new instance of the NamespaceManager class with the given addresses and settings.

    public NamespaceManager(IEnumerable<string> addresses, NamespaceManagerSettings settings)Public Sub New(addresses As IEnumerable(Of String), settings As NamespaceManagerSettings)

    Parameters

  • NamespaceManager(IEnumerable<String>, TokenProvider)
    NamespaceManager(IEnumerable(Of String), TokenProvider)

    Initializes a new instance of the NamespaceManager class with the given addresses and token provider.

    public NamespaceManager(IEnumerable<string> addresses, TokenProvider tokenProvider)Public Sub New(addresses As IEnumerable(Of String), tokenProvider As TokenProvider)

    Parameters

  • NamespaceManager(IEnumerable<Uri>)
    NamespaceManager(IEnumerable(Of Uri))

    Initializes a new instance of the NamespaceManager class with the given service namespace URI base addresses.

    public NamespaceManager(IEnumerable<Uri> addresses)Public Sub New(addresses As IEnumerable(Of Uri))

    Parameters

  • NamespaceManager(IEnumerable<Uri>, NamespaceManagerSettings)
    NamespaceManager(IEnumerable(Of Uri), NamespaceManagerSettings)

    Initializes a new instance of the NamespaceManager class with the given service namespace URI base addresses and settings.

    public NamespaceManager(IEnumerable<Uri> addresses, NamespaceManagerSettings settings)Public Sub New(addresses As IEnumerable(Of Uri), settings As NamespaceManagerSettings)

    Parameters

  • NamespaceManager(IEnumerable<Uri>, TokenProvider)
    NamespaceManager(IEnumerable(Of Uri), TokenProvider)

    Initializes a new instance of the NamespaceManager class with the given service namespace URI base addresses and token provider.

    public NamespaceManager(IEnumerable<Uri> addresses, TokenProvider tokenProvider)Public Sub New(addresses As IEnumerable(Of Uri), tokenProvider As TokenProvider)

    Parameters

  • NamespaceManager(String)
    NamespaceManager(String)

    Initializes a new instance of the NamespaceManager class with the given service namespace address.

    public NamespaceManager(string address)Public Sub New(address As String)

    Parameters

    • address

      The full address of the service namespace.

  • NamespaceManager(String, NamespaceManagerSettings)
    NamespaceManager(String, NamespaceManagerSettings)

    Initializes a new instance of the NamespaceManager class with the given service namespace base address and NamespaceManagerSettings object.

    public NamespaceManager(string address, NamespaceManagerSettings settings)Public Sub New(address As String, settings As NamespaceManagerSettings)

    Parameters

    Exceptions

  • NamespaceManager(String, TokenProvider)
    NamespaceManager(String, TokenProvider)

    Initializes a new instance of the NamespaceManager class with the given service namespace base address and token provider.

    public NamespaceManager(string address, TokenProvider tokenProvider)Public Sub New(address As String, tokenProvider As TokenProvider)

    Parameters

    Exceptions

  • NamespaceManager(Uri)
    NamespaceManager(Uri)

    Initializes a new instance of the NamespaceManager class with the given service namespace URI base address.

    public NamespaceManager(Uri address)Public Sub New(address As Uri)

    Parameters

    • address

      The full URI address of the service namespace.

  • NamespaceManager(Uri, NamespaceManagerSettings)
    NamespaceManager(Uri, NamespaceManagerSettings)

    Initializes a new instance of the NamespaceManager class with the given service namespace URI base address and NamespaceManagerSettings object.

    public NamespaceManager(Uri address, NamespaceManagerSettings settings)Public Sub New(address As Uri, settings As NamespaceManagerSettings)

    Parameters

    Exceptions

  • NamespaceManager(Uri, TokenProvider)
    NamespaceManager(Uri, TokenProvider)

    Initializes a new instance of the NamespaceManager class with the given service namespace URI base address and TokenProvider object.

    public NamespaceManager(Uri address, TokenProvider tokenProvider)Public Sub New(address As Uri, tokenProvider As TokenProvider)

    Parameters

    Exceptions

Fields

  • ProtocolVersion
    ProtocolVersion

    Specifies the string of the format "YYYY-MM" that indicates the client protocol version.

    public const string ProtocolVersion = "2016-07"Public Const ProtocolVersion As String = "2016-07"

Properties

  • Address
    Address

    Gets the service namespace base address.

    public Uri Address { get; }Public ReadOnly Property Address As Uri

    Property Value

    • A Uri that represents the service namespace base address.

  • Settings
    Settings

    Gets the service namespace client settings.

    public NamespaceManagerSettings Settings { get; }Public ReadOnly Property Settings As NamespaceManagerSettings

    Property Value

Methods

  • Create()
    Create()

    Creates a new instance of NamespaceManager.

    public static NamespaceManager Create()Public Shared Function Create As NamespaceManager

    Returns

  • CreateConsumerGroup(ConsumerGroupDescription)
    CreateConsumerGroup(ConsumerGroupDescription)

    Creates an Event Hubs consumer group using the specified ConsumerGroupDescription.

    public ConsumerGroupDescription CreateConsumerGroup(ConsumerGroupDescription description)Public Function CreateConsumerGroup(description As ConsumerGroupDescription) As ConsumerGroupDescription

    Parameters

    Returns

  • CreateConsumerGroup(String, String)
    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.

    public ConsumerGroupDescription CreateConsumerGroup(string eventHubPath, string name)Public Function CreateConsumerGroup(eventHubPath As String, name As String) As ConsumerGroupDescription

    Parameters

    Returns

  • CreateConsumerGroupAsync(ConsumerGroupDescription)
    CreateConsumerGroupAsync(ConsumerGroupDescription)

    Asynchronous version of CreateConsumerGroup(ConsumerGroupDescription).

    public Task<ConsumerGroupDescription> CreateConsumerGroupAsync(ConsumerGroupDescription description)Public Function CreateConsumerGroupAsync(description As ConsumerGroupDescription) As Task(Of ConsumerGroupDescription)

    Parameters

    Returns

  • CreateConsumerGroupAsync(String, String)
    CreateConsumerGroupAsync(String, String)

    Asynchronous version of CreateConsumerGroup(String, String).

    public Task<ConsumerGroupDescription> CreateConsumerGroupAsync(string eventHubPath, string name)Public Function CreateConsumerGroupAsync(eventHubPath As String, name As String) As Task(Of ConsumerGroupDescription)

    Parameters

    Returns

  • CreateConsumerGroupIfNotExists(ConsumerGroupDescription)
    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.

    public ConsumerGroupDescription CreateConsumerGroupIfNotExists(ConsumerGroupDescription description)Public Function CreateConsumerGroupIfNotExists(description As ConsumerGroupDescription) As ConsumerGroupDescription

    Parameters

    Returns

  • CreateConsumerGroupIfNotExists(String, String)
    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.

    public ConsumerGroupDescription CreateConsumerGroupIfNotExists(string eventHubPath, string name)Public Function CreateConsumerGroupIfNotExists(eventHubPath As String, name As String) As ConsumerGroupDescription

    Parameters

    Returns

  • CreateConsumerGroupIfNotExistsAsync(ConsumerGroupDescription)
    CreateConsumerGroupIfNotExistsAsync(ConsumerGroupDescription)

    Asynchronous version of CreateConsumerGroupIfNotExists(ConsumerGroupDescription).

    public Task<ConsumerGroupDescription> CreateConsumerGroupIfNotExistsAsync(ConsumerGroupDescription description)Public Function CreateConsumerGroupIfNotExistsAsync(description As ConsumerGroupDescription) As Task(Of ConsumerGroupDescription)

    Parameters

    Returns

  • CreateConsumerGroupIfNotExistsAsync(String, String)
    CreateConsumerGroupIfNotExistsAsync(String, String)

    Asynchronous version of CreateConsumerGroupIfNotExists(String, String).

    public Task<ConsumerGroupDescription> CreateConsumerGroupIfNotExistsAsync(string eventHubPath, string name)Public Function CreateConsumerGroupIfNotExistsAsync(eventHubPath As String, name As String) As Task(Of ConsumerGroupDescription)

    Parameters

    Returns

  • CreateEventHub(EventHubDescription)
    CreateEventHub(EventHubDescription)

    Creates a new Event Hub using the specified EventHubDescription.

    public EventHubDescription CreateEventHub(EventHubDescription description)Public Function CreateEventHub(description As EventHubDescription) As EventHubDescription

    Parameters

    Returns

  • CreateEventHub(String)
    CreateEventHub(String)

    Creates a new Event Hub using default values, for the given input path.

    public EventHubDescription CreateEventHub(string path)Public Function CreateEventHub(path As String) As EventHubDescription

    Parameters

    Returns

  • CreateEventHubAsync(EventHubDescription)
    CreateEventHubAsync(EventHubDescription)

    Asynchronously creates an event hub.

    public Task<EventHubDescription> CreateEventHubAsync(EventHubDescription description)Public Function CreateEventHubAsync(description As EventHubDescription) As Task(Of EventHubDescription)

    Parameters

    Returns

  • CreateEventHubAsync(String)
    CreateEventHubAsync(String)

    Asynchronously creates an event hub.

    public Task<EventHubDescription> CreateEventHubAsync(string path)Public Function CreateEventHubAsync(path As String) As Task(Of EventHubDescription)

    Parameters

    Returns

  • CreateEventHubIfNotExists(EventHubDescription)
    CreateEventHubIfNotExists(EventHubDescription)

    Creates an Event Hub if it does not exist.

    public EventHubDescription CreateEventHubIfNotExists(EventHubDescription description)Public Function CreateEventHubIfNotExists(description As EventHubDescription) As EventHubDescription

    Parameters

    Returns

  • CreateEventHubIfNotExists(String)
    CreateEventHubIfNotExists(String)

    Creates an Event Hub if it does not exist.

    public EventHubDescription CreateEventHubIfNotExists(string path)Public Function CreateEventHubIfNotExists(path As String) As EventHubDescription

    Parameters

    Returns

  • CreateEventHubIfNotExistsAsync(EventHubDescription)
    CreateEventHubIfNotExistsAsync(EventHubDescription)

    Asynchronously creates an Event Hub if it does not exist.

    public Task<EventHubDescription> CreateEventHubIfNotExistsAsync(EventHubDescription description)Public Function CreateEventHubIfNotExistsAsync(description As EventHubDescription) As Task(Of EventHubDescription)

    Parameters

    Returns

  • CreateEventHubIfNotExistsAsync(String)
    CreateEventHubIfNotExistsAsync(String)

    Asynchronously creates an Event Hub if it does not exist.

    public Task<EventHubDescription> CreateEventHubIfNotExistsAsync(string path)Public Function CreateEventHubIfNotExistsAsync(path As String) As Task(Of EventHubDescription)

    Parameters

    Returns

  • CreateFromConnectionString(String)
    CreateFromConnectionString(String)

    Creates a new instance of NamespaceManager using a specified connection string.

    public static NamespaceManager CreateFromConnectionString(string connectionString)Public Shared Function CreateFromConnectionString(connectionString As String) As NamespaceManager

    Parameters

    Returns

  • CreateHybridConnection(HybridConnectionDescription)
    CreateHybridConnection(HybridConnectionDescription)

    Creates a new HybridConnection in the service namespace.

    public HybridConnectionDescription CreateHybridConnection(HybridConnectionDescription hybridConnection)Public Function CreateHybridConnection(hybridConnection As HybridConnectionDescription) As HybridConnectionDescription

    Parameters

    Returns

  • CreateHybridConnectionAsync(HybridConnectionDescription)
    CreateHybridConnectionAsync(HybridConnectionDescription)

    Asynchronously creates a new HybridConnection in the service namespace.

    public Task<HybridConnectionDescription> CreateHybridConnectionAsync(HybridConnectionDescription hybridConnection)Public Function CreateHybridConnectionAsync(hybridConnection As HybridConnectionDescription) As Task(Of HybridConnectionDescription)

    Parameters

    Returns

  • CreateQueue(QueueDescription)
    CreateQueue(QueueDescription)

    Creates a new queue in the service namespace with the specified queue description.

    public QueueDescription CreateQueue(QueueDescription description)Public Function CreateQueue(description As QueueDescription) As QueueDescription

    Parameters

    Returns

  • CreateQueue(String)
    CreateQueue(String)

    Creates a new queue in the service namespace with the given path.

    public QueueDescription CreateQueue(string path)Public Function CreateQueue(path As String) As QueueDescription

    Parameters

    • path

      The path of the queue relative to the service namespace base address.

    Returns

    Exceptions

  • CreateQueueAsync(QueueDescription)
    CreateQueueAsync(QueueDescription)

    Asynchronously creates a new queue in the service namespace with the specified queue description.

    public Task<QueueDescription> CreateQueueAsync(QueueDescription description)Public Function CreateQueueAsync(description As QueueDescription) As Task(Of QueueDescription)

    Parameters

    Returns

  • CreateQueueAsync(String)
    CreateQueueAsync(String)

    Asynchronously creates a new queue in the service namespace with the given path.

    public Task<QueueDescription> CreateQueueAsync(string path)Public Function CreateQueueAsync(path As String) As Task(Of QueueDescription)

    Parameters

    • path

      The path of the queue relative to the service namespace base address.

    Returns

  • CreateRelay(RelayDescription)
    CreateRelay(RelayDescription)
    public RelayDescription CreateRelay(RelayDescription description)Public Function CreateRelay(description As RelayDescription) As RelayDescription

    Parameters

    Returns

  • CreateRelay(String, RelayType)
    CreateRelay(String, RelayType)
    public RelayDescription CreateRelay(string path, RelayType type)Public Function CreateRelay(path As String, type As RelayType) As RelayDescription

    Parameters

    Returns

  • CreateRelayAsync(RelayDescription)
    CreateRelayAsync(RelayDescription)

    Asynchronously creates a new relay in the service namespace with the specified queue description.

    public Task<RelayDescription> CreateRelayAsync(RelayDescription description)Public Function CreateRelayAsync(description As RelayDescription) As Task(Of RelayDescription)

    Parameters

    Returns

  • CreateRelayAsync(String, RelayType)
    CreateRelayAsync(String, RelayType)

    Asynchronously creates a new relay in the service namespace with the given path and type.

    public Task<RelayDescription> CreateRelayAsync(string path, RelayType type)Public Function CreateRelayAsync(path As String, type As RelayType) As Task(Of RelayDescription)

    Parameters

    Returns

  • CreateSubscription(SubscriptionDescription)
    CreateSubscription(SubscriptionDescription)

    Creates a new subscription in the service namespace with the specified subscription description.

    public SubscriptionDescription CreateSubscription(SubscriptionDescription description)Public Function CreateSubscription(description As SubscriptionDescription) As SubscriptionDescription

    Parameters

    Returns

  • CreateSubscription(SubscriptionDescription, Filter)
    CreateSubscription(SubscriptionDescription, Filter)

    Creates a new subscription in the service namespace with the specified subscription description and filter expression.

    public SubscriptionDescription CreateSubscription(SubscriptionDescription description, Filter filter)Public Function CreateSubscription(description As SubscriptionDescription, filter As Filter) As SubscriptionDescription

    Parameters

    Returns

  • CreateSubscription(SubscriptionDescription, RuleDescription)
    CreateSubscription(SubscriptionDescription, RuleDescription)

    Creates a new subscription in the service namespace with the specified subscription description and rule description.

    public SubscriptionDescription CreateSubscription(SubscriptionDescription description, RuleDescription ruleDescription)Public Function CreateSubscription(description As SubscriptionDescription, ruleDescription As RuleDescription) As SubscriptionDescription

    Parameters

    Returns

  • CreateSubscription(String, String)
    CreateSubscription(String, String)

    Creates a new subscription in the service namespace with the specified topic path and subscription name.

    public SubscriptionDescription CreateSubscription(string topicPath, string name)Public Function CreateSubscription(topicPath As String, name As String) As SubscriptionDescription

    Parameters

    • topicPath

      The topic path relative to the service namespace base address.

    • name

      The name of the subscription.

    Returns

  • CreateSubscription(String, String, Filter)
    CreateSubscription(String, String, Filter)

    Creates a new subscription in the service namespace with the specified topic path, subscription name, and filter expression.

    public SubscriptionDescription CreateSubscription(string topicPath, string name, Filter filter)Public Function CreateSubscription(topicPath As String, name As String, filter As Filter) As SubscriptionDescription

    Parameters

    • topicPath

      The topic path relative to the service namespace base address.

    • name

      The name of the subscription.

    • filter

      The filter expression used to capture messages satisfying the filtering expression value.

    Returns

  • CreateSubscription(String, String, RuleDescription)
    CreateSubscription(String, String, RuleDescription)

    Creates a new subscription in the service namespace with the specified topic path, subscription name, and rule description.

    public SubscriptionDescription CreateSubscription(string topicPath, string name, RuleDescription ruleDescription)Public Function CreateSubscription(topicPath As String, name As String, ruleDescription As RuleDescription) As SubscriptionDescription

    Parameters

    Returns

  • CreateSubscriptionAsync(SubscriptionDescription)
    CreateSubscriptionAsync(SubscriptionDescription)

    Asynchronously creates a new subscription in the service namespace with the specified subscription description.

    public Task<SubscriptionDescription> CreateSubscriptionAsync(SubscriptionDescription description)Public Function CreateSubscriptionAsync(description As SubscriptionDescription) As Task(Of SubscriptionDescription)

    Parameters

    Returns

  • CreateSubscriptionAsync(SubscriptionDescription, Filter)
    CreateSubscriptionAsync(SubscriptionDescription, Filter)

    Asynchronously creates a new subscription in the service namespace with the specified subscription description and filter expression.

    public Task<SubscriptionDescription> CreateSubscriptionAsync(SubscriptionDescription description, Filter filter)Public Function CreateSubscriptionAsync(description As SubscriptionDescription, filter As Filter) As Task(Of SubscriptionDescription)

    Parameters

    Returns

  • CreateSubscriptionAsync(SubscriptionDescription, RuleDescription)
    CreateSubscriptionAsync(SubscriptionDescription, RuleDescription)

    Asynchronously creates a new subscription in the service namespace with the specified subscription description and rule description.

    public Task<SubscriptionDescription> CreateSubscriptionAsync(SubscriptionDescription description, RuleDescription ruleDescription)Public Function CreateSubscriptionAsync(description As SubscriptionDescription, ruleDescription As RuleDescription) As Task(Of SubscriptionDescription)

    Parameters

    Returns

  • CreateSubscriptionAsync(String, String)
    CreateSubscriptionAsync(String, String)

    Asynchronously creates a new subscription in the service namespace with the specified topic path and subscription name.

    public Task<SubscriptionDescription> CreateSubscriptionAsync(string topicPath, string name)Public Function CreateSubscriptionAsync(topicPath As String, name As String) As Task(Of SubscriptionDescription)

    Parameters

    • topicPath

      The topic path relative to the service namespace base address.

    • name

      The name of the subscription.

    Returns

  • CreateSubscriptionAsync(String, String, Filter)
    CreateSubscriptionAsync(String, String, Filter)

    Asynchronously creates a new subscription in the service namespace with the specified topic path, subscription name, and filter expression.

    public Task<SubscriptionDescription> CreateSubscriptionAsync(string topicPath, string name, Filter filter)Public Function CreateSubscriptionAsync(topicPath As String, name As String, filter As Filter) As Task(Of SubscriptionDescription)

    Parameters

    • topicPath

      The topic path relative to the service namespace base address.

    • name

      The name of the subscription.

    • filter

      The filter expression used to capture messages satisfying the filtering expression value.

    Returns

  • CreateSubscriptionAsync(String, String, RuleDescription)
    CreateSubscriptionAsync(String, String, RuleDescription)

    Asynchronously creates a new subscription in the service namespace with the specified topic path, subscription name, and rule description.

    public Task<SubscriptionDescription> CreateSubscriptionAsync(string topicPath, string name, RuleDescription ruleDescription)Public Function CreateSubscriptionAsync(topicPath As String, name As String, ruleDescription As RuleDescription) As Task(Of SubscriptionDescription)

    Parameters

    Returns

  • CreateTopic(TopicDescription)
    CreateTopic(TopicDescription)

    Creates a new topic inside the service namespace with the specified topic description.

    public TopicDescription CreateTopic(TopicDescription description)Public Function CreateTopic(description As TopicDescription) As TopicDescription

    Parameters

    Returns

  • CreateTopic(String)
    CreateTopic(String)

    Creates a new topic inside the service namespace with the given service namespace path.

    public TopicDescription CreateTopic(string path)Public Function CreateTopic(path As String) As TopicDescription

    Parameters

    • path

      The path of the topic relative to the service namespace base address.

    Returns

    Exceptions

  • CreateTopicAsync(TopicDescription)
    CreateTopicAsync(TopicDescription)

    Asynchronously creates a new topic inside the service namespace with the specified topic description.

    public Task<TopicDescription> CreateTopicAsync(TopicDescription description)Public Function CreateTopicAsync(description As TopicDescription) As Task(Of TopicDescription)

    Parameters

    Returns

  • CreateTopicAsync(String)
    CreateTopicAsync(String)

    Asynchronously creates a new topic inside the service namespace with the given service namespace path.

    public Task<TopicDescription> CreateTopicAsync(string path)Public Function CreateTopicAsync(path As String) As Task(Of TopicDescription)

    Parameters

    • path

      The path of the topic relative to the service namespace base address.

    Returns

  • DeleteConsumerGroup(String, String)
    DeleteConsumerGroup(String, String)

    Deletes a consumer group.

    public void DeleteConsumerGroup(string eventHubPath, string name)Public Sub DeleteConsumerGroup(eventHubPath As String, name As String)

    Parameters

  • DeleteConsumerGroupAsync(String, String)
    DeleteConsumerGroupAsync(String, String)

    Asynchronously deletes a consumer group.

    public Task DeleteConsumerGroupAsync(string eventHubPath, string name)Public Function DeleteConsumerGroupAsync(eventHubPath As String, name As String) As Task

    Parameters

    Returns

    • The task that represents the asynchronous operation.

  • DeleteEventHub(String)
    DeleteEventHub(String)

    Deletes an Event Hub.

    public void DeleteEventHub(string path)Public Sub DeleteEventHub(path As String)

    Parameters

  • DeleteEventHubAsync(String)
    DeleteEventHubAsync(String)

    Asynchronously deletes an Event Hub.

    public Task DeleteEventHubAsync(string path)Public Function DeleteEventHubAsync(path As String) As Task

    Parameters

    Returns

    • The task that represents the asynchronous operation.

  • DeleteHybridConnection(String)
    DeleteHybridConnection(String)

    Deletes the HybridConnection described by the path relative to the service namespace base address.

    public void DeleteHybridConnection(string path)Public Sub DeleteHybridConnection(path As String)

    Parameters

    • path

      The path of the HybridConnection relative to the service namespace base address.

  • DeleteHybridConnectionAsync(String)
    DeleteHybridConnectionAsync(String)

    Asynchronously deletes the HybridConnection described by the path relative to the service namespace base address.

    public Task DeleteHybridConnectionAsync(string path)Public Function DeleteHybridConnectionAsync(path As String) As Task

    Parameters

    • path

      The relative path of the HybridConnection.

    Returns

  • DeleteQueue(String)
    DeleteQueue(String)

    Deletes the queue described by the path relative to the service namespace base address.

    public void DeleteQueue(string path)Public Sub DeleteQueue(path As String)

    Parameters

    • path

      The path of the queue relative to the service namespace base address.

    Exceptions

  • DeleteQueueAsync(String)
    DeleteQueueAsync(String)

    Asynchronously deletes the queue described by the path relative to the service namespace base address.

    public Task DeleteQueueAsync(string path)Public Function DeleteQueueAsync(path As String) As Task

    Parameters

    • path

      The path of the queue relative to the service namespace base address.

    Returns

    • The asynchronous delete queue operation.

  • DeleteRelay(String)
    DeleteRelay(String)
    public void DeleteRelay(string path)Public Sub DeleteRelay(path As String)

    Parameters

  • DeleteRelayAsync(String)
    DeleteRelayAsync(String)

    Asynchronously deletes the relay described by the path relative to the service namespace base address.

    public Task DeleteRelayAsync(string path)Public Function DeleteRelayAsync(path As String) As Task

    Parameters

    • path

      The path of the relay relative to the service namespace base address.

    Returns

    • The asynchronous delete relay operation.

  • DeleteSubscription(String, String)
    DeleteSubscription(String, String)

    Deletes the subscription with the specified topic path and subscription name.

    public void DeleteSubscription(string topicPath, string name)Public Sub DeleteSubscription(topicPath As String, name As String)

    Parameters

    • topicPath

      The topic path relative to the service namespace base address.

    • name

      The name of the subscription to delete.

  • DeleteSubscriptionAsync(String, String)
    DeleteSubscriptionAsync(String, String)

    Asynchronously deletes the subscription with the specified topic path and subscription name.

    public Task DeleteSubscriptionAsync(string topicPath, string name)Public Function DeleteSubscriptionAsync(topicPath As String, name As String) As Task

    Parameters

    • topicPath

      The topic path relative to the service namespace base address.

    • name

      The name of the subscription to delete.

    Returns

    • The asynchronous delete subscription operation.

  • DeleteTopic(String)
    DeleteTopic(String)

    Deletes the topic described by path relative to the service namespace base address.

    public void DeleteTopic(string path)Public Sub DeleteTopic(path As String)

    Parameters

    • path

      The path of the topic relative to the service namespace base address.

    Exceptions

  • DeleteTopicAsync(String)
    DeleteTopicAsync(String)

    Asynchronously deletes the topic described by path relative to the service namespace base address.

    public Task DeleteTopicAsync(string path)Public Function DeleteTopicAsync(path As String) As Task

    Parameters

    • path

      The path of the topic relative to the service namespace base address.

    Returns

    • The asynchronous deleted topic operation.

  • EventHubExists(String)
    EventHubExists(String)

    Indicates whether or not an Event Hub exists.

    public bool EventHubExists(string path)Public Function EventHubExists(path As String) As Boolean

    Parameters

    Returns

    • Returns true if the Event Hub exists; otherwise, false.

  • EventHubExistsAsync(String)
    EventHubExistsAsync(String)

    Asynchronously determines whether the event hub exists from the service namespace.

    public Task<bool> EventHubExistsAsync(string path)Public Function EventHubExistsAsync(path As String) As Task(Of Boolean)

    Parameters

    Returns

  • GetConsumerGroup(String, String)
    GetConsumerGroup(String, String)

    Gets an Event Hubs consumer group.

    public ConsumerGroupDescription GetConsumerGroup(string eventHubPath, string name)Public Function GetConsumerGroup(eventHubPath As String, name As String) As ConsumerGroupDescription

    Parameters

    Returns

  • GetConsumerGroupAsync(String, String)
    GetConsumerGroupAsync(String, String)

    Asynchronously gets a consumer group.

    public Task<ConsumerGroupDescription> GetConsumerGroupAsync(string eventHubPath, string name)Public Function GetConsumerGroupAsync(eventHubPath As String, name As String) As Task(Of ConsumerGroupDescription)

    Parameters

    Returns

  • GetConsumerGroups(String)
    GetConsumerGroups(String)

    Gets a collection representing a set of consumer groups.

    public IEnumerable<ConsumerGroupDescription> GetConsumerGroups(string eventHubPath)Public Function GetConsumerGroups(eventHubPath As String) As IEnumerable(Of ConsumerGroupDescription)

    Parameters

    Returns

  • GetConsumerGroupsAsync(String)
    GetConsumerGroupsAsync(String)

    Asynchronously gets a set of consumer groups.

    public Task<IEnumerable<ConsumerGroupDescription>> GetConsumerGroupsAsync(string eventHubPath)Public Function GetConsumerGroupsAsync(eventHubPath As String) As Task(Of IEnumerable(Of ConsumerGroupDescription))

    Parameters

    Returns

  • GetEventHub(String)
    GetEventHub(String)

    Gets information about an Event Hub.

    public EventHubDescription GetEventHub(string path)Public Function GetEventHub(path As String) As EventHubDescription

    Parameters

    Returns

  • GetEventHubAsync(String)
    GetEventHubAsync(String)

    Asynchronously gets information about an Event Hub.

    public Task<EventHubDescription> GetEventHubAsync(string path)Public Function GetEventHubAsync(path As String) As Task(Of EventHubDescription)

    Parameters

    Returns

  • GetEventHubPartition(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.

    public PartitionDescription GetEventHubPartition(string eventHubPath, string name)Public Function GetEventHubPartition(eventHubPath As String, name As String) As PartitionDescription

    Parameters

    Returns

  • GetEventHubPartition(String, String, String)
    GetEventHubPartition(String, String, String)
    public PartitionDescription GetEventHubPartition(string eventHubPath, string consumerGroupName, string name)Public Function GetEventHubPartition(eventHubPath As String, consumerGroupName As String, name As String) As PartitionDescription

    Parameters

    Returns

  • GetEventHubPartitionAsync(String, String)
    GetEventHubPartitionAsync(String, String)

    Asynchronous version of GetEventHubPartition(String, String).

    public Task<PartitionDescription> GetEventHubPartitionAsync(string eventHubPath, string name)Public Function GetEventHubPartitionAsync(eventHubPath As String, name As String) As Task(Of PartitionDescription)

    Parameters

    Returns

  • GetEventHubPartitionAsync(String, String, String)
    GetEventHubPartitionAsync(String, String, String)

    Asynchronous version of GetEventHubPartition(String, String).

    public Task<PartitionDescription> GetEventHubPartitionAsync(string eventHubPath, string consumerGroupName, string name)Public Function GetEventHubPartitionAsync(eventHubPath As String, consumerGroupName As String, name As String) As Task(Of PartitionDescription)

    Parameters

    • eventHubPath

      The path to the Event Hub.

    • consumerGroupName

      The name of the Event Hubs consumer group.

    • name

      The ID of the Event Hubs partition.

    Returns

  • GetEventHubs()
    GetEventHubs()

    Gets a collection representing a set of Event Hubs.

    public IEnumerable<EventHubDescription> GetEventHubs()Public Function GetEventHubs As IEnumerable(Of EventHubDescription)

    Returns

  • GetEventHubsAsync()
    GetEventHubsAsync()

    Asynchronously gets a list of Event Hubs.

    public Task<IEnumerable<EventHubDescription>> GetEventHubsAsync()Public Function GetEventHubsAsync As Task(Of IEnumerable(Of EventHubDescription))

    Returns

  • GetHybridConnection(String)
    GetHybridConnection(String)

    Retrieves a HybridConnection in the service namespace with specified path.

    public HybridConnectionDescription GetHybridConnection(string path)Public Function GetHybridConnection(path As String) As HybridConnectionDescription

    Parameters

    • path

      The relative path of the HybridConnection.

    Returns

  • GetHybridConnectionAsync(String)
    GetHybridConnectionAsync(String)

    Asynchronously retrieves a HybridConnection in the service namespace with specified path.

    public Task<HybridConnectionDescription> GetHybridConnectionAsync(string path)Public Function GetHybridConnectionAsync(path As String) As Task(Of HybridConnectionDescription)

    Parameters

    • path

      The relative path of the HybridConnection.

    Returns

  • GetHybridConnections()
    GetHybridConnections()

    Retrieves a collection of all HybridConnections in the namespace.

    public IEnumerable<HybridConnectionDescription> GetHybridConnections()Public Function GetHybridConnections As IEnumerable(Of HybridConnectionDescription)

    Returns

  • GetHybridConnectionsAsync()
    GetHybridConnectionsAsync()

    Asynchronously retrieves a collection of all HybridConnections in the namespace.

    public Task<IEnumerable<HybridConnectionDescription>> GetHybridConnectionsAsync()Public Function GetHybridConnectionsAsync As Task(Of IEnumerable(Of HybridConnectionDescription))

    Returns

  • GetQueue(String)
    GetQueue(String)

    Retrieves a queue from the service namespace.

    public QueueDescription GetQueue(string path)Public Function GetQueue(path As String) As QueueDescription

    Parameters

    • path

      The path of the queue relative to the service namespace base address.

    Returns

    Exceptions

  • GetQueueAsync(String)
    GetQueueAsync(String)

    Asynchronously retrieves a queue from the service namespace.

    public Task<QueueDescription> GetQueueAsync(string path)Public Function GetQueueAsync(path As String) As Task(Of QueueDescription)

    Parameters

    • path

      The path of the queue relative to the service namespace base address.

    Returns

  • GetQueues()
    GetQueues()

    Retrieves an enumerable collection of all queues in the service namespace.

    public IEnumerable<QueueDescription> GetQueues()Public Function GetQueues As IEnumerable(Of QueueDescription)

    Returns

    Exceptions

  • GetQueues(String)
    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).

    public IEnumerable<QueueDescription> GetQueues(string filter)Public Function GetQueues(filter As String) As IEnumerable(Of QueueDescription)

    Parameters

    • filter

      A string used to filter the queues to be retrieved.

    Returns

  • GetQueuesAsync()
    GetQueuesAsync()

    Asynchronously retrieves an enumerable collection of all queues in the service namespace.

    public Task<IEnumerable<QueueDescription>> GetQueuesAsync()Public Function GetQueuesAsync As Task(Of IEnumerable(Of QueueDescription))

    Returns

  • GetQueuesAsync(String)
    GetQueuesAsync(String)

    Asynchronously retrieves an enumerable collection of all queues in the service namespace with specified filter.

    public Task<IEnumerable<QueueDescription>> GetQueuesAsync(string filter)Public Function GetQueuesAsync(filter As String) As Task(Of IEnumerable(Of QueueDescription))

    Parameters

    • filter

      The string used to filter the queues to be retrieved.

    Returns

  • GetRelay(String)
    GetRelay(String)
    public RelayDescription GetRelay(string path)Public Function GetRelay(path As String) As RelayDescription

    Parameters

    Returns

  • GetRelayAsync(String)
    GetRelayAsync(String)

    Asynchronously retrieves an enumerable collection of all relays in the service namespace with specified path.

    public Task<RelayDescription> GetRelayAsync(string path)Public Function GetRelayAsync(path As String) As Task(Of RelayDescription)

    Parameters

    Returns

  • GetRelays()
    GetRelays()
    public IEnumerable<RelayDescription> GetRelays()Public Function GetRelays As IEnumerable(Of RelayDescription)

    Returns

  • GetRelaysAsync()
    GetRelaysAsync()

    Asynchronously retrieves an enumerable collection of all relays in the service namespace.

    public Task<IEnumerable<RelayDescription>> GetRelaysAsync()Public Function GetRelaysAsync As Task(Of IEnumerable(Of RelayDescription))

    Returns

  • GetRevokedPublishers(String)
    GetRevokedPublishers(String)

    Returns all revoked publishers in an Event Hub.

    public IEnumerable<RevokedPublisherDescription> GetRevokedPublishers(string entityPath)Public Function GetRevokedPublishers(entityPath As String) As IEnumerable(Of RevokedPublisherDescription)

    Parameters

    Returns

  • GetRevokedPublishersAsync(String)
    GetRevokedPublishersAsync(String)

    Asynchronous version of GetRevokedPublishers(String).

    public Task<IEnumerable<RevokedPublisherDescription>> GetRevokedPublishersAsync(string entityPath)Public Function GetRevokedPublishersAsync(entityPath As String) As Task(Of IEnumerable(Of RevokedPublisherDescription))

    Parameters

    Returns

  • GetRules(String, String)
    GetRules(String, String)

    Retrieves an enumerable collection of all rules in the service namespace.

    public IEnumerable<RuleDescription> GetRules(string topicPath, string subscriptionName)Public Function GetRules(topicPath As String, subscriptionName As String) As IEnumerable(Of RuleDescription)

    Parameters

    • topicPath

      The path of the topic relative to the service namespace base address.

    • subscriptionName

      The name of the subscription.

    Returns

  • GetRules(String, String, String)
    GetRules(String, String, String)

    Retrieves an enumerable collection of all rules in the service namespace with specified topic path, subscription name and filter.

    public IEnumerable<RuleDescription> GetRules(string topicPath, string subscriptionName, string filter)Public Function GetRules(topicPath As String, subscriptionName As String, filter As String) As IEnumerable(Of RuleDescription)

    Parameters

    • topicPath

      The topic path relative to the service namespace base address.

    • subscriptionName

      The name of the subscription.

    • filter

      The string used to filter the rules to be retrieved.

    Returns

  • GetRulesAsync(String, String)
    GetRulesAsync(String, String)

    Asynchronously retrieves an enumerable collection of all rules in the service namespace.

    public Task<IEnumerable<RuleDescription>> GetRulesAsync(string topicPath, string subscriptionName)Public Function GetRulesAsync(topicPath As String, subscriptionName As String) As Task(Of IEnumerable(Of RuleDescription))

    Parameters

    • topicPath

      The topic path relative to the service namespace base address.

    • subscriptionName

      The name of the subscription.

    Returns

  • GetRulesAsync(String, String, String)
    GetRulesAsync(String, String, String)

    Asynchronously retrieves an enumerable collection of all rules in the service namespace with specified topic path, subscription name and filter.

    public Task<IEnumerable<RuleDescription>> GetRulesAsync(string topicPath, string subscriptionName, string filter)Public Function GetRulesAsync(topicPath As String, subscriptionName As String, filter As String) As Task(Of IEnumerable(Of RuleDescription))

    Parameters

    • topicPath

      The topic path relative to the service namespace base address.

    • subscriptionName

      The name of the subscription.

    • filter

      The string used to filter the rules to be retrieved.

    Returns

  • GetSubscription(String, String)
    GetSubscription(String, String)

    Retrieves the topic from the service namespace.

    public SubscriptionDescription GetSubscription(string topicPath, string name)Public Function GetSubscription(topicPath As String, name As String) As SubscriptionDescription

    Parameters

    • topicPath

      The path of the topic relative to the service namespace base address.

    • name

      The name of the subscription.

    Returns

    Exceptions

  • GetSubscriptionAsync(String, String)
    GetSubscriptionAsync(String, String)

    Asynchronously retrieves the topic from the service namespace.

    public Task<SubscriptionDescription> GetSubscriptionAsync(string topicPath, string name)Public Function GetSubscriptionAsync(topicPath As String, name As String) As Task(Of SubscriptionDescription)

    Parameters

    • topicPath

      The path of the topic relative to the service namespace base address.

    • name

      The name of the subscription.

    Returns

  • GetSubscriptions(String)
    GetSubscriptions(String)

    Retrieves an enumerable collection of all subscriptions in the service namespace.

    public IEnumerable<SubscriptionDescription> GetSubscriptions(string topicPath)Public Function GetSubscriptions(topicPath As String) As IEnumerable(Of SubscriptionDescription)

    Parameters

    • topicPath

      The path of the topic relative to the service namespace base address.

    Returns

  • GetSubscriptions(String, String)
    GetSubscriptions(String, String)

    Retrieves an enumerable collection of all subscriptions in the service namespace with specified topic path and filter.

    public IEnumerable<SubscriptionDescription> GetSubscriptions(string topicPath, string filter)Public Function GetSubscriptions(topicPath As String, filter As String) As IEnumerable(Of SubscriptionDescription)

    Parameters

    • topicPath

      The path of the topic relative to the service namespace base address.

    • filter

      The string used to filter the subscriptions to be retrieved.

    Returns

  • GetSubscriptionsAsync(String)
    GetSubscriptionsAsync(String)

    Asynchronously retrieves an enumerable collection of all subscriptions in the service namespace.

    public Task<IEnumerable<SubscriptionDescription>> GetSubscriptionsAsync(string topicPath)Public Function GetSubscriptionsAsync(topicPath As String) As Task(Of IEnumerable(Of SubscriptionDescription))

    Parameters

    • topicPath

      The path of the topic relative to the service namespace base address.

    Returns

  • GetSubscriptionsAsync(String, String)
    GetSubscriptionsAsync(String, String)

    Asynchronously retrieves an enumerable collection of all subscriptions in the service namespace.

    public Task<IEnumerable<SubscriptionDescription>> GetSubscriptionsAsync(string topicPath, string filter)Public Function GetSubscriptionsAsync(topicPath As String, filter As String) As Task(Of IEnumerable(Of SubscriptionDescription))

    Parameters

    • topicPath

      The path of the topic relative to the service namespace base address.

    • filter

      The string used to filter the subscriptions to be retrieved.

    Returns

  • GetTopic(String)
    GetTopic(String)

    Retrieves the topic from the service namespace.

    public TopicDescription GetTopic(string path)Public Function GetTopic(path As String) As TopicDescription

    Parameters

    • path

      The path of the topic relative to the service namespace base address.

    Returns

    Exceptions

  • GetTopicAsync(String)
    GetTopicAsync(String)

    Asynchronously retrieves the topic from the service namespace.

    public Task<TopicDescription> GetTopicAsync(string path)Public Function GetTopicAsync(path As String) As Task(Of TopicDescription)

    Parameters

    • path

      The path of the topic relative to the service namespace base address.

    Returns

  • GetTopics()
    GetTopics()

    Retrieves a collection of topics in a service namespace.

    public IEnumerable<TopicDescription> GetTopics()Public Function GetTopics As IEnumerable(Of TopicDescription)

    Returns

    Exceptions

  • GetTopics(String)
    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).

    public IEnumerable<TopicDescription> GetTopics(string filter)Public Function GetTopics(filter As String) As IEnumerable(Of TopicDescription)

    Parameters

    • filter

      The string used to filter the topics to be retrieved.

    Returns

  • GetTopicsAsync()
    GetTopicsAsync()

    Asynchronously retrieves a collection of topics in a service namespace.

    public Task<IEnumerable<TopicDescription>> GetTopicsAsync()Public Function GetTopicsAsync As Task(Of IEnumerable(Of TopicDescription))

    Returns

  • GetTopicsAsync(String)
    GetTopicsAsync(String)

    Asynchronously retrieves a collection of topics in a service namespace.

    public Task<IEnumerable<TopicDescription>> GetTopicsAsync(string filter)Public Function GetTopicsAsync(filter As String) As Task(Of IEnumerable(Of TopicDescription))

    Parameters

    • filter

      The string used to filter the topics to be retrieved.

    Returns

  • GetVersionInfo()
    GetVersionInfo()

    Retrieves a string of the format "YYYY-MM" that indicates the maximum supported protocol version that the server or service can handle.

    public string GetVersionInfo()Public Function GetVersionInfo As String

    Returns

    • A string that indicates the maximum supported protocol version that the server or service can handle.

  • GetVersionInfoAsync()
    GetVersionInfoAsync()

    Asynchronously retrieves a string of the format "YYYY-MM" that indicates the maximum supported protocol version that the server or service can handle.

    public Task<string> GetVersionInfoAsync()Public Function GetVersionInfoAsync As Task(Of String)

    Returns

  • HybridConnectionExists(String)
    HybridConnectionExists(String)

    Determines whether a HybridConnection exists in the service namespace.

    public bool HybridConnectionExists(string path)Public Function HybridConnectionExists(path As String) As Boolean

    Parameters

    • path

      The relative path of the HybridConnection.

    Returns

  • HybridConnectionExistsAsync(String)
    HybridConnectionExistsAsync(String)

    Asynchronously determines whether a HybridConnection exists in the service namespace.

    public Task<bool> HybridConnectionExistsAsync(string path)Public Function HybridConnectionExistsAsync(path As String) As Task(Of Boolean)

    Parameters

    • path

      The relative path of the HybridConnection.

    Returns

  • QueueExists(String)
    QueueExists(String)

    Determines whether a queue exists in the service namespace.

    public bool QueueExists(string path)Public Function QueueExists(path As String) As Boolean

    Parameters

    • path

      The path of the queue relative to the service namespace base address.

    Returns

    • true if a queue exists in the service namespace; otherwise, false.

  • QueueExistsAsync(String)
    QueueExistsAsync(String)

    Asynchronously determines whether a queue exists in the service namespace.

    public Task<bool> QueueExistsAsync(string path)Public Function QueueExistsAsync(path As String) As Task(Of Boolean)

    Parameters

    • path

      The path of the queue relative to the service namespace base address.

    Returns

  • RelayExists(String)
    RelayExists(String)
    public bool RelayExists(string path)Public Function RelayExists(path As String) As Boolean

    Parameters

    Returns

  • RelayExistsAsync(String)
    RelayExistsAsync(String)

    Asynchronously determines whether a relay exists in the service namespace.

    public Task<bool> RelayExistsAsync(string path)Public Function RelayExistsAsync(path As String) As Task(Of Boolean)

    Parameters

    • path

      The path of the relay relative to the service namespace base address.

    Returns

  • RenameQueue(String, String)
    RenameQueue(String, String)

    Renames a queue inside a namespace.

    public QueueDescription RenameQueue(string path, string newPath)Public Function RenameQueue(path As String, newPath As String) As QueueDescription

    Parameters

    Returns

    Exceptions

  • RenameQueueAsync(String, String)
    RenameQueueAsync(String, String)

    Asynchronous version of RenameQueue(String, String).

    public Task<QueueDescription> RenameQueueAsync(string path, string newPath)Public Function RenameQueueAsync(path As String, newPath As String) As Task(Of QueueDescription)

    Parameters

    Returns

    Exceptions

  • RenameTopic(String, String)
    RenameTopic(String, String)

    Renames a topic inside a namespace.

    public TopicDescription RenameTopic(string path, string newPath)Public Function RenameTopic(path As String, newPath As String) As TopicDescription

    Parameters

    Returns

    Exceptions

  • RenameTopicAsync(String, String)
    RenameTopicAsync(String, String)

    Asynchronous version of RenameTopic(String, String).

    public Task<TopicDescription> RenameTopicAsync(string path, string newPath)Public Function RenameTopicAsync(path As String, newPath As String) As Task(Of TopicDescription)

    Parameters

    Returns

    Exceptions

  • RestorePublisher(String, String)
    RestorePublisher(String, String)

    Removes the publisher from the Event Hubs revocation list.

    public void RestorePublisher(string entityPath, string publisher)Public Sub RestorePublisher(entityPath As String, publisher As String)

    Parameters

  • RestorePublisherAsync(String, String)
    RestorePublisherAsync(String, String)

    Asynchronous version of RestorePublisher(String, String).

    public Task RestorePublisherAsync(string entityPath, string publisher)Public Function RestorePublisherAsync(entityPath As String, publisher As String) As Task

    Parameters

    Returns

  • RevokePublisher(String, String)
    RevokePublisher(String, String)

    Adds the publisher to the Event Hubs revocation list.

    public RevokedPublisherDescription RevokePublisher(string entityPath, string publisher)Public Function RevokePublisher(entityPath As String, publisher As String) As RevokedPublisherDescription

    Parameters

    Returns

  • RevokePublisherAsync(String, String)
    RevokePublisherAsync(String, String)

    Asynchronous version of RevokePublisher(String, String).

    public Task<RevokedPublisherDescription> RevokePublisherAsync(string entityPath, string publisher)Public Function RevokePublisherAsync(entityPath As String, publisher As String) As Task(Of RevokedPublisherDescription)

    Parameters

    Returns

  • SubscriptionExists(String, String)
    SubscriptionExists(String, String)

    Determines whether a subscription exists in the service namespace.

    public bool SubscriptionExists(string topicPath, string name)Public Function SubscriptionExists(topicPath As String, name As String) As Boolean

    Parameters

    • topicPath

      The path of the topic relative to the service namespace base address.

    • name

      The name of the subscription.

    Returns

    • true if a subscription exists in the service namespace; otherwise, false.

  • SubscriptionExistsAsync(String, String)
    SubscriptionExistsAsync(String, String)

    Asynchronously determines whether a subscription exists in the service namespace.

    public Task<bool> SubscriptionExistsAsync(string topicPath, string name)Public Function SubscriptionExistsAsync(topicPath As String, name As String) As Task(Of Boolean)

    Parameters

    • topicPath

      The path of the topic relative to the service namespace base address.

    • name

      The name of the subscription.

    Returns

  • TopicExists(String)
    TopicExists(String)

    Determines whether a topic exists in the service namespace.

    public bool TopicExists(string path)Public Function TopicExists(path As String) As Boolean

    Parameters

    • path

      The path of the topic relative to the service namespace base address.

    Returns

    • true if a topic exists in the service namespace; otherwise, false.

  • TopicExistsAsync(String)
    TopicExistsAsync(String)

    Asynchronously determines whether a topic exists in the service namespace.

    public Task<bool> TopicExistsAsync(string path)Public Function TopicExistsAsync(path As String) As Task(Of Boolean)

    Parameters

    • path

      The path of the topic relative to the service namespace base address.

    Returns

  • UpdateConsumerGroup(ConsumerGroupDescription)
    UpdateConsumerGroup(ConsumerGroupDescription)

    Updates an Event Hubs consumer group.

    public ConsumerGroupDescription UpdateConsumerGroup(ConsumerGroupDescription description)Public Function UpdateConsumerGroup(description As ConsumerGroupDescription) As ConsumerGroupDescription

    Parameters

    Returns

  • UpdateConsumerGroupAsync(ConsumerGroupDescription)
    UpdateConsumerGroupAsync(ConsumerGroupDescription)

    Asynchronously updates the consumer group.

    public Task<ConsumerGroupDescription> UpdateConsumerGroupAsync(ConsumerGroupDescription description)Public Function UpdateConsumerGroupAsync(description As ConsumerGroupDescription) As Task(Of ConsumerGroupDescription)

    Parameters

    Returns

  • UpdateEventHub(EventHubDescription)
    UpdateEventHub(EventHubDescription)

    Updates an Event Hub.

    public EventHubDescription UpdateEventHub(EventHubDescription description)Public Function UpdateEventHub(description As EventHubDescription) As EventHubDescription

    Parameters

    Returns

  • UpdateEventHubAsync(EventHubDescription)
    UpdateEventHubAsync(EventHubDescription)

    Asynchronously updates the event hub.

    public Task<EventHubDescription> UpdateEventHubAsync(EventHubDescription description)Public Function UpdateEventHubAsync(description As EventHubDescription) As Task(Of EventHubDescription)

    Parameters

    Returns

  • UpdateHybridConnection(HybridConnectionDescription)
    UpdateHybridConnection(HybridConnectionDescription)

    Updates the HybridConnection.

    public HybridConnectionDescription UpdateHybridConnection(HybridConnectionDescription hybridConnection)Public Function UpdateHybridConnection(hybridConnection As HybridConnectionDescription) As HybridConnectionDescription

    Parameters

    Returns

  • UpdateHybridConnectionAsync(HybridConnectionDescription)
    UpdateHybridConnectionAsync(HybridConnectionDescription)

    Asynchronously updates the HybridConnection.

    public Task<HybridConnectionDescription> UpdateHybridConnectionAsync(HybridConnectionDescription hybridConnection)Public Function UpdateHybridConnectionAsync(hybridConnection As HybridConnectionDescription) As Task(Of HybridConnectionDescription)

    Parameters

    Returns

  • UpdateQueue(QueueDescription)
    UpdateQueue(QueueDescription)

    Enables you to update the queue.

    public QueueDescription UpdateQueue(QueueDescription description)Public Function UpdateQueue(description As QueueDescription) As QueueDescription

    Parameters

    Returns

  • UpdateQueueAsync(QueueDescription)
    UpdateQueueAsync(QueueDescription)

    Asynchronously enables you to update the queue.

    public Task<QueueDescription> UpdateQueueAsync(QueueDescription description)Public Function UpdateQueueAsync(description As QueueDescription) As Task(Of QueueDescription)

    Parameters

    Returns

  • UpdateRelay(RelayDescription)
    UpdateRelay(RelayDescription)
    public RelayDescription UpdateRelay(RelayDescription description)Public Function UpdateRelay(description As RelayDescription) As RelayDescription

    Parameters

    Returns

  • UpdateRelayAsync(RelayDescription)
    UpdateRelayAsync(RelayDescription)

    Asynchronously enables you to update the relay.

    public Task<RelayDescription> UpdateRelayAsync(RelayDescription description)Public Function UpdateRelayAsync(description As RelayDescription) As Task(Of RelayDescription)

    Parameters

    Returns

  • UpdateSubscription(SubscriptionDescription)
    UpdateSubscription(SubscriptionDescription)

    Enables you to update the subscription.

    public SubscriptionDescription UpdateSubscription(SubscriptionDescription description)Public Function UpdateSubscription(description As SubscriptionDescription) As SubscriptionDescription

    Parameters

    Returns

  • UpdateSubscriptionAsync(SubscriptionDescription)
    UpdateSubscriptionAsync(SubscriptionDescription)

    Asynchronously enables you to update the subscription.

    public Task<SubscriptionDescription> UpdateSubscriptionAsync(SubscriptionDescription description)Public Function UpdateSubscriptionAsync(description As SubscriptionDescription) As Task(Of SubscriptionDescription)

    Parameters

    Returns

  • UpdateTopic(TopicDescription)
    UpdateTopic(TopicDescription)

    Enables you to update the topic.

    public TopicDescription UpdateTopic(TopicDescription description)Public Function UpdateTopic(description As TopicDescription) As TopicDescription

    Parameters

    Returns

  • UpdateTopicAsync(TopicDescription)
    UpdateTopicAsync(TopicDescription)

    Asynchronously enables you to update the topic.

    public Task<TopicDescription> UpdateTopicAsync(TopicDescription description)Public Function UpdateTopicAsync(description As TopicDescription) As Task(Of TopicDescription)

    Parameters

    Returns

Details

Assembly

Microsoft.ServiceBus.dll