New-AzServiceBusKey
Regenerates the SASKey of a ServiceBus namespace, queue or topic.
Syntax
NewExpandedNamespace (Default)
New-AzServiceBusKey
-Name <String>
-NamespaceName <String>
-ResourceGroupName <String>
-KeyType <String>
[-SubscriptionId <String>]
[-KeyValue <String>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
NewExpandedTopic
New-AzServiceBusKey
-Name <String>
-NamespaceName <String>
-ResourceGroupName <String>
-TopicName <String>
-KeyType <String>
[-SubscriptionId <String>]
[-KeyValue <String>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
NewExpandedQueue
New-AzServiceBusKey
-Name <String>
-NamespaceName <String>
-ResourceGroupName <String>
-QueueName <String>
-KeyType <String>
[-SubscriptionId <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
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: cf
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Parameter properties
Type: PSObject
Default value: None Supports wildcards: False DontShow: False Aliases: AzureRMContext, AzureCredential
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-KeyType
The access key to regenerate.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: RegenerateKey
Parameter sets
(All)
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-KeyValue
Optional, if the key value provided, is set for KeyType or autogenerated Key value set for keyType
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Name
The name of the Authorization Rule
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: AuthorizationRuleName
Parameter sets
(All)
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-NamespaceName
The name of the ServiceBus namespace
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-NoWait
Run the command asynchronously
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-QueueName
The name of the ServiceBus queue.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
NewExpandedQueue
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ResourceGroupName
The name of the resource group.
The name is case insensitive.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SubscriptionId
The ID of the target subscription.
Parameter properties
Type: String
Default value: (Get-AzContext).Subscription.Id Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-TopicName
The name of the ServiceBus topic.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
NewExpandedTopic
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: wi
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters .
Outputs
