Set-​Azure​SB​Authorization​Rule

Updates existing Service Bus authorization rule.

Syntax

Set-AzureSBAuthorizationRule
   -EntityName <String>
   -EntityType <ServiceBusEntityType>
   -Name <String>
   -Namespace <String>
   [-Permission <AccessRights[]>]
   [-PrimaryKey <String>]
   [-Profile <AzureSMProfile>]
   [-SecondaryKey <String>]
   [<CommonParameters>]

Description

Updates existing Service Bus authorization rule.

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 Queue

Updates the permissions.

Required Parameters

-EntityName

The entity name to apply rule at.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-EntityType

The entity type (Queue, Topic, Relay, NotificationHub).

Type:ServiceBusEntityType
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Name

The unique authorization rule name.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
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
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Optional Parameters

-Permission

The authorization permissions (Send, Manage, Listen).

Type:AccessRights[]
Position:Named
Default value:None
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
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
Accept pipeline input:False
Accept wildcard characters:False
-SecondaryKey

The Shared Access Signature secondary key.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False