Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
Get-AzServiceBusAuthorizationRule
- Module:
- Az.ServiceBus Module
Gets the Authorization Rule of a ServiceBus namespace, queue or topic.
Syntax
GetExpandedNamespace (Default)
Get-AzServiceBusAuthorizationRule
-NamespaceName <String>
-ResourceGroupName <String>
[-Name <String>]
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
GetExpandedQueue
Get-AzServiceBusAuthorizationRule
-NamespaceName <String>
-ResourceGroupName <String>
-QueueName <String>
[-Name <String>]
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
GetExpandedTopic
Get-AzServiceBusAuthorizationRule
-NamespaceName <String>
-ResourceGroupName <String>
-TopicName <String>
[-Name <String>]
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
GetExpandedAlias
Get-AzServiceBusAuthorizationRule
-NamespaceName <String>
-ResourceGroupName <String>
-AliasName <String>
[-Name <String>]
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
GetViaIdentityExpanded
Get-AzServiceBusAuthorizationRule
-InputObject <IServiceBusIdentity>
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Description
Gets the Authorization Rule of a ServiceBus namespace, queue or topic.
Examples
Example 1: Get a ServiceBus Namespace Authorization Rule
Get-AzServiceBusAuthorizationRule -ResourceGroupName myResourceGroup -NamespaceName myNamespace -Name myAuthRule
Id : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/myNamespace/authorizationRules
/myAuthRule
Location : Central US
Name : myAuthRule
ResourceGroupName : myResourceGroup
Rights : {Listen, Manage, Send}
Gets details of authorization rule myAuthRule of ServiceBus namespace myNamespace.
Example 2: Get a ServiceBus queue authorization rule
Get-AzServiceBusAuthorizationRule -ResourceGroupName myResourceGroup -NamespaceName myNamespace -QueueName queue1 -Name myAuthRule
Id : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/myNamespace/queues/queue1/authorizationRules
/myAuthRule
Location : Central US
Name : myAuthRule
ResourceGroupName : myResourceGroup
Rights : {Listen, Manage, Send}
Gets details of authorization rule myAuthRule of ServiceBus queue queue1 from namespace myNamespace.
Example 3: List all authorization rules in a ServiceBus namespace
Get-AzServiceBusAuthorizationRule -ResourceGroupName myResourceGroup -NamespaceName myNamespace
Lists all authorization rules in ServiceBus namespace myNamespace.
Parameters
-AliasName
The name of the disaster recovery config
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Parameter properties
| Type: | PSObject |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | AzureRMContext, AzureCredential |
Parameter sets
-InputObject
Identity parameter. To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
Parameter properties
| Type: | IServiceBusIdentity |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Name
The name of the Authorization Rule
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | AuthorizationRuleName |
Parameter sets
-NamespaceName
The name of ServiceBus namespace
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-QueueName
The name of the Service Bus queue.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ResourceGroupName
The name of the resource group. The name is case insensitive.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-SubscriptionId
The ID of the target subscription.
Parameter properties
| Type: | String[] |
| Default value: | (Get-AzContext).Subscription.Id |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-TopicName
The name of the Service Bus topic.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
IServiceBusIdentity
Outputs
ISbAuthorizationRule
Azure PowerShell
Feedback
Was this page helpful?