Set-AzureSBAuthorizationRule

Set-AzureSBAuthorizationRule

Updates existing Service Bus authorization rule

Syntax

Parameter Set: EntitySAS
Set-AzureSBAuthorizationRule [-Name] <String> [[-Permission] {Manage | Send | Listen}[] ] [-Namespace] <String> [-EntityName] <String> [-EntityType] <ServiceBusEntityType> [[-PrimaryKey] <String> ] [[-SecondaryKey] <String> ] [ <CommonParameters>]

Parameter Set: NamespaceSAS
Set-AzureSBAuthorizationRule [-Name] <String> [[-Permission] {Manage | Send | Listen}[] ] [-Namespace] <String> [[-PrimaryKey] <String> ] [[-SecondaryKey] <String> ] [ <CommonParameters>]




Detailed Description

Updates existing Service Bus authorization rule

Parameters

-EntityName<String>

The entity name to apply rule at.


Aliases

none

Required?

true

Position?

4

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-EntityType<ServiceBusEntityType>

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


Aliases

none

Required?

true

Position?

5

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Name<String>

The unique authorization rule name


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Namespace<String>

The namespace name to apply the authorization rule. If no EntityName provided the rule will be on the namespace level


Aliases

none

Required?

true

Position?

3

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Permission<AccessRights[]>

The authorization permissions (Send, Manage, Listen)


Aliases

none

Required?

false

Position?

2

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-PrimaryKey<String>

The Shared Access Signature primary key. Will be generated if not provided


Aliases

none

Required?

false

Position?

6

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-SecondaryKey<String>

The Shared Access Signature secondary key


Aliases

none

Required?

false

Position?

7

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see    about_CommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

Examples

-------------- Renew primary key for authorization rule at namespace level --------------

The primary key is renewed


C:\PS>Set-AzureSBAuthorizationRule -Name MyRule -Namespace MyNamespace -Permission $("Send")

-------------- Update authorization rule permission --------------

Updates the permissions


C:\PS>Set-AzureSBAuthorizationRule -Name MyRule -Namespace MyNamespace -Permission $("Listen", "Send") -EntityName MyEntity -EntityType Queue

Related topics

Show: