Package version:
Initializes a new instance of the ServiceBusAdministrationClient class.
The connection string needed for the client to connect to Azure.
Optional options: ServiceBusAdministrationClientOptionsPipelineOptions
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.
Use the AzureNamedKeyCredential from @azure/core-auth if you want to pass in a SharedAccessKeyName
and SharedAccessKey without using a connection string. These fields map to the name and key field respectively
in AzureNamedKeyCredential.
Optional options: ServiceBusAdministrationClientOptionsPipelineOptions
Creates a queue with given name, configured using the given options
Options to configure the Queue being created(For example, you can configure a queue to support partitions or sessions) and 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
RestError with code UnauthorizedRequestError when given request fails due to authorization problems,
RestError with code MessageEntityAlreadyExistsError when requested messaging entity already exists,
RestError with code InvalidOperationError when requested operation is invalid and we encounter a 403 HTTP status code,
RestError with code QuotaExceededError when requested operation fails due to quote limits exceeding from service side,
RestError with code ServerBusyError when the request fails due to server being busy,
RestError with code ServiceError when receiving unrecognized HTTP status or for a scenarios such as
bad requests or requests resulting in conflicting operation on the server,
RestError with code and statusCode representing the standard set of REST API errors.
Creates a rule with given name, configured using the given options.
Defines the filter expression that the rule evaluates.
Optional operationOptions: anyThe 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
RestError with code UnauthorizedRequestError when given request fails due to authorization problems,
RestError with code MessageEntityAlreadyExistsError when requested messaging entity already exists,
RestError with code InvalidOperationError when requested operation is invalid and we encounter a 403 HTTP status code,
RestError with code QuotaExceededError when requested operation fails due to quote limits exceeding from service side,
RestError with code ServerBusyError when the request fails due to server being busy,
RestError with code ServiceError when receiving unrecognized HTTP status or for a scenarios such as
bad requests or requests resulting in conflicting operation on the server,
RestError with code and statusCode representing the standard set of REST API errors.
Creates a rule with given name, configured using the given options.
Defines the filter expression that the rule evaluates.
The SQL like expression that can be executed on the message should the associated filter apply.
Optional operationOptions: anyThe 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
RestError with code UnauthorizedRequestError when given request fails due to authorization problems,
RestError with code MessageEntityAlreadyExistsError when requested messaging entity already exists,
RestError with code InvalidOperationError when requested operation is invalid and we encounter a 403 HTTP status code,
RestError with code QuotaExceededError when requested operation fails due to quote limits exceeding from service side,
RestError with code ServerBusyError when the request fails due to server being busy,
RestError with code ServiceError when receiving unrecognized HTTP status or for a scenarios such as
bad requests or requests resulting in conflicting operation on the server,
RestError with code and statusCode representing the standard set of REST API errors.
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) and 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
RestError with code UnauthorizedRequestError when given request fails due to authorization problems,
RestError with code MessageEntityAlreadyExistsError when requested messaging entity already exists,
RestError with code InvalidOperationError when requested operation is invalid and we encounter a 403 HTTP status code,
RestError with code QuotaExceededError when requested operation fails due to quote limits exceeding from service side,
RestError with code ServerBusyError when the request fails due to server being busy,
RestError with code ServiceError when receiving unrecognized HTTP status or for a scenarios such as
bad requests or requests resulting in conflicting operation on the server,
RestError with code and statusCode representing the standard set of REST API errors.
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) and 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
RestError with code UnauthorizedRequestError when given request fails due to authorization problems,
RestError with code MessageEntityAlreadyExistsError when requested messaging entity already exists,
RestError with code InvalidOperationError when requested operation is invalid and we encounter a 403 HTTP status code,
RestError with code QuotaExceededError when requested operation fails due to quote limits exceeding from service side,
RestError with code ServerBusyError when the request fails due to server being busy,
RestError with code ServiceError when receiving unrecognized HTTP status or for a scenarios such as
bad requests or requests resulting in conflicting operation on the server,
RestError with code and statusCode representing the standard set of REST API errors.
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
RestError with code UnauthorizedRequestError when given request fails due to authorization problems,
RestError with code MessageEntityNotFoundError when requested messaging entity does not exist,
RestError with code InvalidOperationError when requested operation is invalid and we encounter a 403 HTTP status code,
RestError with code ServerBusyError when the request fails due to server being busy,
RestError with code ServiceError when receiving unrecognized HTTP status or for a scenarios such as
bad requests or requests resulting in conflicting operation on the server,
RestError with code and statusCode representing the standard set of REST API errors.
Deletes a rule.
Optional operationOptions: anyThe 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
RestError with code UnauthorizedRequestError when given request fails due to authorization problems,
RestError with code MessageEntityNotFoundError when requested messaging entity does not exist,
RestError with code InvalidOperationError when requested operation is invalid and we encounter a 403 HTTP status code,
RestError with code ServerBusyError when the request fails due to server being busy,
RestError with code ServiceError when receiving unrecognized HTTP status or for a scenarios such as
bad requests or requests resulting in conflicting operation on the server,
RestError with code and statusCode representing the standard set of REST API errors.
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
RestError with code UnauthorizedRequestError when given request fails due to authorization problems,
RestError with code MessageEntityNotFoundError when requested messaging entity does not exist,
RestError with code InvalidOperationError when requested operation is invalid and we encounter a 403 HTTP status code,
RestError with code ServerBusyError when the request fails due to server being busy,
RestError with code ServiceError when receiving unrecognized HTTP status or for a scenarios such as
bad requests or requests resulting in conflicting operation on the server,
RestError with code and statusCode representing the standard set of REST API errors.
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
RestError with code UnauthorizedRequestError when given request fails due to authorization problems,
RestError with code MessageEntityNotFoundError when requested messaging entity does not exist,
RestError with code InvalidOperationError when requested operation is invalid and we encounter a 403 HTTP status code,
RestError with code ServerBusyError when the request fails due to server being busy,
RestError with code ServiceError when receiving unrecognized HTTP status or for a scenarios such as
bad requests or requests resulting in conflicting operation on the server,
RestError with code and statusCode representing the standard set of REST API errors.
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 getQueueRuntimeProperties 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
RestError with code UnauthorizedRequestError when given request fails due to authorization problems,
RestError with code MessageEntityNotFoundError when requested messaging entity does not exist,
RestError with code InvalidOperationError when requested operation is invalid and we encounter a 403 HTTP status code,
RestError with code ServerBusyError when the request fails due to server being busy,
RestError with code ServiceError when receiving unrecognized HTTP status or for a scenarios such as
bad requests or requests resulting in conflicting operation on the server,
RestError with code and statusCode representing the standard set of REST API errors.
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
RestError with code UnauthorizedRequestError when given request fails due to authorization problems,
RestError with code MessageEntityNotFoundError when requested messaging entity does not exist,
RestError with code InvalidOperationError when requested operation is invalid and we encounter a 403 HTTP status code,
RestError with code ServerBusyError when the request fails due to server being busy,
RestError with code ServiceError when receiving unrecognized HTTP status or for a scenarios such as
bad requests or requests resulting in conflicting operation on the server,
RestError with code and statusCode representing the standard set of REST API errors.
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
RestError with code UnauthorizedRequestError when given request fails due to authorization problems,
RestError with code MessageEntityNotFoundError when requested messaging entity does not exist,
RestError with code InvalidOperationError when requested operation is invalid and we encounter a 403 HTTP status code,
RestError with code ServerBusyError when the request fails due to server being busy,
RestError with code ServiceError when receiving unrecognized HTTP status or for a scenarios such as
bad requests or requests resulting in conflicting operation on the server,
RestError with code and statusCode representing the standard set of REST API errors.
Returns an object representing the Subscription and its properties.
If you want to get the Subscription runtime info like message count details, use getSubscriptionRuntimeProperties 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
RestError with code UnauthorizedRequestError when given request fails due to authorization problems,
RestError with code MessageEntityNotFoundError when requested messaging entity does not exist,
RestError with code InvalidOperationError when requested operation is invalid and we encounter a 403 HTTP status code,
RestError with code ServerBusyError when the request fails due to server being busy,
RestError with code ServiceError when receiving unrecognized HTTP status or for a scenarios such as
bad requests or requests resulting in conflicting operation on the server,
RestError with code and statusCode representing the standard set of REST API errors.
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
RestError with code UnauthorizedRequestError when given request fails due to authorization problems,
RestError with code MessageEntityNotFoundError when requested messaging entity does not exist,
RestError with code InvalidOperationError when requested operation is invalid and we encounter a 403 HTTP status code,
RestError with code ServerBusyError when the request fails due to server being busy,
RestError with code ServiceError when receiving unrecognized HTTP status or for a scenarios such as
bad requests or requests resulting in conflicting operation on the server,
RestError with code and statusCode representing the standard set of REST API errors.
Returns an object representing the Topic and its properties.
If you want to get the Topic runtime info like subscription count details, use getTopicRuntimeProperties 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
RestError with code UnauthorizedRequestError when given request fails due to authorization problems,
RestError with code MessageEntityNotFoundError when requested messaging entity does not exist,
RestError with code InvalidOperationError when requested operation is invalid and we encounter a 403 HTTP status code,
RestError with code ServerBusyError when the request fails due to server being busy,
RestError with code ServiceError when receiving unrecognized HTTP status or for a scenarios such as
bad requests or requests resulting in conflicting operation on the server,
RestError with code and statusCode representing the standard set of REST API errors.
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
RestError with code UnauthorizedRequestError when given request fails due to authorization problems,
RestError with code MessageEntityNotFoundError when requested messaging entity does not exist,
RestError with code InvalidOperationError when requested operation is invalid and we encounter a 403 HTTP status code,
RestError with code ServerBusyError when the request fails due to server being busy,
RestError with code ServiceError when receiving unrecognized HTTP status or for a scenarios such as
bad requests or requests resulting in conflicting operation on the server,
RestError with code and statusCode representing the standard set of REST API errors.
Returns an async iterable iterator to list all the queues.
.byPage() returns an async iterable iterator to list the queues in pages.
Optional options: anyAn asyncIterableIterator that supports paging.
Returns an async iterable iterator to list runtime info of the queues.
.byPage() returns an async iterable iterator to list runtime info of the queues in pages.
Optional options: anyAn asyncIterableIterator that supports paging.
Returns an async iterable iterator to list all the rules under the specified subscription.
.byPage() returns an async iterable iterator to list the rules in pages.
Optional options: anyAn asyncIterableIterator that supports paging.
Returns an async iterable iterator to list all the subscriptions under the specified topic.
.byPage() returns an async iterable iterator to list the subscriptions in pages.
Optional options: anyAn asyncIterableIterator that supports paging.
Returns an async iterable iterator to list runtime info of the subscriptions under the specified topic.
.byPage() returns an async iterable iterator to list runtime info of subscriptions in pages.
Optional options: anyAn asyncIterableIterator that supports paging.
Returns an async iterable iterator to list all the topics.
.byPage() returns an async iterable iterator to list the topics in pages.
Optional options: anyAn asyncIterableIterator that supports paging.
Returns an async iterable iterator to list runtime info of the topics.
.byPage() returns an async iterable iterator to list runtime info of the topics in pages.
Optional options: anyAn asyncIterableIterator that supports paging.
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.
Updates the queue based on the queue properties provided.
All queue properties must be set even though only a subset of them are actually updatable.
Therefore, the suggested flow is to use the output from getQueue(), update the desired properties in it, and then pass the modified object to updateQueue().
The properties that cannot be updated are marked as readonly in the QueueProperties interface.
Object representing the properties of the queue and the raw response.
requiresSession, requiresDuplicateDetection, enablePartitioning, and name can't be updated after creating the 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
RestError with code UnauthorizedRequestError when given request fails due to authorization problems,
RestError with code MessageEntityNotFoundError when requested messaging entity does not exist,
RestError with code InvalidOperationError when requested operation is invalid and we encounter a 403 HTTP status code,
RestError with code ServerBusyError when the request fails due to server being busy,
RestError with code ServiceError when receiving unrecognized HTTP status or for a scenarios such as
bad requests or requests resulting in conflicting operation on the server,
RestError with code and statusCode representing the standard set of REST API errors.
Updates properties on the Rule by the given name based on the given options.
All rule properties must be set even if one of them is being updated.
Therefore, the suggested flow is to use the output from getRule(), update the desired properties in it, and then pass the modified object to updateRule().
Options to configure the Rule being updated and the raw response. For example, you can configure the filter to apply on associated Topic/Subscription.
Optional operationOptions: anyThe 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
RestError with code UnauthorizedRequestError when given request fails due to authorization problems,
RestError with code MessageEntityNotFoundError when requested messaging entity does not exist,
RestError with code InvalidOperationError when requested operation is invalid and we encounter a 403 HTTP status code,
RestError with code ServerBusyError when the request fails due to server being busy,
RestError with code ServiceError when receiving unrecognized HTTP status or for a scenarios such as
bad requests or requests resulting in conflicting operation on the server,
RestError with code and statusCode representing the standard set of REST API errors.
Updates the subscription based on the subscription properties provided.
All subscription properties must be set even though only a subset of them are actually updatable.
Therefore, the suggested flow is to use the output from getSubscription(), update the desired properties in it, and then pass the modified object to updateSubscription().
The properties that cannot be updated are marked as readonly in the SubscriptionProperties interface.
Object representing the properties of the subscription and the raw response.
subscriptionName, topicName, and requiresSession can't be updated after creating the 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
RestError with code UnauthorizedRequestError when given request fails due to authorization problems,
RestError with code MessageEntityNotFoundError when requested messaging entity does not exist,
RestError with code InvalidOperationError when requested operation is invalid and we encounter a 403 HTTP status code,
RestError with code ServerBusyError when the request fails due to server being busy,
RestError with code ServiceError when receiving unrecognized HTTP status or for a scenarios such as
bad requests or requests resulting in conflicting operation on the server,
RestError with code and statusCode representing the standard set of REST API errors.
Updates the topic based on the topic properties provided.
All topic properties must be set even though only a subset of them are actually updatable.
Therefore, the suggested flow is to use the output from getTopic(), update the desired properties in it, and then pass the modified object to updateTopic().
The properties that cannot be updated are marked as readonly in the TopicProperties interface.
Object representing the properties of the topic and the raw response.
requiresDuplicateDetection, enablePartitioning, and name can't be updated after creating the 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
RestError with code UnauthorizedRequestError when given request fails due to authorization problems,
RestError with code MessageEntityNotFoundError when requested messaging entity does not exist,
RestError with code InvalidOperationError when requested operation is invalid and we encounter a 403 HTTP status code,
RestError with code ServerBusyError when the request fails due to server being busy,
RestError with code ServiceError when receiving unrecognized HTTP status or for a scenarios such as
bad requests or requests resulting in conflicting operation on the server,
RestError with code and statusCode representing the standard set of REST API errors.
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.