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

Updates the specified authorization rule description for the given Service Bus namespace or queue or topic.

Syntax

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

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

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

Set-AzServiceBusAuthorizationRule
   [-ResourceGroupName] <String>
   [-Name] <String>
   [-InputObject] <PSSharedAccessAuthorizationRuleAttributes>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-AzServiceBusAuthorizationRule cmdlet updates the description for the specified authorization rule in the given Service Bus namespace or queue or topic.

Examples

Example 1

$authRuleObj = Get-AzServiceBusNamespaceAuthorizationRule -ResourceGroup Default-ServiceBus-WestUS -Namespace SB-Example1 -Name AuthoRule1

$authRuleObj.Rights.Remove("Manage")

Set-AzServiceBusNamespaceAuthorizationRule -ResourceGroup Default-ServiceBus-WestUS -Namespace SB-Example1 -Name AuthoRule1 -InputObj $authRuleObj

Removes Manage from the access rights of the authorization rule AuthoRule1 in namespace SB-Example1.

Example 2

$authRuleObj = Get-AzServiceBusNamespaceAuthorizationRule -ResourceGroup Default-ServiceBus-WestUS -Namespace SB-Example1 -Queue SBQueue -Name AuthoRule1

$authRuleObj.Rights.Remove("Manage")

Set-AzServiceBusNamespaceAuthorizationRule -ResourceGroup Default-ServiceBus-WestUS -Namespace SB-Example1 -Queue SBQueue -Name AuthoRule1 -InputObj $authRuleObj

Removes Manage from the access rights of the authorization rule AuthoRule1 in queue SBQueue.

Example 3

$authRuleObj = Get-AzServiceBusNamespaceAuthorizationRule -ResourceGroup Default-ServiceBus-WestUS -Namespace SB-Example1 -Topic SBTopic -Name AuthoRule1

$authRuleObj.Rights.Remove("Manage")

Set-AzServiceBusNamespaceAuthorizationRule -ResourceGroup Default-ServiceBus-WestUS -Namespace SB-Example1 -Topic SBTopic -Name AuthoRule1 -InputObj $authRuleObj

Removes Manage from the access rights of the authorization rule AuthoRule1 in 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

-InputObject

ServiceBus AuthorizationRule Object

Type:	PSSharedAccessAuthorizationRuleAttributes
Aliases:	AuthRuleObj
Position:	4
Default value:	None
Accept pipeline input:	True
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:	4
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

PSSharedAccessAuthorizationRuleAttributes

String[]

Outputs

PSSharedAccessAuthorizationRuleAttributes