< Back

Set-AzureRmServiceBusAuthorizationRule

Tue Jan 29, 2019 10:07 pm

NAME Set-AzureRmServiceBusAuthorizationRule



SYNOPSIS

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





SYNTAX

Set-AzureRmServiceBusAuthorizationRule [-ResourceGroupName] <String> [-Namespace] <String> [-Name] <String> [[-InputObject]

<PSSharedAccessAuthorizationRuleAttributes>] [[-Rights] {Listen | Send | Manage | Listen | Send | Manage}] [-DefaultProfile

<IAzureContextContainer>] [-Confirm] [-WhatIf] [<CommonParameters>]



Set-AzureRmServiceBusAuthorizationRule [-ResourceGroupName] <String> [-Namespace] <String> [-Queue] <String> [-Name] <String> [[-InputObject]

<PSSharedAccessAuthorizationRuleAttributes>] [[-Rights] {Listen | Send | Manage | Listen | Send | Manage}] [-DefaultProfile

<IAzureContextContainer>] [-Confirm] [-WhatIf] [<CommonParameters>]



Set-AzureRmServiceBusAuthorizationRule [-ResourceGroupName] <String> [-Namespace] <String> [-Topic] <String> [-Name] <String> [[-InputObject]

<PSSharedAccessAuthorizationRuleAttributes>] [[-Rights] {Listen | Send | Manage | Listen | Send | Manage}] [-DefaultProfile

<IAzureContextContainer>] [-Confirm] [-WhatIf] [<CommonParameters>]



Set-AzureRmServiceBusAuthorizationRule [-ResourceGroupName] <String> [-Name] <String> [-InputObject] <PSSharedAccessAuthorizationRuleAttributes>

[-DefaultProfile <IAzureContextContainer>] [-Confirm] [-WhatIf] [<CommonParameters>]



Set-AzureRmServiceBusAuthorizationRule [-ResourceGroupName] <String> [-Name] <String> [-Rights] {Listen | Send | Manage | Listen | Send | Manage}

[-DefaultProfile <IAzureContextContainer>] [-Confirm] [-WhatIf] [<CommonParameters>]





DESCRIPTION

The Set-AzureRmServiceBusAuthorizationRule cmdlet updates the description for the specified authorization rule in the given Service Bus namespace

or queue or topic.





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



-InputObject <PSSharedAccessAuthorizationRuleAttributes>

ServiceBus AuthorizationRule Object



Required? false

Position? 4

Default value None

Accept pipeline input? True (ByValue)

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



-ResourceGroupName <String>

Resource Group Name



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Rights <String[]>

Rights, e.g. @("Listen","Send","Manage")



Required? false

Position? 4

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

Microsoft.Azure.Commands.ServiceBus.Models.PSSharedAccessAuthorizationRuleAttributes System.String[]





OUTPUTS

Microsoft.Azure.Commands.ServiceBus.Models.PSSharedAccessAuthorizationRuleAttributes







NOTES









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







RELATED LINKS

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