Skip to content
Art2link ESB v2.02 LTS HomeDocumentationBlogContact
Core concepts/Adapters/Service Bus adapter
Adapter

Service Bus adapter

Bidirectional integration with Azure Service Bus. Speaks queues and topic subscriptions natively, with peek-lock on the consume side and standard publish semantics on the send side.

ADAPTER · RECEIVE · SEND Service Bus Azure Service Bus, queues and topic subscriptions, peek-lock consume Beta DIRECTION ↓ ↑ Receive & Send MODES One-way · Two-way AUTHENTICATION Service Bus Authentication PORT Receive or Send Beta

Azure Service Bus is the broker most Azure-hosted integrations end up touching. The adapter supports the two endpoint types Service Bus exposes (queues for point-to-point, and topic subscriptions for fan-out) on both the consume and send sides.

Entity types

One binding addresses one entity. Pick a queue when there is one logical reader; pick a topic + subscription when several independent consumers each need a copy.

Queue Pub Sub One reader at a time competing-consumers model workload distribution across consumers Topic + Subscriptions Pub topic SubA SubB SubC Each subscription gets its own copy independent readers, optional filters fan-out within Service Bus itself
Listener side, peek-lock consume

On a receive port, the adapter consumes via peek-lock: each message is leased, the bus publication is attempted, and the message is completed only after the publish succeeds. On exception the lease is released and Service Bus redelivers; the dead-letter queue eventually catches messages that fail repeatedly. Sessions are honoured when the queue or subscription is session-enabled, one session handler at a time per session id keeps messages in order.

Caller side, send to a queue or topic

On a send port, the adapter publishes the message body to the configured queue or topic. Standard properties (subject, content-type, time-to-live, session id, partition key) are templatable from the bus message. Two-way mode uses the Service Bus request/reply convention: a reply-to queue and a correlation id, the adapter waits for the response, and the response is republished to the bus as a payload.

Authentication

The Service Bus adapter pairs with a Service Bus Authentication. The Authentication carries the namespace endpoint and a credential, with two shapes supported: Shared Access Signature (SAS), a SAS key name and key value, sufficient when one connection string is enough; and Managed Identity, the runtime's Microsoft Entra identity is granted a Service Bus role on the namespace and no secrets are stored.

What you configure on the Service Bus adapter

Placeholder field set, verify against the running product. Beta details may change before GA.

Entity Type, required; Queue or Topic Subscription (Listener), or Queue or Topic (Caller).
Entity Name, required; queue name, or topic name.
Subscription Name, required when Entity Type is Topic Subscription.
Max Concurrent Messages, optional on Listener; prefetch and concurrency knob.
Sessions Enabled, optional toggle; required true when consuming a session-enabled entity.
Lock Renewal, optional on Listener; auto-renew the peek-lock during long-running receive flows.
Session Id, optional on Caller; templatable; required when publishing to a session-enabled queue or topic.
Time To Live, optional on Caller; defaults to the entity's default TTL.
Content Type, optional on Caller; defaults to application/octet-stream.
Reply To / Correlation Id, required on two-way Caller; the reply-to entity and correlation pattern.
Authentication, required; picker filtered to Service Bus Authentication objects in the same Application.

That is the Service Bus adapter

Queues and topic subscriptions, peek-lock on consume, request/reply on two-way send. Beta until GA. Back to Adapters.