Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
Set-AzureRmServiceBusAuthorizationRule
- Module:
- AzureRM.ServiceBus Module
Updates the specified authorization rule description for the given Service Bus namespace or queue or topic.
Warning
The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.
Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.
Syntax
NamespaceAuthorizationRuleSet (Default)
Set-AzureRmServiceBusAuthorizationRule
[-ResourceGroupName] <String>
[-Namespace] <String>
[-Name] <String>
[[-InputObject] <PSSharedAccessAuthorizationRuleAttributes>]
[[-Rights] <String[]>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
QueueAuthorizationRuleSet
Set-AzureRmServiceBusAuthorizationRule
[-ResourceGroupName] <String>
[-Namespace] <String>
[-Queue] <String>
[-Name] <String>
[[-InputObject] <PSSharedAccessAuthorizationRuleAttributes>]
[[-Rights] <String[]>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
TopicAuthorizationRuleSet
Set-AzureRmServiceBusAuthorizationRule
[-ResourceGroupName] <String>
[-Namespace] <String>
[-Topic] <String>
[-Name] <String>
[[-InputObject] <PSSharedAccessAuthorizationRuleAttributes>]
[[-Rights] <String[]>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
AuthoRuleInputObjectSet
Set-AzureRmServiceBusAuthorizationRule
[-ResourceGroupName] <String>
[-Name] <String>
[-InputObject] <PSSharedAccessAuthorizationRuleAttributes>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Set-AzureRmServiceBusAuthorizationRule cmdlet updates the description for the specified authorization rule in the given Service Bus namespace or queue or topic.
Examples
Example 1
PS C:\> $authRuleObj = Get-AzureRmServiceBusNamespaceAuthorizationRule -ResourceGroup Default-ServiceBus-WestUS -Namespace SB-Example1 -Name AuthoRule1
PS C:\> $authRuleObj.Rights.Remove("Manage")
PS C:\> Set-AzureRmServiceBusNamespaceAuthorizationRule -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
PS C:\> $authRuleObj = Get-AzureRmServiceBusNamespaceAuthorizationRule -ResourceGroup Default-ServiceBus-WestUS -Namespace SB-Example1 -Queue SBQueue -Name AuthoRule1
PS C:\> $authRuleObj.Rights.Remove("Manage")
PS C:\> Set-AzureRmServiceBusNamespaceAuthorizationRule -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 2
PS C:\> $authRuleObj = Get-AzureRmServiceBusNamespaceAuthorizationRule -ResourceGroup Default-ServiceBus-WestUS -Namespace SB-Example1 -Topic SBTopic -Name AuthoRule1
PS C:\> $authRuleObj.Rights.Remove("Manage")
PS C:\> Set-AzureRmServiceBusNamespaceAuthorizationRule -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.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Parameter properties
| Type: | IAzureContextContainer |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | AzureRmContext, AzureCredential |
Parameter sets
-InputObject
ServiceBus AuthorizationRule Object
Parameter properties
| Type: | PSSharedAccessAuthorizationRuleAttributes |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | AuthRuleObj |
Parameter sets
-Name
AuthorizationRule Name
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | AuthorizationRuleName |
Parameter sets
-Namespace
Namespace Name
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | NamespaceName |
Parameter sets
-Queue
Queue Name
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | QueueName |
Parameter sets
-ResourceGroupName
Resource Group Name
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Rights
Rights, e.g. @("Listen","Send","Manage")
Parameter properties
| Type: | String[] |
| Default value: | None |
| Accepted values: | Listen, Send, Manage |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Topic
Topic Name
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | TopicName |
Parameter sets
-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
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.
Inputs
String
PSSharedAccessAuthorizationRuleAttributes
Parameters: InputObject (ByValue)