Path of the entity for which the sender has been created.
Returns true
if either the sender or the client that created it has been closed.
Cancels multiple messages that were scheduled to appear on a ServiceBus Queue/Subscription.
Sequence number or an array of sequence numbers of the messages to be cancelled.
Options bag to pass an abort signal or tracing options.
Closes the underlying AMQP sender link.
Once closed, the sender cannot be used for any further operations.
Use the createSender
function on the QueueClient or TopicClient to instantiate a new Sender
Creates an instance of ServiceBusMessageBatch
to which one can add messages until the maximum supported size is reached.
The batch can be passed to the {@link send} method to send the messages to Azure Service Bus.
Configures the behavior of the batch.
maxSizeInBytes
: The upper limit for the size of batch. The tryAdd
function will return false
after this limit is reached.Schedules given messages to appear on Service Bus Queue/Subscription at a later time.
Message or an array of messages that need to be scheduled.
The UTC time at which the messages should be enqueued.
Options bag to pass an abort signal or tracing options.
The sequence numbers of messages that were scheduled.
You will need the sequence number if you intend to cancel the scheduling of the messages.
Save the Long
type as-is in your application without converting to number. Since JavaScript
only supports 53 bit numbers, converting the Long
to number will cause loss in precision.
Sends the given messages after creating an AMQP Sender link if it doesn't already exist.
session
and/or partition
enabled Queue/Topic, set the sessionId
and/or partitionKey
properties respectively on the messages.sessionId
(if using
sessions) and the same partitionKey
(if using partitions).A single message or an array of messages or a batch of messages created via the createBatch() method to send.
Options bag to pass an abort signal or tracing options.
Generated using TypeDoc
A Sender can be used to send messages, schedule messages to be sent at a later time and cancel such scheduled messages. Use the
createSender
function on the ServiceBusClient to instantiate a Sender. The Sender class is an abstraction over the underlying AMQP sender link.