New-AzServiceBusKey

Module:

Az.ServiceBus

Regenerates the SASKey of a ServiceBus namespace, queue or topic.

Syntax

New-AzServiceBusKey
   -Name <String>
   -NamespaceName <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String>]
   -KeyType <String>
   [-KeyValue <String>]
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

New-AzServiceBusKey
   -Name <String>
   -NamespaceName <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String>]
   -TopicName <String>
   -KeyType <String>
   [-KeyValue <String>]
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

New-AzServiceBusKey
   -Name <String>
   -NamespaceName <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String>]
   -QueueName <String>
   -KeyType <String>
   [-KeyValue <String>]
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Regenerates the SASKey of a ServiceBus namespace, queue or topic.

Examples

Example 1: Regenerate Primary Key of a ServiceBus Namespace

New-AzServiceBusKey -ResourceGroupName myResourceGroup -NamespaceName myNamespace -Name rootmanagesharedaccesskey -KeyType PrimaryKey

KeyName                        : RootManageSharedAccessKey
PrimaryConnectionString        : {primaryConnectionString}
PrimaryKey                     : {primaryKey}
SecondaryConnectionString      : {secondaryConnectionString}
SecondaryKey                   : {secondaryKey}

Regenerate primary key of authorization rule rootmanagesharedaccesskey on ServiceBus Namespace myNamespace.

Example 2: Regenerate Secondary Key of a ServiceBus queue

New-AzServiceBusKey -ResourceGroupName myResourceGroup -NamespaceName myNamespace -QueueName myQueue -Name rootmanagesharedaccesskey -KeyType SecondaryKey

KeyName                        : RootManageSharedAccessKey
PrimaryConnectionString        : {primaryConnectionString}
PrimaryKey                     : {primaryKey}
SecondaryConnectionString      : {secondaryConnectionString}
SecondaryKey                   : {secondaryKey}

Regenerate secondary key of authorization rule rootmanagesharedaccesskey on ServiceBus queue myQueue from ServiceBus Namespace myNamespace.

Example 3: Regenerate Secondary Key of a ServiceBus topic

New-AzServiceBusKey -ResourceGroupName myResourceGroup -NamespaceName myNamespace -TopicName myTopic -Name rootmanagesharedaccesskey -KeyType SecondaryKey

KeyName                        : RootManageSharedAccessKey
PrimaryConnectionString        : {primaryConnectionString}
PrimaryKey                     : {primaryKey}
SecondaryConnectionString      : {secondaryConnectionString}
SecondaryKey                   : {secondaryKey}

Regenerate secondary key of authorization rule rootmanagesharedaccesskey on ServiceBus topic myTopic from ServiceBus Namespace myNamespace.

Parameters

-AsJob

Run the command as a job

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

-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:	PSObject
Aliases:	AzureRMContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-KeyType

The access key to regenerate.

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

-KeyValue

Optional, if the key value provided, is set for KeyType or autogenerated Key value set for keyType

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

-Name

The name of the Authorization Rule

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

-NamespaceName

The name of the ServiceBus namespace

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

-NoWait

Run the command asynchronously

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

-QueueName

The name of the ServiceBus queue.

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

-ResourceGroupName

The name of the resource group. The name is case insensitive.

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

-SubscriptionId

The ID of the target subscription.

Type:	String
Position:	Named
Default value:	(Get-AzContext).Subscription.Id
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-TopicName

The name of the ServiceBus topic.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
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

Outputs

IAccessKeys