ServiceBusAdministrationClient Class

Reference

Definition

Namespace:: Azure.Messaging.ServiceBus.Administration

Assembly:: Azure.Messaging.ServiceBus.dll

Package:: Azure.Messaging.ServiceBus v7.18.2

Package:: Azure.Messaging.ServiceBus v7.18.0-beta.1

Source:: ServiceBusAdministrationClient.cs

Source:: ServiceBusAdministrationClient.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

The ServiceBusAdministrationClient is the client through which all Service Bus entities can be created, updated, fetched, and deleted.

public class ServiceBusAdministrationClient

type ServiceBusAdministrationClient = class

Public Class ServiceBusAdministrationClient

Inheritance: Object
ServiceBusAdministrationClient

Remarks

The ServiceBusAdministrationClient operates against an entity management endpoint without performance guarantees. It is not recommended for use in performance-critical scenarios.

Constructors

ServiceBusAdministrationClient()	Parameterless constructor to allow mocking.
ServiceBusAdministrationClient(String, AzureNamedKeyCredential, ServiceBusAdministrationClientOptions)	Initializes a new ServiceBusAdministrationClient which can be used to perform administration operations on ServiceBus entities.
ServiceBusAdministrationClient(String, AzureSasCredential, ServiceBusAdministrationClientOptions)	Initializes a new ServiceBusAdministrationClient which can be used to perform administration operations on ServiceBus entities.
ServiceBusAdministrationClient(String, ServiceBusAdministrationClientOptions)	Initializes a new ServiceBusAdministrationClient which can be used to perform administration operations on ServiceBus entities.
ServiceBusAdministrationClient(String, TokenCredential, ServiceBusAdministrationClientOptions)	Initializes a new ServiceBusAdministrationClient which can be used to perform administration operations on ServiceBus entities.
ServiceBusAdministrationClient(String, TokenCredential)	Initializes a new ServiceBusAdministrationClient which can be used to perform administration operations on ServiceBus entities.
ServiceBusAdministrationClient(String)	Initializes a new ServiceBusAdministrationClient which can be used to perform administration operations on ServiceBus entities.

Methods

CreateQueueAsync(CreateQueueOptions, CancellationToken)	Creates a new queue in the service namespace with the given name.
CreateQueueAsync(String, CancellationToken)	Creates a new queue in the service namespace with the given name.
CreateRuleAsync(String, String, CreateRuleOptions, CancellationToken)	Adds a new rule to the subscription under given topic.
CreateSubscriptionAsync(CreateSubscriptionOptions, CancellationToken)	Creates a new subscription within a topic in the service namespace with the given name.
CreateSubscriptionAsync(CreateSubscriptionOptions, CreateRuleOptions, CancellationToken)	Creates a new subscription within a topic with the provided default rule.
CreateSubscriptionAsync(String, String, CancellationToken)	Creates a new subscription within a topic in the service namespace with the given name.
CreateTopicAsync(CreateTopicOptions, CancellationToken)	Creates a new topic in the service namespace with the given name.
CreateTopicAsync(String, CancellationToken)	Creates a new topic in the service namespace with the given name.
DeleteQueueAsync(String, CancellationToken)	Deletes the queue described by the name relative to the service namespace base address.
DeleteRuleAsync(String, String, String, CancellationToken)	Deletes the rule described by `ruleName` from `subscriptionName` under `topicName`./>
DeleteSubscriptionAsync(String, String, CancellationToken)	Deletes the subscription with the specified topic and subscription name.
DeleteTopicAsync(String, CancellationToken)	Deletes the topic described by the name relative to the service namespace base address.
GetNamespacePropertiesAsync(CancellationToken)	Gets information related to the currently used namespace.
GetQueueAsync(String, CancellationToken)	Retrieves a queue from the service namespace.
GetQueueRuntimePropertiesAsync(String, CancellationToken)	Retrieves the runtime properties of a queue.
GetQueuesAsync(CancellationToken)	Retrieves the set of queues present in the namespace.
GetQueuesRuntimePropertiesAsync(CancellationToken)	Retrieves the set of runtime properties for queues present in the namespace.
GetRuleAsync(String, String, String, CancellationToken)	Retrieves a rule from the service namespace.
GetRulesAsync(String, String, CancellationToken)	Retrieves the set of rules for a given subscription in a topic.
GetSubscriptionAsync(String, String, CancellationToken)	Retrieves a subscription from the service namespace.
GetSubscriptionRuntimePropertiesAsync(String, String, CancellationToken)	Retrieves the runtime properties of a subscription.
GetSubscriptionsAsync(String, CancellationToken)	Retrieves the set of subscriptions present in the topic.
GetSubscriptionsRuntimePropertiesAsync(String, CancellationToken)	Retrieves the list of runtime properties for subscriptions present in the namespace.
GetTopicAsync(String, CancellationToken)	Retrieves a topic from the service namespace.
GetTopicRuntimePropertiesAsync(String, CancellationToken)	Retrieves the runtime properties of a topic.
GetTopicsAsync(CancellationToken)	Retrieves the set of topics present in the namespace.
GetTopicsRuntimePropertiesAsync(CancellationToken)	Retrieves the set of runtime properties for topics present in the namespace.
QueueExistsAsync(String, CancellationToken)	Checks whether a given queue exists or not.
RuleExistsAsync(String, String, String, CancellationToken)	Checks whether a given rule exists or not.
SubscriptionExistsAsync(String, String, CancellationToken)	Checks whether a given subscription exists or not.
TopicExistsAsync(String, CancellationToken)	Checks whether a given topic exists or not.
UpdateQueueAsync(QueueProperties, CancellationToken)	Updates an existing queue.
UpdateRuleAsync(String, String, RuleProperties, CancellationToken)	Updates an existing rule for a topic-subscription.
UpdateSubscriptionAsync(SubscriptionProperties, CancellationToken)	Updates an existing subscription under a topic.
UpdateTopicAsync(TopicProperties, CancellationToken)	Updates an existing topic.

Applies to

Share via