Azure Service Bus PowerShell Reference

Common Cmdlets

Here are some of the most frequently used cmdlets in the az.servicebus module.

New-AzServiceBusNamespace -Name "myNamespace" -ResourceGroupName "myResourceGroup" -Location "East US"

Creates a new Azure Service Bus namespace.

Get-AzServiceBusNamespace -ResourceGroupName "myResourceGroup"

Retrieves one or more Service Bus namespaces within a resource group.

Remove-AzServiceBusNamespace -Name "myNamespace" -ResourceGroupName "myResourceGroup"

Deletes an Azure Service Bus namespace.

New-AzServiceBusQueue -NamespaceName "myNamespace" -ResourceGroupName "myResourceGroup" -Name "myQueue"

Creates a new queue within a Service Bus namespace.

Get-AzServiceBusQueue -NamespaceName "myNamespace" -ResourceGroupName "myResourceGroup"

Retrieves one or more queues within a Service Bus namespace.

New-AzServiceBusTopic -NamespaceName "myNamespace" -ResourceGroupName "myResourceGroup" -Name "myTopic"

Creates a new topic within a Service Bus namespace.

Get-AzServiceBusTopic -NamespaceName "myNamespace" -ResourceGroupName "myResourceGroup"

Retrieves one or more topics within a Service Bus namespace.

Cmdlet Parameters

Each cmdlet has various parameters to customize its behavior. Use Get-Help <CmdletName> -Full for detailed parameter information.

Cmdlet	Common Parameters	Description
`New-AzServiceBusNamespace`	-Name, -ResourceGroupName, -Location, -Sku, -Capacity	Creates a new Service Bus namespace.
`Get-AzServiceBusNamespace`	-ResourceGroupName, -Name, -ResourceGroup	Gets Service Bus namespaces.
`Remove-AzServiceBusNamespace`	-Name, -ResourceGroupName, -Force	Deletes a Service Bus namespace.
`New-AzServiceBusQueue`	-NamespaceName, -ResourceGroupName, -Name, -EnableDeadLettering, -MaxDeliveryCount	Creates a Service Bus queue.
`Get-AzServiceBusQueue`	-NamespaceName, -ResourceGroupName, -Name	Gets Service Bus queues.
`Remove-AzServiceBusQueue`	-NamespaceName, -ResourceGroupName, -Name, -Force	Deletes a Service Bus queue.
`New-AzServiceBusTopic`	-NamespaceName, -ResourceGroupName, -Name, -EnablePartitioning	Creates a Service Bus topic.
`Get-AzServiceBusTopic`	-NamespaceName, -ResourceGroupName, -Name	Gets Service Bus topics.
`Remove-AzServiceBusTopic`	-NamespaceName, -ResourceGroupName, -Name, -Force	Deletes a Service Bus topic.
`New-AzServiceBusQueueAuthorizationRule`	-NamespaceName, -ResourceGroupName, -QueueName, -Name, -Rights	Creates an authorization rule for a queue.
`Get-AzServiceBusKey`	-NamespaceName, -ResourceGroupName, -Name, -KeyType	Gets authorization rule keys for a Service Bus entity.

Examples

Illustrative examples of how to use the az.servicebus cmdlets.

Create a Standard SKU Namespace with a Queue

New-AzResourceGroup -Name "myServiceBusRG" -Location "West Europe"
New-AzServiceBusNamespace -Name "myStdNamespace" -ResourceGroupName "myServiceBusRG" -Sku "Standard"
New-AzServiceBusQueue -NamespaceName "myStdNamespace" -ResourceGroupName "myServiceBusRG" -Name "myStandardQueue" -MaxMessageSizeInMB 1024 -DefaultMessageTimeToLive "1.00:00:00"

Create a Premium SKU Namespace with a Topic and Subscription

New-AzServiceBusNamespace -Name "myPremiumNamespace" -ResourceGroupName "myServiceBusRG" -Sku "Premium" -Capacity 1
New-AzServiceBusTopic -NamespaceName "myPremiumNamespace" -ResourceGroupName "myServiceBusRG" -Name "myNotificationTopic"
New-AzServiceBusSubscription -NamespaceName "myPremiumNamespace" -ResourceGroupName "myServiceBusRG" -TopicName "myNotificationTopic" -Name "criticalAlerts"

Get and List Authorization Rule Keys

Get-AzServiceBusNamespaceAuthorizationRule -NamespaceName "myStdNamespace" -ResourceGroupName "myServiceBusRG"
$authRule = Get-AzServiceBusNamespaceAuthorizationRule -NamespaceName "myStdNamespace" -ResourceGroupName "myServiceBusRG" -Name "RootManageSharedAccessKey"
Get-AzServiceBusKey -NamespaceName "myStdNamespace" -ResourceGroupName "myServiceBusRG" -Name $authRule.Name -KeyType PrimaryKey

az.servicebus