Get-AzServiceBusKey

Reference

Module:: Az.ServiceBus

Gets the primary and secondary connection strings for the given Namespace or Queue or Topic or Alias (GeoDR Configurations).

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Syntax

Get-AzServiceBusKey
   [-ResourceGroupName] <String>
   [-Namespace] <String>
   [-Name] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzServiceBusKey
   [-ResourceGroupName] <String>
   [-Namespace] <String>
   [-Queue] <String>
   [-Name] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzServiceBusKey
   [-ResourceGroupName] <String>
   [-Namespace] <String>
   [-Topic] <String>
   [-Name] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzServiceBusKey
   [-ResourceGroupName] <String>
   [-Namespace] <String>
   [-AliasName] <String>
   [-Name] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Get-AzServiceBusKey cmdlet returns the primary and secondary connection strings for the given Namespace or Queue or Topic or Alias (GeoDR Configurations).

Examples

Example 1

Get-AzServiceBusKey -ResourceGroup Default-ServiceBus-WestUS -Namespace SB-Example1 -Name AuthoRule1

Primary and secondary connection string to the specified namespace.

Example 2

Get-AzServiceBusKey -ResourceGroup Default-ServiceBus-WestUS -Namespace SB-Example1 -Queue SBQueue -Name AuthoRule1

Primary and secondary connection string to the specified queue.

Example 3

Get-AzServiceBusKey -ResourceGroup Default-ServiceBus-WestUS -Namespace SB-Example1 -Topic SBTopic -Name AuthoRule1

Primary and secondary connection string to the specified topic.

Example 4

Get-AzServiceBusKey -ResourceGroup Default-ServiceBus-WestUS -Namespace SB-Example1 -AliasName SBAlias -Name AuthoRule1

Primary and secondary connection string to the specified namespace and alias.

Parameters

-AliasName

Alias Name

Type:	String
Position:	2
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-Name

AuthorizationRule Name

Type:	String
Aliases:	AuthorizationRuleName
Position:	3
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-Namespace

Namespace Name

Type:	String
Aliases:	NamespaceName
Position:	1
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-Queue

Queue Name

Type:	String
Aliases:	QueueName
Position:	2
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-ResourceGroupName

Resource Group Name

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

-Topic

Topic Name

Type:	String
Aliases:	TopicName
Position:	2
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

Inputs

String

Outputs

PSListKeysAttributes