Microsoft Azure Service Bus QueueReceiver

The QueueReceiver trigger is used to poll a particular queue for any messages that may be posted by one or more publishers in a one to one message delivery pattern. Messages posted to the queue by publishers are received by polling Queue receivers in a First In First Out format and only one queue receiver can retrieve any one message. All queue receivers to a particular queue within a namespace compete with each other to retrieve messages from the head of the queue. When creating a queue, you can check the box to specify whether or not to enable sessions.

You can enable Application properties for some fields by turning on the toggle if one is available. Application properties allow you to provide values for configuration fields.

Configuration

This tab has the following fields.

Field Description
AzureServiceBus Connection The AzureServiceBus Connection chosen for the QueueReceiver while creating the trigger is displayed here automatically.

If you wish to choose a different AzureServiceBus Connection than what was chosen in the settings page of Trigger creation, you can click on the drop down and choose a different one.

Queue Name of the queue to poll continuously for messages. A queue by that name must exist in the namespace of the broker.

Application Properties has been enabled for this field.

SessionId Name of the session from which to receive messages. When enabled, allows the QueueReceiver to listen for messages from the specified SessionID.

If a queue is session-enabled, but a SessionID is not specified, the QueueReceiver will randomly select a session and lock into that session ID. To change the selection you can edit the application properties for the SessionID field.

Receive Mode

Determines the Quality of Service while receiving messages from a Queue. You can choose from the following options:

  • PeekLock: Ensures that a message is delivered at least once.
  • ReceiveAndDelete: Messages are delivered in a "Best Effort" form.

The default option is PeekLock.

Output

The Output tab displays the schema in a tree format. The output is read-only. The following are elements in the output schema.

  1. output: The root of the output
    1. messageString: The string representation of the byte array of the received message.
    2. brokerProperties: A complex object that acts as a container for broker properties of the received message. The QueueReceiver trigger displays the following broker properties of a received message if available:
      • ContentType
      • CorrelationId
      • Label
      • PartitionKey
      • ReplyTo
      • SessionId
      • TimeToLive
      • To
    Note: For more information about brokerproperties, see Microsoft Azure Service Bus documentation.
Related concepts
Related tasks
Related reference