ServiceBusManagementClient | @azure/service-bus

All operations return promises that resolve to an object that has the relevant output. These objects also have a property called _response that you can use if you want to access the direct response from the service.

Hierarchy

any
- ServiceBusManagementClient

Index

Constructors

constructor

new ServiceBusManagementClient(connectionString: string, options?: ServiceBusManagementClientOptions): ServiceBusManagementClient
new ServiceBusManagementClient(fullyQualifiedNamespace: string, credential: TokenCredential, options?: ServiceBusManagementClientOptions): ServiceBusManagementClient

- Defined in home/vsts/work/1/s/sdk/servicebus/service-bus/src/serviceBusAtomManagementClient.ts:367
Initializes a new instance of the ServiceBusManagementClient class.

Parameters
- connectionString: string
  
  The connection string needed for the client to connect to Azure.
- Optional options: ServiceBusManagementClientOptions
  
  ServiceBusManagementClientOptions
Returns ServiceBusManagementClient
- Defined in home/vsts/work/1/s/sdk/servicebus/service-bus/src/serviceBusAtomManagementClient.ts:374
Initializes a new instance of the ServiceBusManagementClient class.

Parameters
- fullyQualifiedNamespace: string
  
  The fully qualified namespace of your Service Bus instance which is likely to be similar to .servicebus.windows.net.
- credential: TokenCredential
  
  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.
- Optional options: ServiceBusManagementClientOptions
  
  ServiceBusManagementClientOptions
Returns ServiceBusManagementClient

Methods

createQueue

createQueue(queueName: string): Promise<CreateQueueResponse>
createQueue(queue: QueueDescription): Promise<CreateQueueResponse>

- Defined in home/vsts/work/1/s/sdk/servicebus/service-bus/src/serviceBusAtomManagementClient.ts:475
Creates a queue with given name, configured using the given options

throws

RestError with code UnauthorizedRequestError when given request fails due to authorization problems,

throws

RestError with code MessageEntityAlreadyExistsError when requested messaging entity already exists,

throws

RestError with code InvalidOperationError when requested operation is invalid and we encounter a 403 HTTP status code,

throws

RestError with code QuotaExceededError when requested operation fails due to quote limits exceeding from service side,

throws

RestError with code ServerBusyError when the request fails due to server being busy,

throws

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,

throws

RestError with code that is a value from the standard set of HTTP status codes as documented at https://docs.microsoft.com/en-us/dotnet/api/system.net.httpstatuscode?view=netframework-4.8

Parameters
- queueName: string
  
  Following are errors that can be expected from this operation
Returns Promise<CreateQueueResponse>
- Defined in home/vsts/work/1/s/sdk/servicebus/service-bus/src/serviceBusAtomManagementClient.ts:492
Creates a queue configured using the given options

throws

RestError with code UnauthorizedRequestError when given request fails due to authorization problems,

throws

RestError with code MessageEntityAlreadyExistsError when requested messaging entity already exists,

throws

RestError with code InvalidOperationError when requested operation is invalid and we encounter a 403 HTTP status code,

throws

RestError with code QuotaExceededError when requested operation fails due to quote limits exceeding from service side,

throws

RestError with code ServerBusyError when the request fails due to server being busy,

throws

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,

throws

RestError with code that is a value from the standard set of HTTP status codes as documented at https://docs.microsoft.com/en-us/dotnet/api/system.net.httpstatuscode?view=netframework-4.8

Parameters
- queue: QueueDescription
  
  Options to configure the Queue being created. For example, you can configure a queue to support partitions or sessions.
  
  Following are errors that can be expected from this operation
Returns Promise<CreateQueueResponse>

createRule

createRule(topicName: string, subscriptionName: string, rule: RuleDescription): Promise<CreateRuleResponse>

- Defined in home/vsts/work/1/s/sdk/servicebus/service-bus/src/serviceBusAtomManagementClient.ts:1269
Creates a rule with given name, configured using the given options.

throws

RestError with code UnauthorizedRequestError when given request fails due to authorization problems,

throws

RestError with code MessageEntityAlreadyExistsError when requested messaging entity already exists,

throws

RestError with code InvalidOperationError when requested operation is invalid and we encounter a 403 HTTP status code,

throws

RestError with code QuotaExceededError when requested operation fails due to quote limits exceeding from service side,

throws

RestError with code ServerBusyError when the request fails due to server being busy,

throws

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,

throws

RestError with code that is a value from the standard set of HTTP status codes as documented at https://docs.microsoft.com/en-us/dotnet/api/system.net.httpstatuscode?view=netframework-4.8

Parameters
- topicName: string
- subscriptionName: string
- rule: RuleDescription
  
  Following are errors that can be expected from this operation
Returns Promise<CreateRuleResponse>

createSubscription

createSubscription(topicName: string, subscriptionName: string): Promise<CreateSubscriptionResponse>
createSubscription(subscription: SubscriptionDescription): Promise<CreateSubscriptionResponse>

- Defined in home/vsts/work/1/s/sdk/servicebus/service-bus/src/serviceBusAtomManagementClient.ts:960
Creates a subscription with given name, configured using the given options

throws

RestError with code UnauthorizedRequestError when given request fails due to authorization problems,

throws

RestError with code MessageEntityAlreadyExistsError when requested messaging entity already exists,

throws

RestError with code InvalidOperationError when requested operation is invalid and we encounter a 403 HTTP status code,

throws

RestError with code QuotaExceededError when requested operation fails due to quote limits exceeding from service side,

throws

RestError with code ServerBusyError when the request fails due to server being busy,

throws

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,

throws

RestError with code that is a value from the standard set of HTTP status codes as documented at https://docs.microsoft.com/en-us/dotnet/api/system.net.httpstatuscode?view=netframework-4.8

Parameters
- topicName: string
- subscriptionName: string
  
  Following are errors that can be expected from this operation
Returns Promise<CreateSubscriptionResponse>
- Defined in home/vsts/work/1/s/sdk/servicebus/service-bus/src/serviceBusAtomManagementClient.ts:981
Creates a subscription with given name, configured using the given options

throws

RestError with code UnauthorizedRequestError when given request fails due to authorization problems,

throws

RestError with code MessageEntityAlreadyExistsError when requested messaging entity already exists,

throws

RestError with code InvalidOperationError when requested operation is invalid and we encounter a 403 HTTP status code,

throws

RestError with code QuotaExceededError when requested operation fails due to quote limits exceeding from service side,

throws

RestError with code ServerBusyError when the request fails due to server being busy,

throws

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,

throws

RestError with code that is a value from the standard set of HTTP status codes as documented at https://docs.microsoft.com/en-us/dotnet/api/system.net.httpstatuscode?view=netframework-4.8

Parameters
- subscription: SubscriptionDescription
  
  Options to configure the Subscription being created. For example, you can configure a Subscription to support partitions or sessions.
  
  Following are errors that can be expected from this operation
Returns Promise<CreateSubscriptionResponse>

createTopic

createTopic(topicName: string): Promise<CreateTopicResponse>
createTopic(topic: TopicDescription): Promise<CreateTopicResponse>

- Defined in home/vsts/work/1/s/sdk/servicebus/service-bus/src/serviceBusAtomManagementClient.ts:717
Creates a topic with given name, configured using the given options

throws

RestError with code UnauthorizedRequestError when given request fails due to authorization problems,

throws

RestError with code MessageEntityAlreadyExistsError when requested messaging entity already exists,

throws

RestError with code InvalidOperationError when requested operation is invalid and we encounter a 403 HTTP status code,

throws

RestError with code QuotaExceededError when requested operation fails due to quote limits exceeding from service side,

throws

RestError with code ServerBusyError when the request fails due to server being busy,

throws

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,

throws

RestError with code that is a value from the standard set of HTTP status codes as documented at https://docs.microsoft.com/en-us/dotnet/api/system.net.httpstatuscode?view=netframework-4.8

Parameters
- topicName: string
  
  Following are errors that can be expected from this operation
Returns Promise<CreateTopicResponse>
- Defined in home/vsts/work/1/s/sdk/servicebus/service-bus/src/serviceBusAtomManagementClient.ts:734
Creates a topic with given name, configured using the given options

throws

RestError with code UnauthorizedRequestError when given request fails due to authorization problems,

throws

RestError with code MessageEntityAlreadyExistsError when requested messaging entity already exists,

throws

RestError with code InvalidOperationError when requested operation is invalid and we encounter a 403 HTTP status code,

throws

RestError with code QuotaExceededError when requested operation fails due to quote limits exceeding from service side,

throws

RestError with code ServerBusyError when the request fails due to server being busy,

throws

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,

throws

RestError with code that is a value from the standard set of HTTP status codes as documented at https://docs.microsoft.com/en-us/dotnet/api/system.net.httpstatuscode?view=netframework-4.8

Parameters
- topic: TopicDescription
  
  Options to configure the Topic being created. For example, you can configure a topic to support partitions or sessions.
  
  Following are errors that can be expected from this operation
Returns Promise<CreateTopicResponse>

deleteQueue

deleteQueue(queueName: string): Promise<DeleteQueueResponse>

- Defined in home/vsts/work/1/s/sdk/servicebus/service-bus/src/serviceBusAtomManagementClient.ts:675
Deletes a queue.

throws

RestError with code UnauthorizedRequestError when given request fails due to authorization problems,

throws

RestError with code MessageEntityNotFoundError when requested messaging entity does not exist,

throws

RestError with code InvalidOperationError when requested operation is invalid and we encounter a 403 HTTP status code,

throws

RestError with code ServerBusyError when the request fails due to server being busy,

throws

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,

throws

RestError with code that is a value from the standard set of HTTP status codes as documented at https://docs.microsoft.com/en-us/dotnet/api/system.net.httpstatuscode?view=netframework-4.8

Parameters
- queueName: string
  
  Following are errors that can be expected from this operation
Returns Promise<DeleteQueueResponse>

deleteRule

deleteRule(topicName: string, subscriptionName: string, ruleName: string): Promise<DeleteRuleResponse>

- Defined in home/vsts/work/1/s/sdk/servicebus/service-bus/src/serviceBusAtomManagementClient.ts:1415
Deletes a rule.

throws

RestError with code UnauthorizedRequestError when given request fails due to authorization problems,

throws

RestError with code MessageEntityNotFoundError when requested messaging entity does not exist,

throws

RestError with code InvalidOperationError when requested operation is invalid and we encounter a 403 HTTP status code,

throws

RestError with code ServerBusyError when the request fails due to server being busy,

throws

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,

throws

RestError with code that is a value from the standard set of HTTP status codes as documented at https://docs.microsoft.com/en-us/dotnet/api/system.net.httpstatuscode?view=netframework-4.8

Parameters
- topicName: string
- subscriptionName: string
- ruleName: string
  
  Following are errors that can be expected from this operation
Returns Promise<DeleteRuleResponse>

deleteSubscription

deleteSubscription(topicName: string, subscriptionName: string): Promise<DeleteSubscriptionResponse>

- Defined in home/vsts/work/1/s/sdk/servicebus/service-bus/src/serviceBusAtomManagementClient.ts:1215
Deletes a subscription.

throws

RestError with code UnauthorizedRequestError when given request fails due to authorization problems,

throws

RestError with code MessageEntityNotFoundError when requested messaging entity does not exist,

throws

RestError with code InvalidOperationError when requested operation is invalid and we encounter a 403 HTTP status code,

throws

RestError with code ServerBusyError when the request fails due to server being busy,

throws

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,

throws

RestError with code that is a value from the standard set of HTTP status codes as documented at https://docs.microsoft.com/en-us/dotnet/api/system.net.httpstatuscode?view=netframework-4.8

Parameters
- topicName: string
- subscriptionName: string
  
  Following are errors that can be expected from this operation
Returns Promise<DeleteSubscriptionResponse>

deleteTopic

deleteTopic(topicName: string): Promise<DeleteTopicResponse>

- Defined in home/vsts/work/1/s/sdk/servicebus/service-bus/src/serviceBusAtomManagementClient.ts:917
Deletes a topic.

throws

RestError with code UnauthorizedRequestError when given request fails due to authorization problems,

throws

RestError with code MessageEntityNotFoundError when requested messaging entity does not exist,

throws

RestError with code InvalidOperationError when requested operation is invalid and we encounter a 403 HTTP status code,

throws

RestError with code ServerBusyError when the request fails due to server being busy,

throws

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,

throws

RestError with code that is a value from the standard set of HTTP status codes as documented at https://docs.microsoft.com/en-us/dotnet/api/system.net.httpstatuscode?view=netframework-4.8

Parameters
- topicName: string
  
  Following are errors that can be expected from this operation
Returns Promise<DeleteTopicResponse>

getNamespaceProperties

getNamespaceProperties(): Promise<GetNamespaceResponse>

- Defined in home/vsts/work/1/s/sdk/servicebus/service-bus/src/serviceBusAtomManagementClient.ts:450
Returns an object representing the metadata related to a service bus namespace.

Returns Promise<GetNamespaceResponse>

getQueue

getQueue(queueName: string): Promise<GetQueueResponse>

- Defined in home/vsts/work/1/s/sdk/servicebus/service-bus/src/serviceBusAtomManagementClient.ts:528
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.

throws

RestError with code UnauthorizedRequestError when given request fails due to authorization problems,

throws

RestError with code MessageEntityNotFoundError when requested messaging entity does not exist,

throws

RestError with code InvalidOperationError when requested operation is invalid and we encounter a 403 HTTP status code,

throws

RestError with code ServerBusyError when the request fails due to server being busy,

throws

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,

throws

RestError with code that is a value from the standard set of HTTP status codes as documented at https://docs.microsoft.com/en-us/dotnet/api/system.net.httpstatuscode?view=netframework-4.8

Parameters
- queueName: string
  
  Following are errors that can be expected from this operation
Returns Promise<GetQueueResponse>

getQueueRuntimeInfo

getQueueRuntimeInfo(queueName: string): Promise<GetQueueRuntimeInfoResponse>

- Defined in home/vsts/work/1/s/sdk/servicebus/service-bus/src/serviceBusAtomManagementClient.ts:552
Returns an object representing the Queue runtime info like message count details.

throws

RestError with code UnauthorizedRequestError when given request fails due to authorization problems,

throws

RestError with code MessageEntityNotFoundError when requested messaging entity does not exist,

throws

RestError with code InvalidOperationError when requested operation is invalid and we encounter a 403 HTTP status code,

throws

RestError with code ServerBusyError when the request fails due to server being busy,

throws

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,

throws

RestError with code that is a value from the standard set of HTTP status codes as documented at https://docs.microsoft.com/en-us/dotnet/api/system.net.httpstatuscode?view=netframework-4.8

Parameters
- queueName: string
  
  Following are errors that can be expected from this operation
Returns Promise<GetQueueRuntimeInfoResponse>

getQueues

getQueues(listRequestOptions?: ListRequestOptions): Promise<GetQueuesResponse>

- Defined in home/vsts/work/1/s/sdk/servicebus/service-bus/src/serviceBusAtomManagementClient.ts:576
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.

throws

RestError with code UnauthorizedRequestError when given request fails due to authorization problems,

throws

RestError with code InvalidOperationError when requested operation is invalid and we encounter a 403 HTTP status code,

throws

RestError with code ServerBusyError when the request fails due to server being busy,

throws

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,

throws

RestError with code that is a value from the standard set of HTTP status codes as documented at https://docs.microsoft.com/en-us/dotnet/api/system.net.httpstatuscode?view=netframework-4.8

Parameters
- Optional listRequestOptions: ListRequestOptions
  
  Following are errors that can be expected from this operation
Returns Promise<GetQueuesResponse>

getQueuesRuntimeInfo

getQueuesRuntimeInfo(listRequestOptions?: ListRequestOptions): Promise<GetQueuesRuntimeInfoResponse>

- Defined in home/vsts/work/1/s/sdk/servicebus/service-bus/src/serviceBusAtomManagementClient.ts:602
Returns a list of objects, each representing a Queue's runtime info like message count details.

throws

RestError with code UnauthorizedRequestError when given request fails due to authorization problems,

throws

RestError with code InvalidOperationError when requested operation is invalid and we encounter a 403 HTTP status code,

throws

RestError with code ServerBusyError when the request fails due to server being busy,

throws

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,

throws

RestError with code that is a value from the standard set of HTTP status codes as documented at https://docs.microsoft.com/en-us/dotnet/api/system.net.httpstatuscode?view=netframework-4.8

Parameters
- Optional listRequestOptions: ListRequestOptions
  
  Following are errors that can be expected from this operation
Returns Promise<GetQueuesRuntimeInfoResponse>

getRule

getRule(topicName: string, subscriptioName: string, ruleName: string): Promise<GetRuleResponse>

- Defined in home/vsts/work/1/s/sdk/servicebus/service-bus/src/serviceBusAtomManagementClient.ts:1303
Returns an object representing the Rule with the given name along with all its properties.

throws

RestError with code UnauthorizedRequestError when given request fails due to authorization problems,

throws

RestError with code MessageEntityNotFoundError when requested messaging entity does not exist,

throws

RestError with code InvalidOperationError when requested operation is invalid and we encounter a 403 HTTP status code,

throws

RestError with code ServerBusyError when the request fails due to server being busy,

throws

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,

throws

RestError with code that is a value from the standard set of HTTP status codes as documented at https://docs.microsoft.com/en-us/dotnet/api/system.net.httpstatuscode?view=netframework-4.8

Parameters
- topicName: string
- subscriptioName: string
- ruleName: string
  
  Following are errors that can be expected from this operation
Returns Promise<GetRuleResponse>

getRules

getRules(topicName: string, subscriptionName: string, listRequestOptions?: ListRequestOptions): Promise<GetRulesResponse>

- Defined in home/vsts/work/1/s/sdk/servicebus/service-bus/src/serviceBusAtomManagementClient.ts:1333
Lists existing rules.

throws

RestError with code UnauthorizedRequestError when given request fails due to authorization problems,

throws

RestError with code InvalidOperationError when requested operation is invalid and we encounter a 403 HTTP status code,

throws

RestError with code ServerBusyError when the request fails due to server being busy,

throws

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,

throws

RestError with code that is a value from the standard set of HTTP status codes as documented at https://docs.microsoft.com/en-us/dotnet/api/system.net.httpstatuscode?view=netframework-4.8

Parameters
- topicName: string
- subscriptionName: string
- Optional listRequestOptions: ListRequestOptions
  
  Following are errors that can be expected from this operation
Returns Promise<GetRulesResponse>

getSubscription

getSubscription(topicName: string, subscriptionName: string): Promise<GetSubscriptionResponse>

- Defined in home/vsts/work/1/s/sdk/servicebus/service-bus/src/serviceBusAtomManagementClient.ts:1033
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.

throws

RestError with code UnauthorizedRequestError when given request fails due to authorization problems,

throws

RestError with code MessageEntityNotFoundError when requested messaging entity does not exist,

throws

RestError with code InvalidOperationError when requested operation is invalid and we encounter a 403 HTTP status code,

throws

RestError with code ServerBusyError when the request fails due to server being busy,

throws

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,

throws

RestError with code that is a value from the standard set of HTTP status codes as documented at https://docs.microsoft.com/en-us/dotnet/api/system.net.httpstatuscode?view=netframework-4.8

Parameters
- topicName: string
- subscriptionName: string
  
  Following are errors that can be expected from this operation
Returns Promise<GetSubscriptionResponse>

getSubscriptionRuntimeInfo

getSubscriptionRuntimeInfo(topicName: string, subscriptionName: string): Promise<GetSubscriptionRuntimeInfoResponse>

- Defined in home/vsts/work/1/s/sdk/servicebus/service-bus/src/serviceBusAtomManagementClient.ts:1064
Returns an object representing the Subscription runtime info like message count details.

throws

RestError with code UnauthorizedRequestError when given request fails due to authorization problems,

throws

RestError with code MessageEntityNotFoundError when requested messaging entity does not exist,

throws

RestError with code InvalidOperationError when requested operation is invalid and we encounter a 403 HTTP status code,

throws

RestError with code ServerBusyError when the request fails due to server being busy,

throws

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,

throws

RestError with code that is a value from the standard set of HTTP status codes as documented at https://docs.microsoft.com/en-us/dotnet/api/system.net.httpstatuscode?view=netframework-4.8

Parameters
- topicName: string
- subscriptionName: string
  
  Following are errors that can be expected from this operation
Returns Promise<GetSubscriptionRuntimeInfoResponse>

getSubscriptions

getSubscriptions(topicName: string, listRequestOptions?: ListRequestOptions): Promise<GetSubscriptionsResponse>

- Defined in home/vsts/work/1/s/sdk/servicebus/service-bus/src/serviceBusAtomManagementClient.ts:1095
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.

throws

RestError with code UnauthorizedRequestError when given request fails due to authorization problems,

throws

RestError with code InvalidOperationError when requested operation is invalid and we encounter a 403 HTTP status code,

throws

RestError with code ServerBusyError when the request fails due to server being busy,

throws

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,

throws

RestError with code that is a value from the standard set of HTTP status codes as documented at https://docs.microsoft.com/en-us/dotnet/api/system.net.httpstatuscode?view=netframework-4.8

Parameters
- topicName: string
- Optional listRequestOptions: ListRequestOptions
  
  Following are errors that can be expected from this operation
Returns Promise<GetSubscriptionsResponse>

getSubscriptionsRuntimeInfo

getSubscriptionsRuntimeInfo(topicName: string, listRequestOptions?: ListRequestOptions): Promise<GetSubscriptionsRuntimeInfoResponse>

- Defined in home/vsts/work/1/s/sdk/servicebus/service-bus/src/serviceBusAtomManagementClient.ts:1125
Returns a list of objects, each representing a Subscription's runtime info like message count details.

throws

RestError with code UnauthorizedRequestError when given request fails due to authorization problems,

throws

RestError with code InvalidOperationError when requested operation is invalid and we encounter a 403 HTTP status code,

throws

RestError with code ServerBusyError when the request fails due to server being busy,

throws

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,

throws

RestError with code that is a value from the standard set of HTTP status codes as documented at https://docs.microsoft.com/en-us/dotnet/api/system.net.httpstatuscode?view=netframework-4.8

Parameters
- topicName: string
- Optional listRequestOptions: ListRequestOptions
  
  Following are errors that can be expected from this operation
Returns Promise<GetSubscriptionsRuntimeInfoResponse>

getTopic

getTopic(topicName: string): Promise<GetTopicResponse>

- Defined in home/vsts/work/1/s/sdk/servicebus/service-bus/src/serviceBusAtomManagementClient.ts:770
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.

throws

RestError with code UnauthorizedRequestError when given request fails due to authorization problems,

throws

RestError with code MessageEntityNotFoundError when requested messaging entity does not exist,

throws

RestError with code InvalidOperationError when requested operation is invalid and we encounter a 403 HTTP status code,

throws

RestError with code ServerBusyError when the request fails due to server being busy,

throws

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,

throws

RestError with code that is a value from the standard set of HTTP status codes as documented at https://docs.microsoft.com/en-us/dotnet/api/system.net.httpstatuscode?view=netframework-4.8

Parameters
- topicName: string
  
  Following are errors that can be expected from this operation
Returns Promise<GetTopicResponse>

getTopicRuntimeInfo

getTopicRuntimeInfo(topicName: string): Promise<GetTopicRuntimeInfoResponse>

- Defined in home/vsts/work/1/s/sdk/servicebus/service-bus/src/serviceBusAtomManagementClient.ts:794
Returns an object representing the Topic runtime info like subscription count.

throws

RestError with code UnauthorizedRequestError when given request fails due to authorization problems,

throws

RestError with code MessageEntityNotFoundError when requested messaging entity does not exist,

throws

RestError with code InvalidOperationError when requested operation is invalid and we encounter a 403 HTTP status code,

throws

RestError with code ServerBusyError when the request fails due to server being busy,

throws

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,

throws

RestError with code that is a value from the standard set of HTTP status codes as documented at https://docs.microsoft.com/en-us/dotnet/api/system.net.httpstatuscode?view=netframework-4.8

Parameters
- topicName: string
  
  Following are errors that can be expected from this operation
Returns Promise<GetTopicRuntimeInfoResponse>

getTopics

getTopics(listRequestOptions?: ListRequestOptions): Promise<GetTopicsResponse>

- Defined in home/vsts/work/1/s/sdk/servicebus/service-bus/src/serviceBusAtomManagementClient.ts:818
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.

throws

RestError with code UnauthorizedRequestError when given request fails due to authorization problems,

throws

RestError with code InvalidOperationError when requested operation is invalid and we encounter a 403 HTTP status code,

throws

RestError with code ServerBusyError when the request fails due to server being busy,

throws

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,

throws

RestError with code that is a value from the standard set of HTTP status codes as documented at https://docs.microsoft.com/en-us/dotnet/api/system.net.httpstatuscode?view=netframework-4.8

Parameters
- Optional listRequestOptions: ListRequestOptions
  
  Following are errors that can be expected from this operation
Returns Promise<GetTopicsResponse>

getTopicsRuntimeInfo

getTopicsRuntimeInfo(listRequestOptions?: ListRequestOptions): Promise<GetTopicsRuntimeInfoResponse>

- Defined in home/vsts/work/1/s/sdk/servicebus/service-bus/src/serviceBusAtomManagementClient.ts:844
Returns a list of objects, each representing a Topic's runtime info like subscription count.

throws

RestError with code UnauthorizedRequestError when given request fails due to authorization problems,

throws

RestError with code InvalidOperationError when requested operation is invalid and we encounter a 403 HTTP status code,

throws

RestError with code ServerBusyError when the request fails due to server being busy,

throws

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,

throws

RestError with code that is a value from the standard set of HTTP status codes as documented at https://docs.microsoft.com/en-us/dotnet/api/system.net.httpstatuscode?view=netframework-4.8

Parameters
- Optional listRequestOptions: ListRequestOptions
  
  Following are errors that can be expected from this operation
Returns Promise<GetTopicsRuntimeInfoResponse>

queueExists

queueExists(queueName: string): Promise<boolean>

- Defined in home/vsts/work/1/s/sdk/servicebus/service-bus/src/serviceBusAtomManagementClient.ts:689
Checks whether a given queue exists or not.

Parameters
- queueName: string
Returns Promise<boolean>

subscriptionExists

subscriptionExists(topicName: string, subscriptionName: string): Promise<boolean>

- Defined in home/vsts/work/1/s/sdk/servicebus/service-bus/src/serviceBusAtomManagementClient.ts:1237
Checks whether a given subscription exists in the topic or not.

Parameters
- topicName: string
- subscriptionName: string
Returns Promise<boolean>

topicExists

topicExists(topicName: string): Promise<boolean>

- Defined in home/vsts/work/1/s/sdk/servicebus/service-bus/src/serviceBusAtomManagementClient.ts:931
Checks whether a given topic exists or not.

Parameters
- topicName: string
Returns Promise<boolean>

updateQueue

updateQueue(queue: QueueDescription): Promise<UpdateQueueResponse>

- Defined in home/vsts/work/1/s/sdk/servicebus/service-bus/src/serviceBusAtomManagementClient.ts:632
Updates properties on the Queue by the given name based on the given options

throws

RestError with code UnauthorizedRequestError when given request fails due to authorization problems,

throws

RestError with code MessageEntityNotFoundError when requested messaging entity does not exist,

throws

RestError with code InvalidOperationError when requested operation is invalid and we encounter a 403 HTTP status code,

throws

RestError with code ServerBusyError when the request fails due to server being busy,

throws

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,

throws

RestError with code that is a value from the standard set of HTTP status codes as documented at https://docs.microsoft.com/en-us/dotnet/api/system.net.httpstatuscode?view=netframework-4.8

Parameters
- queue: QueueDescription
  
  Options to configure the Queue being updated. For example, you can configure a queue to support partitions or sessions.
  
  Following are errors that can be expected from this operation
Returns Promise<UpdateQueueResponse>

updateRule

updateRule(topicName: string, subscriptionName: string, rule: RuleDescription): Promise<UpdateRuleResponse>

- Defined in home/vsts/work/1/s/sdk/servicebus/service-bus/src/serviceBusAtomManagementClient.ts:1369
Updates properties on the Rule by the given name based on the given options.

throws

RestError with code UnauthorizedRequestError when given request fails due to authorization problems,

throws

RestError with code MessageEntityNotFoundError when requested messaging entity does not exist,

throws

RestError with code InvalidOperationError when requested operation is invalid and we encounter a 403 HTTP status code,

throws

RestError with code ServerBusyError when the request fails due to server being busy,

throws

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,

throws

RestError with code that is a value from the standard set of HTTP status codes as documented at https://docs.microsoft.com/en-us/dotnet/api/system.net.httpstatuscode?view=netframework-4.8

Parameters
- topicName: string
- subscriptionName: string
- rule: RuleDescription
Returns Promise<UpdateRuleResponse>

updateSubscription

updateSubscription(subscription: SubscriptionDescription): Promise<UpdateSubscriptionResponse>

- Defined in home/vsts/work/1/s/sdk/servicebus/service-bus/src/serviceBusAtomManagementClient.ts:1156
Updates properties on the Subscription by the given name based on the given options

throws

RestError with code UnauthorizedRequestError when given request fails due to authorization problems,

throws

RestError with code MessageEntityNotFoundError when requested messaging entity does not exist,

throws

RestError with code InvalidOperationError when requested operation is invalid and we encounter a 403 HTTP status code,

throws

RestError with code ServerBusyError when the request fails due to server being busy,

throws

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,

throws

RestError with code that is a value from the standard set of HTTP status codes as documented at https://docs.microsoft.com/en-us/dotnet/api/system.net.httpstatuscode?view=netframework-4.8

Parameters
- subscription: SubscriptionDescription
  
  Options to configure the Subscription being updated. For example, you can configure a Subscription to support partitions or sessions.
  
  Following are errors that can be expected from this operation
Returns Promise<UpdateSubscriptionResponse>

updateTopic

updateTopic(topic: TopicDescription): Promise<UpdateTopicResponse>

- Defined in home/vsts/work/1/s/sdk/servicebus/service-bus/src/serviceBusAtomManagementClient.ts:874
Updates properties on the Topic by the given name based on the given options

throws

RestError with code UnauthorizedRequestError when given request fails due to authorization problems,

throws

RestError with code MessageEntityNotFoundError when requested messaging entity does not exist,

throws

RestError with code InvalidOperationError when requested operation is invalid and we encounter a 403 HTTP status code,

throws

RestError with code ServerBusyError when the request fails due to server being busy,

throws

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,

throws

RestError with code that is a value from the standard set of HTTP status codes as documented at https://docs.microsoft.com/en-us/dotnet/api/system.net.httpstatuscode?view=netframework-4.8

Parameters
- topic: TopicDescription
  
  Options to configure the Topic being updated. For example, you can configure a topic to support partitions or sessions.
  
  Following are errors that can be expected from this operation
Returns Promise<UpdateTopicResponse>

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

connectionString: string

Optional options: ServiceBusManagementClientOptions

Returns ServiceBusManagementClient

Parameters

fullyQualifiedNamespace: string

credential: TokenCredential

Optional options: ServiceBusManagementClientOptions

Returns ServiceBusManagementClient

Methods

createQueue

Parameters

queueName: string

Returns Promise<CreateQueueResponse>

Parameters

queue: QueueDescription

Returns Promise<CreateQueueResponse>

createRule

Parameters

topicName: string

subscriptionName: string

rule: RuleDescription

Returns Promise<CreateRuleResponse>

createSubscription

Parameters

topicName: string

subscriptionName: string

Returns Promise<CreateSubscriptionResponse>

Parameters

subscription: SubscriptionDescription

Returns Promise<CreateSubscriptionResponse>

createTopic

Parameters

topicName: string

Returns Promise<CreateTopicResponse>

Parameters

topic: TopicDescription

Returns Promise<CreateTopicResponse>

deleteQueue

Parameters

queueName: string

Returns Promise<DeleteQueueResponse>

deleteRule

Parameters

topicName: string

subscriptionName: string

ruleName: string

Returns Promise<DeleteRuleResponse>

deleteSubscription

Parameters

topicName: string

subscriptionName: string

Returns Promise<DeleteSubscriptionResponse>

deleteTopic

Parameters

topicName: string

Returns Promise<DeleteTopicResponse>

getNamespaceProperties

Returns Promise<GetNamespaceResponse>

getQueue

Parameters

queueName: string

Returns Promise<GetQueueResponse>

getQueueRuntimeInfo

Parameters

queueName: string

Returns Promise<GetQueueRuntimeInfoResponse>

getQueues

Parameters

Optional listRequestOptions: ListRequestOptions

Returns Promise<GetQueuesResponse>

getQueuesRuntimeInfo

Parameters

Optional listRequestOptions: ListRequestOptions