| external help file | Module Name | online version | schema |
|---|---|---|---|
Microsoft.Azure.Commands.EventHub.dll-Help.xml |
AzureRM.EventHub |
2.0.0 |
Gets the details of an authorization rule, or gets a list of authorization rules.
Get-AzureRmEventHubAuthorizationRule [-ResourceGroupName] <String> [-Namespace] <String> [[-Name] <String>]
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
Get-AzureRmEventHubAuthorizationRule [-ResourceGroupName] <String> [-Namespace] <String> [-Eventhub] <String>
[[-Name] <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
Get-AzureRmEventHubAuthorizationRule [-ResourceGroupName] <String> [-Namespace] <String> [-AliasName] <String>
[[-Name] <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
The Get-AzureRmEventHubAuthorizationRule cmdlet gets either the details of an authorization rule, or a list of all authorization rules for a specified Event Hub. If the name of an authorization rule is provided, the details of that single authorization rule are returned. If the name of an authorization rule is not provided, a list of all authorization rules for the specified Event Hub is returned. If (Disaster Recovery) Alias name provided, the details of authorization rule of the Namespace for Alias configured is returned.
PS C:\> Get-AzureRmEventHubAuthorizationRule -ResourceGroupName MyResourceGroupName -NamespaceName MyNamespaceName -Name MyAuthRuleName
Gets the authorization rule `MyAuthRuleName` in the namespace `MyNamespaceName`.
PS C:\> Get-AzureRmEventHubAuthorizationRule -ResourceGroupName MyResourceGroupName -NamespaceName MyNamespaceName -EventHubName MyEventHubName
Gets a list of all authorization rules in the namespace `MyNamespaceName`.
PS C:\> Get-AzureRmEventHubAuthorizationRule -ResourceGroupName MyResourceGroupName -NamespaceName MyNamespaceName -EventHubName MyEventHubName -Name MyAuthRuleName
Gets the authorization rule `MyAuthRuleName` in the Event Hub `MyEventHubName`, which is scoped by the namespace `MyNamespaceName`.
PS C:\> Get-AzureRmEventHubAuthorizationRule -ResourceGroupName MyResourceGroupName -NamespaceName MyNamespaceName -EventHubName MyEventHubName
Gets list authorization rules in the Event Hub `MyEventHubName`, which is scoped by the namespace `MyNamespaceName`.
PS C:\> Get-AzureRmEventHubAuthorizationRule -ResourceGroupName MyResourceGroupName -NamespaceName MyNamespaceName -AliasName MyAliasNameName -Name MyAuthRuleName
Gets the authorization rule `MyAuthRuleName` in the namespace `MyNamespaceName`.
PS C:\> Get-AzureRmEventHubAuthorizationRule -ResourceGroupName MyResourceGroupName -NamespaceName MyNamespaceName -AliasName MyAliasNameName
Gets a list of all authorization rule `MyAuthRuleName` in the namespace `MyNamespaceName`.
Alias Name
Type: System.String
Parameter Sets: AliasAuthoRuleSet
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseThe credentials, account, tenant, and subscription used for communication with Azure.
Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer
Parameter Sets: (All)
Aliases: AzureRmContext, AzureCredential
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseEventhub Name
Type: System.String
Parameter Sets: EventhubAuthorizationRuleSet
Aliases: EventHubName
Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseAuthorizationRule Name
Type: System.String
Parameter Sets: (All)
Aliases: AuthorizationRuleName
Required: False
Position: 3
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseNamespace Name
Type: System.String
Parameter Sets: (All)
Aliases: NamespaceName
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseResource Group Name
Type: System.String
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).