Package version
A connection string for Azure Service Bus. NOTE: this connection string can contain an EntityPath, which is ignored.
Options for the service bus client.
The full 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 an 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.
Options for the service bus client.
The fully qualified namespace of the Service Bus instance for which this client is created.
This is likely to be similar to
Closes the underlying AMQP connection. NOTE: this will also disconnect any Receiver or Sender instances created from this instance.
Creates a receiver for an Azure Service Bus queue's dead letter queue in peekLock mode.
In peekLock mode, the receiver has a lock on the message for the duration specified on the queue.
In peekLock mode, the receiver has a lock on the message for the duration specified on the queue. Messages that are not settled within the lock duration will be redelivered.
You can settle a message by calling complete(), abandon() or defer() methods on the message.
See here for more information about dead letter queues: https://docs.microsoft.com/en-us/azure/service-bus-messaging/service-bus-dead-letter-queues
More information about how peekLock and message settlement works here: https://docs.microsoft.com/en-us/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
The name of the queue to receive from.
The receive mode, defaulted to peekLock.
Creates a receiver for an Azure Service Bus queue's dead letter queue in receiveAndDelete mode.
In receiveAndDelete mode, messages are deleted from Service Bus as they are received.
See here for more information about dead letter queues: https://docs.microsoft.com/en-us/azure/service-bus-messaging/service-bus-dead-letter-queues
The name of the queue to receive from.
The receive mode, defaulted to receiveAndDelete.
Creates a receiver for an Azure Service Bus subscription's dead letter queue in peekLock mode.
In peekLock mode, the receiver has a lock on the message for the duration specified on the subscription. Messages that are not settled within the lock duration will be redelivered.
You can settle a message by calling complete(), abandon() or defer() methods on the message.
See here for more information about dead letter queues: https://docs.microsoft.com/en-us/azure/service-bus-messaging/service-bus-dead-letter-queues
More information about how peekLock and message settlement works here: https://docs.microsoft.com/en-us/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
Name of the topic for the subscription we want to receive from.
Name of the subscription (under the topic) that we want to receive from.
The receive mode, defaulted to peekLock.
Creates a receiver for an Azure Service Bus subscription's dead letter queue in receiveAndDelete mode.
In receiveAndDelete mode, messages are deleted from Service Bus as they are received.
See here for more information about dead letter queues: https://docs.microsoft.com/en-us/azure/service-bus-messaging/service-bus-dead-letter-queues
Name of the topic for the subscription we want to receive from.
Name of the subscription (under the topic) that we want to receive from.
The receive mode, defaulted to receiveAndDelete.
Creates a receiver for an Azure Service Bus queue in peekLock mode.
In peekLock mode, the receiver has a lock on the message for the duration specified on the queue.
Messages that are not settled within the lock duration will be redelivered as many times as the max delivery count set on the queue, after which they get sent to a separate dead letter queue.
You can settle a message by calling complete(), abandon(), defer() or deadletter() methods on the message.
More information about how peekLock and message settlement works here: https://docs.microsoft.com/en-us/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
The name of the queue to receive from.
The receive mode, defaulted to peekLock.
Creates a receiver for an Azure Service Bus queue in receiveAndDelete mode.
In receiveAndDelete mode, messages are deleted from Service Bus as they are received.
The name of the queue to receive from.
The receive mode, defaulted to receiveAndDelete.
Creates a receiver for an Azure Service Bus subscription in peekLock mode.
In peekLock mode, the receiver has a lock on the message for the duration specified on the subscription.
Messages that are not settled within the lock duration will be redelivered as many times as the max delivery count set on the subscription, after which they get sent to a separate dead letter queue.
You can settle a message by calling complete(), abandon(), defer() or deadletter() methods on the message.
More information about how peekLock and message settlement works here: https://docs.microsoft.com/en-us/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
Name of the topic for the subscription we want to receive from.
Name of the subscription (under the topic) that we want to receive from.
The receive mode, defaulted to peekLock.
Creates a receiver for an Azure Service Bus subscription in receiveAndDelete mode.
In receiveAndDelete mode, messages are deleted from Service Bus as they are received.
Name of the topic for the subscription we want to receive from.
Name of the subscription (under the topic) that we want to receive from.
The receive mode, defaulted to receiveAndDelete.
Creates a Sender which can be used to send messages, schedule messages to be sent at a later time and cancel such scheduled messages.
The name of a queue or topic to send messages to.
Creates a receiver for a session enabled Azure Service Bus queue in peekLock mode.
In peekLock mode, the receiver has a lock on the session for the duration specified on the queue.
Messages that are not settled within the lock duration will be redelivered as many times as the max delivery count set on the queue, after which they get sent to a separate dead letter queue.
You can settle a message by calling complete(), abandon(), defer() or deadletter() methods on the message.
More information about how peekLock and message settlement works here: https://docs.microsoft.com/en-us/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
The name of the queue to receive from.
The receive mode, defaulted to peekLock.
Options for the receiver itself.
Creates a receiver for a session enabled Azure Service Bus queue in receiveAndDelete mode.
In receiveAndDelete mode, messages are deleted from Service Bus as they are received.
The name of the queue to receive from.
The receive mode, defaulted to receiveAndDelete.
Options for the receiver itself.
Creates a receiver for a session enabled Azure Service Bus subscription in peekLock mode.
In peekLock mode, the receiver has a lock on the session for the duration specified on the subscription.
Messages that are not settled within the lock duration will be redelivered as many times as the max delivery count set on the subscription, after which they get sent to a separate dead letter queue.
You can settle a message by calling complete(), abandon(), defer() or deadletter() methods on the message.
More information about how peekLock and message settlement works here: https://docs.microsoft.com/en-us/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
Name of the topic for the subscription we want to receive from.
Name of the subscription (under the topic) that we want to receive from.
The receive mode, defaulted to peekLock.
Options for the receiver itself.
Creates a receiver for a session enabled Azure Service Bus subscription in receiveAndDelete mode.
In receiveAndDelete mode, messages are deleted from Service Bus as they are received.
Name of the topic for the subscription we want to receive from.
Name of the subscription (under the topic) that we want to receive from.
The receive mode, defaulted to receiveAndDelete.
Options for the receiver itself.
Generated using TypeDoc
A client that can create Sender instances for sending messages to queues and topics as well as Receiver instances to receive messages from queues and subscriptions.