ServiceBusToolset 1.5.0

ServiceBusToolset

A command-line tool for managing Azure Service Bus.

Installation

Global Tool (Recommended)

# Install from NuGet
dotnet tool install -g ServiceBusToolset

# Update to latest version
dotnet tool update -g ServiceBusToolset

# Install preview/alpha version
dotnet tool install -g ServiceBusToolset --prerelease

Build from Source

git clone https://github.com/kyurkchyan/ServiceBusToolset.git
cd ServiceBusToolset
dotnet build

Prerequisites

• .NET 10 SDK or later
• Azure CLI logged in (az login)

Commands

Quick Start

# Purge all DLQ messages from a queue
sbtools purge-dlq -n mynamespace.servicebus.windows.net -q myqueue

# Interactive mode - select which message categories to purge
sbtools purge-dlq -n mynamespace.servicebus.windows.net -q myqueue -i

# Resubmit DLQ messages back to the main queue
sbtools resubmit-dlq -n mynamespace.servicebus.windows.net -q myqueue

# Interactive mode - select which message categories to resubmit
sbtools resubmit-dlq -n mynamespace.servicebus.windows.net -q myqueue -i

# Dump DLQ messages to a JSON file
sbtools dump-dlq -n mynamespace.servicebus.windows.net -q myqueue -o dlq-messages.json

# Interactive mode - select which message categories to dump
sbtools dump-dlq -n mynamespace.servicebus.windows.net -q myqueue -o dlq-messages.json -i

# Categorize by custom properties (system #Prop, body $Prop)
sbtools dump-dlq -n mynamespace.servicebus.windows.net -q myqueue -o dlq-messages.json -i \
  --categorize-by "#DeadLetterReason,$ErrorCode"

# Diagnose DLQ messages using Application Insights
sbtools diagnose-dlq -n mynamespace.servicebus.windows.net -q myqueue \
  -a "/subscriptions/.../resourceGroups/.../providers/microsoft.insights/components/my-app-insights"

# Monitor all queues with live-updating table
sbtools monitor-queues -n mynamespace.servicebus.windows.net

# Monitor queues matching a pattern with 10-second refresh
sbtools monitor-queues -n mynamespace.servicebus.windows.net -f "order-*" -r 10

# Monitor all topic subscriptions
sbtools monitor-subscriptions -n mynamespace.servicebus.windows.net

# Monitor subscriptions for specific topics with subscription filter
sbtools monitor-subscriptions -n mynamespace.servicebus.windows.net -t "orders*" -s "*-processor"

Note: If running from source instead of the global tool, replace sbtools with dotnet run -- in the commands above.

Authentication

Uses DefaultAzureCredential. For local development, run az login.

License

MIT