Azure Service Bus icon

Azure Service Bus

Send and receive messages from Azure Service Bus

Actions3

Queue → Receive Messages

AI-generated

Summary

Receive messages from an Azure Service Bus queue using the Azure SDK protocol only, supporting standard queues and session-enabled queues with options to manage session state.

Inputs

  • Protocol (required) — Protocol to use for Azure Service Bus connection, must be 'Azure SDK' for receiving messages.
  • Queue Name (required) — Name of the Azure Service Bus queue to receive messages from.
  • Session Mode (required) — Specifies session handling: no sessions, a specific session by ID, or the next available session.
  • Session ID — ID of the specific session to receive messages from, required if session mode is 'Specific Session'.
  • Session Timeout (seconds) — Maximum time in seconds to wait when accepting a session (for session modes other than 'No Sessions').
  • Manage Session State — Whether to retrieve and update session state for the accepted session.
  • New Session State — JSON object as a string to update the session state after receiving messages; only used if Manage Session State is enabled.
  • Max Message Count (required) — Maximum number of messages to receive in this execution.
  • Max Wait Time (seconds) (required) — Maximum time in seconds to wait to receive messages.
  • Receive Mode (required) — Receive mode determining message locking behavior: 'Peek Lock' to lock messages requiring completion, or 'Receive and Delete' to delete immediately after receiving.

Output shape

a list of JSON objects, each representing a received message

Each output item contains message details including messageId, body (parsed if JSON), contentType, enqueue time, application properties, delivery count, sequence number, sessionId, plus sessionInfo if session receivers are used. The operation only supports the Azure SDK protocol and throws an error if HTTP REST API protocol is selected for receiving messages.

Examples

Example 1: Receive up to 5 messages from a standard queue without sessions using Peek Lock mode, waiting up to 30 seconds.

Set Protocol to 'Azure SDK', Resource to 'Queue', Operation to 'Receive Messages', enter the queue name, select Session Mode as 'No Sessions', set Max Message Count to 5, Max Wait Time to 30, and Receive Mode to 'Peek Lock'.

Example 2: Receive messages from a specific session with session state management.

Set Session Mode to 'Specific Session', specify the Session ID, enable 'Manage Session State', optionally provide new session state JSON, and configure other relevant parameters as above.

Links

Discussion