New-AzureRmServiceBusKey

NAME New-AzureRmServiceBusKey



SYNOPSIS

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





SYNTAX

New-AzureRmServiceBusKey [-ResourceGroupName] <String> [-Namespace] <String> [-Queue] <String> [-Name] <String> [-DefaultProfile

<IAzureContextContainer>] -RegenerateKey {PrimaryKey | SecondaryKey} [-Confirm] [-WhatIf] [<CommonParameters>]



New-AzureRmServiceBusKey [-ResourceGroupName] <String> [-Namespace] <String> [-Topic] <String> [-Name] <String> [-DefaultProfile

<IAzureContextContainer>] -RegenerateKey {PrimaryKey | SecondaryKey} [-Confirm] [-WhatIf] [<CommonParameters>]





DESCRIPTION

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

authorization rule.





PARAMETERS

-DefaultProfile <IAzureContextContainer>

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



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Name <String>

AuthorizationRule Name.



Required? true

Position? 3

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Namespace <String>

Namespace Name



Required? true

Position? 1

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Queue <String>

Queue Name



Required? true

Position? 2

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-RegenerateKey <String>

Regenerate Keys - 'PrimaryKey'/'SecondaryKey'.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ResourceGroupName <String>

Resource Group Name



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Topic <String>

Topic Name



Required? true

Position? 2

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Confirm [<SwitchParameter>]

Prompts you for confirmation before running the cmdlet.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

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



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

System.String







OUTPUTS

Microsoft.Azure.Commands.ServiceBus.Models.PSListKeysAttributes







NOTES









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 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 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.







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... vicebuskey