Skip to content

Commit bc89988

Browse files
committed
address PR review: add Features, Limitations, Samples sections and JSON output examples
- Add Features, Limitations, and Samples sections before API Coverage - Add JSON output examples for queue show/list and subscription show/list - Add note about countDetails accuracy in the emulator Made-with: Cursor
1 parent 040dabd commit bc89988

File tree

1 file changed

+129
-0
lines changed

1 file changed

+129
-0
lines changed

src/content/docs/azure/services/service-bus.mdx

Lines changed: 129 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126,12 +126,60 @@ azlocal servicebus queue show \
126126
--resource-group rg-servicebus-demo \
127127
--namespace-name sbnsdoc83 \
128128
--name orders-queue
129+
```
130+
131+
```bash title="Output"
132+
{
133+
"accessedAt": "2026-03-18T10:13:18.3906198Z",
134+
"autoDeleteOnIdle": "P10675199DT2H48M5.4775807S",
135+
"countDetails": {
136+
"activeMessageCount": 0,
137+
"deadLetterMessageCount": 0,
138+
"scheduledMessageCount": 0,
139+
"transferDeadLetterMessageCount": 0,
140+
"transferMessageCount": 0
141+
},
142+
...
143+
"name": "orders-queue",
144+
...
145+
"status": "Active",
146+
"type": "Microsoft.ServiceBus/namespaces/queues",
147+
...
148+
}
149+
```
129150

151+
```bash
130152
azlocal servicebus queue list \
131153
--resource-group rg-servicebus-demo \
132154
--namespace-name sbnsdoc83
133155
```
134156

157+
```bash title="Output"
158+
[
159+
{
160+
"accessedAt": "2026-03-18T10:14:44.3808099Z",
161+
"autoDeleteOnIdle": "P10675199DT2H48M5.4775807S",
162+
"countDetails": {
163+
"activeMessageCount": 0,
164+
"deadLetterMessageCount": 0,
165+
"scheduledMessageCount": 0,
166+
"transferDeadLetterMessageCount": 0,
167+
"transferMessageCount": 0
168+
},
169+
...
170+
"name": "orders-queue",
171+
...
172+
"status": "Active",
173+
"type": "Microsoft.ServiceBus/namespaces/queues",
174+
...
175+
}
176+
]
177+
```
178+
179+
:::note
180+
The values under `countDetails` may not be accurate in the emulator.
181+
:::
182+
135183
### Create topic and subscription
136184

137185
Create a topic and a subscription:
@@ -172,13 +220,61 @@ azlocal servicebus topic subscription show \
172220
--namespace-name sbnsdoc83 \
173221
--topic-name orders-topic \
174222
--name orders-sub
223+
```
175224

225+
```bash title="Output"
226+
{
227+
"accessedAt": "2026-03-18T10:13:18.3906198Z",
228+
"autoDeleteOnIdle": "P10675199DT2H48M5.4775807S",
229+
"countDetails": {
230+
"activeMessageCount": 0,
231+
"deadLetterMessageCount": 0,
232+
"scheduledMessageCount": 0,
233+
"transferDeadLetterMessageCount": 0,
234+
"transferMessageCount": 0
235+
},
236+
...
237+
"name": "orders-sub",
238+
...
239+
"status": "Active",
240+
"type": "Microsoft.ServiceBus/namespaces/topics/subscriptions",
241+
...
242+
}
243+
```
244+
245+
```bash
176246
azlocal servicebus topic subscription list \
177247
--resource-group rg-servicebus-demo \
178248
--namespace-name sbnsdoc83 \
179249
--topic-name orders-topic
180250
```
181251

252+
```bash title="Output"
253+
[
254+
{
255+
"accessedAt": "2026-03-18T10:14:44.3808099Z",
256+
"autoDeleteOnIdle": "P10675199DT2H48M5.4775807S",
257+
"countDetails": {
258+
"activeMessageCount": 0,
259+
"deadLetterMessageCount": 0,
260+
"scheduledMessageCount": 0,
261+
"transferDeadLetterMessageCount": 0,
262+
"transferMessageCount": 0
263+
},
264+
...
265+
"name": "orders-sub",
266+
...
267+
"status": "Active",
268+
"type": "Microsoft.ServiceBus/namespaces/topics/subscriptions",
269+
...
270+
}
271+
]
272+
```
273+
274+
:::note
275+
The values under `countDetails` may not be accurate in the emulator.
276+
:::
277+
182278
### Create and list subscription rules
183279

184280
Create a SQL filter rule for the subscription:
@@ -275,6 +371,39 @@ azlocal servicebus namespace authorization-rule keys renew \
275371
}
276372
```
277373

374+
## Features
375+
376+
The emulator includes the following core capabilities:
377+
378+
- **Data Plane REST API**: Supports message-level operations, including Send, Receive, and Peek.
379+
- **Control Plane REST API**: Enables CRUD operations for namespaces and messaging entities (queues, topics, and subscriptions) via Azure Resource Manager (ARM).
380+
- **Multiple Authentication Modes**: Supports both Connection String and Managed Identity authentication.
381+
- **Containerized Deployment**: Runs as a lightweight, Linux-based Docker container.
382+
- **Cross-Platform Compatibility**: Fully compatible with Windows, macOS, and Linux environments.
383+
- **Flexible Configuration**: Manage Service Bus entities via the Service Bus Administration Client or through JSON-based configuration files.
384+
- **Advanced Streaming**: Supports message streaming via the Advanced Message Queuing Protocol (AMQP).
385+
386+
## Limitations
387+
388+
The current version of the emulator does **not** support the following:
389+
390+
- **Protocols**: JMS protocol streaming and AMQP Web Sockets (AMQP over TCP is the only supported transport).
391+
- **Messaging Patterns**: Transactions, auto-forwarding (queue chaining), and message lock renewal.
392+
- **Validation**: Enforcements such as maximum entity counts or maximum message sizes.
393+
- **Metrics**: Property-based message counts for queues, topics, and subscriptions may be inaccurate.
394+
395+
The following Azure-native features are currently unavailable in the emulator:
396+
397+
- **Scaling & Resiliency**: Autoscale, Geo-disaster recovery, and Large Message support.
398+
- **Monitoring**: Visual metrics, alerts, and telemetry dashboards.
399+
400+
## Samples
401+
402+
Explore the following samples to get started with Service Bus on LocalStack:
403+
404+
- [Azure Functions App with Service Bus Messaging](https://github.com/localstack/localstack-azure-samples/blob/main/samples/function-app-service-bus/dotnet/)
405+
- [Azure Service Bus with Spring Boot](https://github.com/localstack/localstack-azure-samples/tree/main/samples/servicebus/java)
406+
278407
## API Coverage
279408

280409
<AzureFeatureCoverage service="Microsoft.ServiceBus" client:load />

0 commit comments

Comments
 (0)