Get-AzureRmEventHubKey

NAME Get-AzureRmEventHubKey



SYNOPSIS

Gets the primary key details of the specified Event Hubs authorization rule.





SYNTAX

Get-AzureRmEventHubKey [-ResourceGroupName] <String> [-Namespace] <String> [-AliasName] <String> [-Name] <String> [-DefaultProfile

<IAzureContextContainer>] [<CommonParameters>]



Get-AzureRmEventHubKey [-ResourceGroupName] <String> [-Namespace] <String> [-EventHub] <String> [-Name] <String> [-DefaultProfile

<IAzureContextContainer>] [<CommonParameters>]





DESCRIPTION

The Get-AzureRmEventHubKey cmdlet returns Primary and Secondary connectionstrings and keys details of the specified NameSpace/Event Hubs/Alias

authorization rule.





PARAMETERS

-AliasName <String>

Alias Name



Required? true

Position? 2

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-DefaultProfile <IAzureContextContainer>

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



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-EventHub <String>

EventHub Name



Required? true

Position? 2

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Name <String>

AuthorizationRule Name



Required? true

Position? 3

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Namespace <String>

Namespace Name



Required? true

Position? 1

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ResourceGroupName <String>

Resource Group Name



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

System.String







OUTPUTS

Microsoft.Azure.Commands.EventHub.Models.PSListKeysAttributes







NOTES









Example 1



PS C:\\> Get-AzureRmEventHubKey -ResourceGroupName MyResourceGroupName -NamespaceName MyNamespaceName -EventHubName MyEventHubName

-AuthorizationRuleName MyAuthRuleName



Gets details of Primary and Secondary connectionstrings and keys for the authorization rule `MyAuthRuleName`.





Example 1



PS C:\\> Get-AzureRmEventHubKey -ResourceGroupName MyResourceGroupName -NamespaceName MyNamespaceName -EventHubName MyEventHubName -AliasName

MyAliasName -Name MyAuthRuleName



Gets details of Primary, Secondary, AliasPrimary and AliasSecondary connectionstrings and keys for the authorization rule `MyAuthRuleName`.







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... venthubkey