DrDroid
Resource Cheatsheet

Azure Service Bus

Quick reference guide and commands for Azure Service Bus.

Download PDF

Connection

az login
Authenticate to Azure CLI

az account set --subscription
Set the subscription context

az servicebus namespace authorization-rule keys list --resource-group --namespace-name --name RootManageSharedAccessKey
Get connection string for a namespace

Namespace Management

az servicebus namespace create --resource-group --name --location --sku Standard
Create a new namespace

az servicebus namespace show --resource-group --name
Show details of a namespace

az servicebus namespace list --resource-group
List namespaces in a resource group

az servicebus namespace delete --resource-group --name
Delete a namespace

Queue Management

az servicebus queue create --resource-group --namespace-name --name
Create a queue

az servicebus queue show --resource-group --namespace-name --name
Show details of a queue

az servicebus queue list --resource-group --namespace-name
List queues in a namespace

az servicebus queue delete --resource-group --namespace-name --name
Delete a queue

Topic Management

az servicebus topic create --resource-group --namespace-name --name
Create a topic

az servicebus topic show --resource-group --namespace-name --name
Show details of a topic

az servicebus topic list --resource-group --namespace-name
List topics in a namespace

az servicebus topic delete --resource-group --namespace-name --name
Delete a topic

Subscription Management

az servicebus topic subscription create --resource-group --namespace-name --topic-name --name
Create a subscription

az servicebus topic subscription show --resource-group --namespace-name --topic-name --name
Show details of a subscription

az servicebus topic subscription list --resource-group --namespace-name --topic-name
List subscriptions in a topic

az servicebus topic subscription delete --resource-group --namespace-name --topic-name --name
Delete a subscription

Rule Management

az servicebus topic subscription rule create --resource-group --namespace-name --topic-name --subscription-name --name
Create a rule

az servicebus topic subscription rule show --resource-group --namespace-name --topic-name --subscription-name --name
Show details of a rule

az servicebus topic subscription rule list --resource-group --namespace-name --topic-name --subscription-name
List rules in a subscription

az servicebus topic subscription rule delete --resource-group --namespace-name --topic-name --subscription-name --name
Delete a rule

Message Operations (using Azure.Messaging.ServiceBus SDK)

await sender.SendMessageAsync(new ServiceBusMessage(body))
Send a message to a queue or topic

ServiceBusReceivedMessage message = await receiver.ReceiveMessageAsync()
Receive a message from a queue or subscription

await receiver.CompleteMessageAsync(message)
Mark a message as complete

await receiver.AbandonMessageAsync(message)
Abandon a message (return to queue/subscription)

await receiver.DeadLetterMessageAsync(message)
Send a message to dead-letter queue

await receiver.DeferMessageAsync(message)
Defer a message for later processing

Monitoring

az monitor metrics list --resource --metric "ActiveMessages"
Get active message count metric

az monitor metrics list --resource --metric "IncomingMessages"
Get incoming message count metric

az monitor metrics list --resource --metric "OutgoingMessages"
Get outgoing message count metric

az servicebus namespace list-dead-letter-messages --resource-group --namespace-name --queue-name
List dead letter messages in a queue

az servicebus namespace list-dead-letter-messages --resource-group --namespace-name --topic-name --subscription-name
List dead letter messages in a subscription