Get-AzEventHubAuthorizationRule

Reference

Module:: Az.EventHub

Gets an EventHub Authorization Rule

Syntax

Get-AzEventHubAuthorizationRule
   -NamespaceName <String>
   -ResourceGroupName <String>
   [-Name <String>]
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzEventHubAuthorizationRule
   -NamespaceName <String>
   -ResourceGroupName <String>
   [-Name <String>]
   [-SubscriptionId <String[]>]
   -EventHubName <String>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzEventHubAuthorizationRule
   -NamespaceName <String>
   -ResourceGroupName <String>
   [-Name <String>]
   [-SubscriptionId <String[]>]
   -AliasName <String>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

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

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

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:	PSObject
Aliases:	AzureRMContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-EventHubName

The name of the EventHub entity.

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

-InputObject

Identity parameter. To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Type:	IEventHubIdentity
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Name

The name of the Authorization Rule

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

-NamespaceName

The name of EventHub namespace

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

-ResourceGroupName

The name of the resource group. The name is case insensitive.

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

-SubscriptionId

The ID of the target subscription.

Type:	String[]
Position:	Named
Default value:	(Get-AzContext).Subscription.Id
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

IEventHubIdentity

Outputs

IAuthorizationRule