New-AzureRmServiceBusKey

Reference

Module:: AzureRM.ServiceBus

Regenerates the primary or secondary connection strings for the Service Bus namespace or queue or topic.

Warning

The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.

Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.

Syntax

New-AzureRmServiceBusKey
   [-ResourceGroupName] <String>
   [-Namespace] <String>
   [-Name] <String>
   -RegenerateKey <String>
   [-KeyValue <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

New-AzureRmServiceBusKey
   [-ResourceGroupName] <String>
   [-Namespace] <String>
   [-Queue] <String>
   [-Name] <String>
   -RegenerateKey <String>
   [-KeyValue <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

New-AzureRmServiceBusKey
   [-ResourceGroupName] <String>
   [-Namespace] <String>
   [-Topic] <String>
   [-Name] <String>
   -RegenerateKey <String>
   [-KeyValue <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The New-AzureRmServiceBusKey cmdlet generates new primary or secondary connection strings for the specified namespace or queue or topic and authorization rule.

Examples

Example 1

PS C:\> New-AzureRmServiceBusKey -ResourceGroup Default-ServiceBus-WestUS -Namespace SB-Example1 -Name AuthoRule1 -RegenerateKey PrimaryKey

Regenerates the primary or secondary connection strings for the namespace.

Example 1.1

PS C:\> New-AzureRmServiceBusKey -ResourceGroup Default-ServiceBus-WestUS -Namespace SB-Example1 -Name AuthoRule1 -RegenerateKey PrimaryKey -KeyValue {base64-encoded 256-bit key}

Regenerates the primary or secondary connection strings with provided Key value for the namespace.

Example 2

PS C:\> New-AzureRmServiceBusKey -ResourceGroup Default-ServiceBus-WestUS -Namespace SB-Example1 -Queue SBQueue -Name AuthoRule1 -RegenerateKey PrimaryKey

Regenerates the primary or secondary connection strings for the queue.

Example 2.2

PS C:\> New-AzureRmServiceBusKey -ResourceGroup Default-ServiceBus-WestUS -Namespace SB-Example1 -Queue SBQueue -Name AuthoRule1 -RegenerateKey PrimaryKey -KeyValue {base64-encoded 256-bit key}

Regenerates the primary or secondary connection strings with provided Key value for the queue.

Example 3

PS C:\> New-AzureRmServiceBusKey -ResourceGroup Default-ServiceBus-WestUS -Namespace SB-Example1 -Topic SBTopic -Name AuthoRule1 -RegenerateKey PrimaryKey

Regenerates the primary or secondary connection strings for the topic.

Example 3.1

PS C:\> New-AzureRmServiceBusKey -ResourceGroup Default-ServiceBus-WestUS -Namespace SB-Example1 -Topic SBTopic -Name AuthoRule1 -RegenerateKey PrimaryKey -KeyValue {base64-encoded 256-bit key}

Regenerates the primary or secondary connection strings with provided Key value for the topic.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultProfile

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

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

-KeyValue

A base64-encoded 256-bit key for signing and validating the SAS token.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Name

AuthorizationRule Name.

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

-Namespace

Namespace Name

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

-Queue

Queue Name

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

-RegenerateKey

Regenerate Keys - 'PrimaryKey'/'SecondaryKey'.

Type:	String
Accepted values:	PrimaryKey, SecondaryKey
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-ResourceGroupName

Resource Group Name

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

-Topic

Topic Name

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

String

Outputs

PSListKeysAttributes