<< All versions
Skill v1.0.0
currentAutomated scan100/100huytran1120/vietnam-agentic-skills/azure-servicebus-ts
──Details
PublishedNovember 20, 2026 at 12:09 AM
Content Hashsha256:f8b49a04a263f579...
Git SHA816da5094af3
──Files
Files (1 file, 7.2 KB)
SKILL.md7.2 KBactive
SKILL.md · 253 lines · 7.2 KB
name: azure-servicebus-ts description: "Enterprise messaging with queues, topics, and subscriptions." risk: critical source: community date_added: "2026-02-27" metadata: version: "1.0.0"
Azure Service Bus SDK for TypeScript
Enterprise messaging with queues, topics, and subscriptions.
Installation
bash
npm install @azure/service-bus @azure/identity
Environment Variables
bash
SERVICEBUS_NAMESPACE=<namespace>.servicebus.windows.netSERVICEBUS_QUEUE_NAME=my-queueSERVICEBUS_TOPIC_NAME=my-topicSERVICEBUS_SUBSCRIPTION_NAME=my-subscription
Authentication
typescript
import { ServiceBusClient } from "@azure/service-bus";import { DefaultAzureCredential } from "@azure/identity";const fullyQualifiedNamespace = process.env.SERVICEBUS_NAMESPACE!;const client = new ServiceBusClient(fullyQualifiedNamespace, new DefaultAzureCredential());
Delivery boundaries
Examples mutate queues and independent fragments reuse names. Sending, scheduling and settling messages require authorization for the exact namespace/entity. Make business processing idempotent before completion; peek-lock can redeliver after failure. Avoid logging private bodies, renew locks where needed and close the shared client on shutdown.
Core Workflow
Send Messages to Queue
typescript
const sender = client.createSender("my-queue");// Single messageawait sender.sendMessages({body: { orderId: "12345", amount: 99.99 },contentType: "application/json",});// Batch messagesconst batch = await sender.createMessageBatch();if (!batch.tryAddMessage({ body: "Message 1" }) ||!batch.tryAddMessage({ body: "Message 2" })) {throw new Error("Message batch exceeds size limit; split and retry deliberately");}await sender.sendMessages(batch);await sender.close();
Receive Messages from Queue
typescript
const receiver = client.createReceiver("my-queue");// Receive batchconst messages = await receiver.receiveMessages(10, { maxWaitTimeInMs: 5000 });for (const message of messages) {console.log(`Received: ${message.body}`);await receiver.completeMessage(message);}await receiver.close();
Subscribe to Messages (Event-Driven)
typescript
const receiver = client.createReceiver("my-queue");const subscription = receiver.subscribe({processMessage: async (message) => {console.log(`Processing: ${message.body}`);// Message auto-completed on success},processError: async (args) => {console.error(`Error: ${args.error}`);},});// Stop after some timesetTimeout(async () => {await subscription.close();await receiver.close();}, 60000);
Topics and Subscriptions
typescript
// Send to topicconst topicSender = client.createSender("my-topic");await topicSender.sendMessages({body: { event: "order.created", data: { orderId: "123" } },applicationProperties: { eventType: "order.created" },});// Receive from subscriptionconst subscriptionReceiver = client.createReceiver("my-topic", "my-subscription");const messages = await subscriptionReceiver.receiveMessages(10);
Message Sessions
typescript
// Send session messageconst sender = client.createSender("session-queue");await sender.sendMessages({body: { step: 1, data: "First step" },sessionId: "workflow-123",});// Receive session messagesconst sessionReceiver = await client.acceptSession("session-queue", "workflow-123");const messages = await sessionReceiver.receiveMessages(10);// Get/set session stateconst state = await sessionReceiver.getSessionState();await sessionReceiver.setSessionState(Buffer.from(JSON.stringify({ progress: 50 })));await sessionReceiver.close();
Dead-Letter Handling
typescript
// Move to dead-letterawait receiver.deadLetterMessage(message, {deadLetterReason: "Validation failed",deadLetterErrorDescription: "Missing required field: orderId",});// Process dead-letter queueconst dlqReceiver = client.createReceiver("my-queue", { subQueueType: "deadLetter" });const dlqMessages = await dlqReceiver.receiveMessages(10);for (const msg of dlqMessages) {console.log(`DLQ Reason: ${msg.deadLetterReason}`);// Inspect and durably record the authorized recovery outcome first.// Complete only after successful recovery; logging alone must not delete DLQ evidence.// await dlqReceiver.completeMessage(msg);}
Scheduled Messages
typescript
const sender = client.createSender("my-queue");// Schedule for future deliveryconst scheduledTime = new Date(Date.now() + 60000); // 1 minute from nowconst sequenceNumber = await sender.scheduleMessages({ body: "Delayed message" },scheduledTime);// Cancel scheduled messageawait sender.cancelScheduledMessages(sequenceNumber);
Message Deferral
typescript
// Defer message for laterawait receiver.deferMessage(message);// Receive deferred message by sequence numberconst deferredMessage = await receiver.receiveDeferredMessages(message.sequenceNumber!);await receiver.completeMessage(deferredMessage[0]);
Peek Messages (Non-Destructive)
typescript
const receiver = client.createReceiver("my-queue");// Peek without removingconst peekedMessages = await receiver.peekMessages(10);for (const msg of peekedMessages) {console.log(`Peeked: ${msg.body}`);}
Key Types
typescript
import {ServiceBusClient,ServiceBusSender,ServiceBusReceiver,ServiceBusSessionReceiver,ServiceBusMessage,ServiceBusReceivedMessage,ProcessMessageCallback,ProcessErrorCallback,} from "@azure/service-bus";
Receive Modes
typescript
// Peek-Lock (default) - message locked until completed/abandonedconst receiver = client.createReceiver("my-queue", { receiveMode: "peekLock" });await receiver.completeMessage(message); // Remove from queueawait receiver.abandonMessage(message); // Return to queueawait receiver.deferMessage(message); // Defer for laterawait receiver.deadLetterMessage(message); // Move to DLQ// Receive-and-Delete - message removed immediatelyconst receiver = client.createReceiver("my-queue", { receiveMode: "receiveAndDelete" });
Best Practices
- Use Entra ID auth - Avoid connection strings in production
- Reuse clients - Create
ServiceBusClientonce, share across senders/receivers - Close resources - Always close senders/receivers when done
- Handle errors - Implement
processErrorcallback for subscription receivers - Use sessions for ordering - When message order matters within a group
- Configure dead-letter - Always handle DLQ messages
- Batch sends - Use
createMessageBatch()for multiple messages
Reference Documentation
For detailed patterns, see:
- Queues vs Topics Patterns - Queue/topic patterns, sessions, receive modes, message settlement
- Error Handling and Reliability - ServiceBusError codes, DLQ handling, lock renewal, graceful shutdown
When to Use
This skill is applicable to execute the workflow or actions described in the overview.
Limitations
- Use this skill only when the task clearly matches the scope described above.
- Do not treat the output as a substitute for environment-specific validation, testing, or expert review.
- Stop and ask for clarification if required inputs, permissions, safety boundaries, or success criteria are missing.