Get-AzEventHubAuthorizationRule
Gets an EventHub Authorization Rule
Syntax
GetExpandedNamespace (Default)
Get-AzEventHubAuthorizationRule
-NamespaceName <String>
-ResourceGroupName <String>
[-Name <String>]
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
GetExpandedEntity
Get-AzEventHubAuthorizationRule
-NamespaceName <String>
-ResourceGroupName <String>
-EventHubName <String>
[-Name <String>]
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
GetExpandedAlias
Get-AzEventHubAuthorizationRule
-NamespaceName <String>
-ResourceGroupName <String>
-AliasName <String>
[-Name <String>]
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
GetViaIdentityExpanded
Get-AzEventHubAuthorizationRule
-InputObject <IEventHubIdentity>
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Description
Gets an EventHub Authorization Rule
Examples
Example 1: Get an EventHub Namespace Authorization Rule
Get-AzEventHubAuthorizationRule -ResourceGroupName myResourceGroup -NamespaceName myNamespace -Name myAuthRule
Id : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace/authorizationRules
/myAuthRule
Location : Central US
Name : myAuthRule
ResourceGroupName : myResourceGroup
Rights : {Listen, Manage, Send}
Gets details of authorization rule myAuthRule of EventHub namespace myNamespace.
Example 2: Get an EventHub entity authorization rule
Get-AzEventHubAuthorizationRule -ResourceGroupName myResourceGroup -NamespaceName myNamespace -EventHubName myEventHub -Name myAuthRule
Id : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace/eventhubs/myEventHub/authorizationRules
/myAuthRule
Location : Central US
Name : myAuthRule
ResourceGroupName : myResourceGroup
Rights : {Listen, Manage, Send}
Gets details of authorization rule myAuthRule of EventHub entity myEventHub from namespace myNamespace.
Parameters
-AliasName
The name of the Disaster Recovery alias
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
GetExpandedAlias
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-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
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-EventHubName
The name of the EventHub entity.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
GetExpandedEntity
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Identity parameter.
To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
GetViaIdentityExpanded
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-Name
The name of the Authorization Rule
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: AuthorizationRuleName
Parameter sets
GetExpandedNamespace
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
GetExpandedEntity
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
GetExpandedAlias
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-NamespaceName
The name of EventHub namespace
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
GetExpandedNamespace
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
GetExpandedEntity
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
GetExpandedAlias
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-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
GetExpandedNamespace
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
GetExpandedEntity
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
GetExpandedAlias
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SubscriptionId
The ID of the target subscription.
Parameter properties
Type: String [ ]
Default value: (Get-AzContext).Subscription.Id Supports wildcards: False DontShow: False
Parameter sets
GetExpandedNamespace
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
GetExpandedEntity
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
GetExpandedAlias
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
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 .
Outputs
