Get-​Azure​Rm​Service​Bus​Queue​Key

Gets the primary and secondary connection strings for the given Service Bus queue.

Syntax

Get-AzureRmServiceBusQueueKey
   [-ResourceGroup] <String>
   [-NamespaceName] <String>
   [-QueueName] <String>
   [-AuthorizationRuleName] <String>
   [<CommonParameters>]

Description

The Get-AzureRmServiceBusQueueKey cmdlet returns the primary and secondary connection strings for the given Service Bus queue.

Examples

Example 1

PS C:\> Get-AzureRmServiceBusQueueKey -ResourceGroup Default-ServiceBus-WestUS -NamespaceName SB-Example1 -QueueName SB-Queue_exampl1 -AuthorizationRuleName SBAuthoRule1

Returns the primary and secondary connection strings for the specified Service Bus queue.

Required Parameters

-AuthorizationRuleName

The queue authorization rule name.

Type:String
Position:3
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-NamespaceName

The Service Bus namespace name.

Type:String
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-QueueName

The Service Bus queue name.

Type:String
Position:2
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ResourceGroup

The name of the resource group.

Type:String
Position:0
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Inputs

-ResourceGroup

System.String

Inputs

-NamespaceName

System.String

Inputs

-QueueName

System.String

Inputs

-AuthorizationRuleName

System.String

Outputs

Microsoft.Azure.Commands.ServiceBus.Models.ListKeysAttributes

PrimaryConnectionString : Endpoint=sb://sb-example1.servicebus.windows.net/;SharedAccessKeyName=SBAuthoRule1;SharedAccessKey={SharedAccessKey-value};EntityPath=SB-Queue_e xampl1 SecondaryConnectionString : Endpoint=sb://sb-example1.servicebus.windows.net/;SharedAccessKeyName=SBAuthoRule1;SharedAccessKey={SharedAccessKey-value};EntityPath=SB-Queue_e xampl1 PrimaryKey : {PrimaryKey value} SecondaryKey : {SecondaryKey value} KeyName : SBAuthoRule1