Set-AzureSBAuthorizationRule
Updates existing Service Bus authorization rule.
Note
The cmdlets referenced in this documentation are for managing legacy Azure resources that use Azure Service Manager (ASM) APIs. This legacy PowerShell module isn't recommended when creating new resources since ASM is scheduled for retirement. For more information, see Azure Service Manager retirement.
The Az PowerShell module is the recommended PowerShell module for managing Azure Resource Manager (ARM) resources with PowerShell.
Syntax
Set-AzureSBAuthorizationRule
-Name <String>
[-Permission <AccessRights[]>]
-Namespace <String>
-EntityName <String>
-EntityType <ServiceBusEntityType>
[-PrimaryKey <String>]
[-SecondaryKey <String>]
[-Profile <AzureSMProfile>]
[<CommonParameters>] Set-AzureSBAuthorizationRule
-Name <String>
[-Permission <AccessRights[]>]
-Namespace <String>
[-PrimaryKey <String>]
[-SecondaryKey <String>]
[-Profile <AzureSMProfile>]
[<CommonParameters>] Description
Updates existing Service Bus authorization rule.
Important
The Service Management REST API for Service Bus will be retired by November 1, 2021. Go to the deprecation of Azure Service Manager for more information about the retirement of the API. This Azure Service Management PowerShell cmdlet for Service Bus will no longer be supported as of November 1, 2021. Please migrate to the new Azure PowerShell cmdlets
Examples
Example 1: Renew primary key for authorization rule at namespace level
PS C:\> Set-AzureSBAuthorizationRule -Name MyRule -Namespace MyNamespace -Permission $("Send")The primary key is renewed.
Example 2: Update authorization rule permission
PS C:\> Set-AzureSBAuthorizationRule -Name MyRule -Namespace MyNamespace -Permission $("Listen", "Send") -EntityName MyEntity -EntityType QueueUpdates the permissions.
Parameters
-EntityName
The entity name to apply rule at.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-EntityType
The entity type (Queue, Topic, Relay, NotificationHub).
| Type: | ServiceBusEntityType |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Name
The unique authorization rule name.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Namespace
The namespace name to apply the authorization rule. If no EntityName provided the rule will be on the namespace level.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Permission
The authorization permissions (Send, Manage, Listen).
| Type: | AccessRights[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PrimaryKey
The Shared Access Signature primary key. Will be generated if not provided.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Profile
Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.
| Type: | AzureSMProfile |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SecondaryKey
The Shared Access Signature secondary key.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |