Microsoft Azure Service Bus TopicSubscriber

The TopicSubscriber trigger is used to subscribe to a particular Topic for any messages that may be posted by one or more publishers in a one to many message delivery pattern. Messages posted to a topic by publishers are copied to subscriptions registered on that topic and are pushed out to many subscribers behind the subscription. Therefore, a single message published by a publisher to a topic can be pushed out to more than one subscriber. You can create multiple subscriptions and have receivers listen to those subscriptions. When creating a subscription, 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 Azure Service Bus connection chosen for the TopicSubscriber 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.

Topic Name of the Topic to subscribe to. A topic by that name must exist in the Namespace of the broker.

Application Properties has been enabled for this field.

Subscription Name Name for a subscription that will subscribe to messages on a Topic. A subscription by that name may or may not exist already on that topic. If it doesn't exist, it is created by the Trigger.

Application Properties has been enabled for this field.

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

If a subscription is session-enabled, but a SessionID is not specified, the TopicSubscriber 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.

Output

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

  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 TopicSubscriber 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