New-AzServiceBusAuthorizationRule

Is this page helpful?

Any additional feedback?

Feedback will be sent to Microsoft: By pressing the submit button, your feedback will be used to improve Microsoft products and services. Privacy policy.

Module:

Az.ServiceBus

Creates a new authorization rule for the specified Service Bus given Namespace or Queue or Topic.

Syntax

New-AzServiceBusAuthorizationRule
   [-ResourceGroupName] <String>
   [-Namespace] <String>
   [-Name] <String>
   -Rights <String[]>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

New-AzServiceBusAuthorizationRule
   [-ResourceGroupName] <String>
   [-Namespace] <String>
   [-Queue] <String>
   [-Name] <String>
   -Rights <String[]>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

New-AzServiceBusAuthorizationRule
   [-ResourceGroupName] <String>
   [-Namespace] <String>
   [-Topic] <String>
   [-Name] <String>
   -Rights <String[]>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The New-AzServiceBusAuthorizationRule cmdlet creates a new authorization rule for the specified Service Bus namespace or queue or topic.

Examples

Example 1

New-AzServiceBusAuthorizationRule -ResourceGroup Default-ServiceBus-WestUS -Namespace SB-Example1 -Name AuthoRule1 -Rights @("Listen","Send")

Creates AuthoRule1 with Listen and Send rights for the namespace SB-Example1.

Example 2

New-AzServiceBusAuthorizationRule -ResourceGroup Default-ServiceBus-WestUS -Namespace SB-Example1 -Queue SBQueue -Name AuthoRule1 -Rights @("Listen","Send")

Creates AuthoRule1 with Listen and Send rights for the queue SBQueue.

Example 3

New-AzServiceBusAuthorizationRule -ResourceGroup Default-ServiceBus-WestUS -Namespace SB-Example1 -Topic SBTopic -Name AuthoRule1 -Rights @("Listen","Send")

Creates AuthoRule1 with Listen and Send rights for the topic SBTopic.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Accept pipeline input:	False
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

-Rights

Rights, e.g. "Listen","Send","Manage"

Type:	String[]
Accepted values:	Listen, Send, Manage
Position:	Named
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

-WhatIf

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

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

Inputs

String

String[]

Outputs

PSSharedAccessAuthorizationRuleAttributes