Azure Service Bus

azure Queueazure-service-bus

Managed enterprise queue with peek-lock delivery, built-in dead-letter sub-queue and optional sessions.

Provider: azure
Kind: Queue
Category: Messaging
Official docs: https://learn.microsoft.com/en-us/azure/service-bus-messaging/service-bus-messaging-overview

Properties · 7 set by this component

property	type	values	required	kind default	this component
backoff	enum	none \| fixed \| exponential \| exponential-jitter	no	—	inherited
deadLetterQueue	boolean	—	no	false	▸ true
delivery	enum	at-most-once \| at-least-once \| exactly-once	yes	—	▸ at-least-once
instances	integer	—	no	—	inherited
managed	boolean	—	no	false	▸ true
maxAttempts	integer	—	no	—	inherited
ordering	enum	none \| per-key \| global	no	none	▸ none
persistence	boolean	—	no	true	▸ true
replay	boolean	—	no	false	▸ false
retentionDays	integer	—	no	—	▸ 14
role	enum	work \| dlq \| retry \| offline-mailbox \| frontier	no	work	inherited
sessions · component property	boolean	—	no	false	inherited

Rules that apply · 3

Every rule whose selector covers this component's kind or its category. Whether a rule fires depends on the design: its properties, its edges and its groups.

Queue without dead-letter queueerror

queue-missing-dlq

A queue that receives asynchronous traffic and has no dead-letter queue either drops poison messages or retries them forever. Neither outcome leaves anything for a human to investigate.

— all of these hold:
— the node's `deadLetterQueue` is false
— the node has at least one asynchronous incoming edge

Retry queue without dead-letter queueerror

retry-queue-without-dlq

A retry queue is where poison messages end up. With no dead-letter queue they are retried forever or dropped in silence, and nobody ever looks at the failed payment.

— all of these hold:
— the node's `role` is "retry"
— the node's `deadLetterQueue` is false

Retry queue without backoffwarning

retry-without-backoff

Retrying a transient failure at full speed turns one slow dependency into a retry storm. A retry queue backs off, preferably exponentially and with jitter.

— all of these hold:
— the node's `role` is "retry"
— any of these hold:
— the node's `backoff` has no value
— the node's `backoff` is "none"

Use it in a design

nodes:
  - { id: "service-bus", component: "azure-service-bus" }

Other Queue products · 23

Source

1# yaml-language-server: $schema=../../schema/component.schema.json
2# Azure Service Bus: peek-lock at-least-once, every queue ships with a dead-letter sub-queue,
3# messages persisted, 14-day default TTL. Sessions (per-key ordering) are opt-in.
4schemaVersion: "1"
5type: "component"
6id: "azure-service-bus"
7kind: "queue"
8provider: "azure"
9docs: "https://learn.microsoft.com/en-us/azure/service-bus-messaging/service-bus-messaging-overview"
10defaults:
11  managed: true
12  delivery: "at-least-once"
13  ordering: "none"
14  deadLetterQueue: true
15  replay: false
16  retentionDays: 14
17  persistence: true
18properties:
19  sessions:
20    type: "boolean"
21    default: false

The same page as markdown, for an agent: /catalogue/components/azure-service-bus.md