Get-AzureSBAuthorizationRule
[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]
Get-AzureSBAuthorizationRule
Gets Service Bus authorization rules.
Parameter Set: EntitySAS
Get-AzureSBAuthorizationRule [[-Name] <String> ] [[-Permission] <AccessRights[]> ] [-Namespace] <String> [-EntityName] <String> [-EntityType] <ServiceBusEntityType> [ <CommonParameters>]
Parameter Set: NamespaceSAS
Get-AzureSBAuthorizationRule [[-Name] <String> ] [[-Permission] <AccessRights[]> ] [-Namespace] <String> [ <CommonParameters>]
This topic describes the cmdlet in the .6.19 version of the Windows Azure PowerShell module. To find out the version of the module you're using, from the Windows Azure PowerShell console, type (get-module azure).version.
-EntityName<String>
Specifies the entity name in which to search for the rule.
Aliases |
none |
Required? |
true |
Position? |
4 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-EntityType<ServiceBusEntityType>
Aliases |
none |
Required? |
true |
Position? |
5 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Name<String>
Specifies the unique authorization rule name.
Aliases |
none |
Required? |
false |
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 is provided, the search is done on the namespace level.
Aliases |
none |
Required? |
true |
Position? |
3 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Permission<AccessRights[]>
Specifies the authorization permissions to filter (Send, Manage, Listen). This uses exact match.
Aliases |
none |
Required? |
false |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
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.
Get authorization rule at namespace level
Gets all available authorization rules at MyNamespace.
PS C:\> Get-AzureSBAuthorizationRule -Namespace MyNamespace
Get authorization rule for a Queue
Gets all available authorization rules at MyEntity Queue on MyNamespace.
PS C:\> Get-AzureSBAuthorizationRule -Namespace MyNamespace -EntityName MyEntity -EntityType Queue
Get authorization rule by name
Gets an authorization rule called MyRule on MyNamespace level.
PS C:\> Get-AzureSBAuthorizationRule -Name MyRule -Namespace MyNamespace
Get authorization rule by permisssion
Gets all authorization rules that have send permission on the namespace level.
PS C:\> Get-AzureSBAuthorizationRule -Namespace MyNamespace -Permission $("Send")