Package version
Initializes a new instance of the ServiceBusManagementClient class.
The connection string needed for the client to connect to Azure.
ServiceBusManagementClientOptions
Initializes a new instance of the ServiceBusManagementClient class.
The fully qualified namespace of your Service Bus instance which is
likely to be similar to
A credential object used by the client to get the token to authenticate the connection
with the Azure Service Bus. See @azure/identity for creating the credentials.
If you're using your own implementation of the TokenCredential interface against AAD, then set the "scopes" for service-bus
to be ["https://servicebus.azure.net//user_impersonation"] to get the appropriate token.
ServiceBusManagementClientOptions
Creates a queue with given name, configured using the given options
The options that can be used to abort, trace and control other configurations on the HTTP request.
Following are errors that can be expected from this operation
Creates a queue configured using the given options
Options to configure the Queue being created. For example, you can configure a queue to support partitions or sessions.
The options that can be used to abort, trace and control other configurations on the HTTP request.
Following are errors that can be expected from this operation
Creates a rule with given name, configured using the given options.
The options that can be used to abort, trace and control other configurations on the HTTP request.
Following are errors that can be expected from this operation
Creates a subscription with given name, configured using the given options
The options that can be used to abort, trace and control other configurations on the HTTP request.
Following are errors that can be expected from this operation
Creates a subscription with given name, configured using the given options
Options to configure the Subscription being created. For example, you can configure a Subscription to support partitions or sessions.
The options that can be used to abort, trace and control other configurations on the HTTP request.
Following are errors that can be expected from this operation
Creates a topic with given name, configured using the given options
The options that can be used to abort, trace and control other configurations on the HTTP request.
Following are errors that can be expected from this operation
Creates a topic with given name, configured using the given options
Options to configure the Topic being created. For example, you can configure a topic to support partitions or sessions.
The options that can be used to abort, trace and control other configurations on the HTTP request.
Following are errors that can be expected from this operation
Deletes a queue.
The options that can be used to abort, trace and control other configurations on the HTTP request.
Following are errors that can be expected from this operation
Deletes a rule.
The options that can be used to abort, trace and control other configurations on the HTTP request.
Following are errors that can be expected from this operation
Deletes a subscription.
The options that can be used to abort, trace and control other configurations on the HTTP request.
Following are errors that can be expected from this operation
Deletes a topic.
The options that can be used to abort, trace and control other configurations on the HTTP request.
Following are errors that can be expected from this operation
Returns an object representing the metadata related to a service bus namespace.
The options that can be used to abort, trace and control other configurations on the HTTP request.
Returns an object representing the Queue and its properties.
If you want to get the Queue runtime info like message count details, use getQueueRuntimeInfo API.
The options that can be used to abort, trace and control other configurations on the HTTP request.
Following are errors that can be expected from this operation
Returns an object representing the Queue runtime info like message count details.
The options that can be used to abort, trace and control other configurations on the HTTP request.
Following are errors that can be expected from this operation
Returns a list of objects, each representing a Queue along with its properties.
If you want to get the runtime info of the queues like message count, use getQueuesRuntimeInfo API instead.
The options include the maxCount and the count of entities to skip, the operation options that can be used to abort, trace and control other configurations on the HTTP request.
Following are errors that can be expected from this operation
Returns a list of objects, each representing a Queue's runtime info like message count details.
The options include the maxCount and the count of entities to skip, the operation options that can be used to abort, trace and control other configurations on the HTTP request.
Following are errors that can be expected from this operation
Returns an object representing the Rule with the given name along with all its properties.
The options that can be used to abort, trace and control other configurations on the HTTP request.
Following are errors that can be expected from this operation
Lists existing rules.
The options include the maxCount and the count of entities to skip, the operation options that can be used to abort, trace and control other configurations on the HTTP request.
Following are errors that can be expected from this operation
Returns an object representing the Subscription and its properties.
If you want to get the Subscription runtime info like message count details, use getSubscriptionRuntimeInfo API.
The options that can be used to abort, trace and control other configurations on the HTTP request.
Following are errors that can be expected from this operation
Returns an object representing the Subscription runtime info like message count details.
The options that can be used to abort, trace and control other configurations on the HTTP request.
Following are errors that can be expected from this operation
Returns a list of objects, each representing a Subscription along with its properties.
If you want to get the runtime info of the subscriptions like message count, use getSubscriptionsRuntimeInfo API instead.
The options include the maxCount and the count of entities to skip, the operation options that can be used to abort, trace and control other configurations on the HTTP request.
Following are errors that can be expected from this operation
Returns a list of objects, each representing a Subscription's runtime info like message count details.
The options include the maxCount and the count of entities to skip, the operation options that can be used to abort, trace and control other configurations on the HTTP request.
Following are errors that can be expected from this operation
Returns an object representing the Topic and its properties.
If you want to get the Topic runtime info like subscription count details, use getTopicRuntimeInfo API.
The options that can be used to abort, trace and control other configurations on the HTTP request.
Following are errors that can be expected from this operation
Returns an object representing the Topic runtime info like subscription count.
The options that can be used to abort, trace and control other configurations on the HTTP request.
Following are errors that can be expected from this operation
Returns a list of objects, each representing a Topic along with its properties.
If you want to get the runtime info of the topics like subscription count, use getTopicsRuntimeInfo API instead.
The options include the maxCount and the count of entities to skip, the operation options that can be used to abort, trace and control other configurations on the HTTP request.
Following are errors that can be expected from this operation
Returns a list of objects, each representing a Topic's runtime info like subscription count.
The options include the maxCount and the count of entities to skip, the operation options that can be used to abort, trace and control other configurations on the HTTP request.
Following are errors that can be expected from this operation
Checks whether a given queue exists or not.
The options that can be used to abort, trace and control other configurations on the HTTP request.
Checks whether a given subscription exists in the topic or not.
The options that can be used to abort, trace and control other configurations on the HTTP request.
Checks whether a given topic exists or not.
The options that can be used to abort, trace and control other configurations on the HTTP request.
Updates the queue based on the queue description provided.
All properties on the queue description must be set even though only a subset of them are actually updatable.
Therefore, the suggested flow is to use getQueue() to get the queue description with all properties set,
update as needed and then pass it to updateQueue().
See https://docs.microsoft.com/en-us/rest/api/servicebus/update-queue for more details.
Object representing the queue with one or more of the below properties updated
The options that can be used to abort, trace and control other configurations on the HTTP request.
Following are errors that can be expected from this operation
Updates properties on the Rule by the given name based on the given options.
Options to configure the Rule being updated. For example, you can configure the filter to apply on associated Topic/Subscription.
The options that can be used to abort, trace and control other configurations on the HTTP request.
Following are errors that can be expected from this operation
Updates the subscription based on the subscription description provided.
All properties on the subscription description must be set even though only a subset of them are actually updatable.
Therefore, the suggested flow is to use getSubscription() to get the subscription description with all properties set,
update as needed and then pass it to updateSubscription().
Object representing the subscription with one or more of the below properties updated
The options that can be used to abort, trace and control other configurations on the HTTP request.
Following are errors that can be expected from this operation
Updates the topic based on the topic description provided.
All properties on the topic description must be set even though only a subset of them are actually updatable.
Therefore, the suggested flow is to use getTopic() to get the topic description with all properties set,
update as needed and then pass it to updateTopic().
See https://docs.microsoft.com/en-us/rest/api/servicebus/update-topic for more details.
Object representing the topic with one or more of the below properties updated
The options that can be used to abort, trace and control other configurations on the HTTP request.
Following are errors that can be expected from this operation
Generated using TypeDoc
All operations return promises that resolve to an object that has the relevant output. These objects also have a property called
_responsethat you can use if you want to access the direct response from the service.