Get-AzEventHubKey
Gets an EventHub SAS key
Syntax
Get-AzEventHubKey
-Name <String>
-NamespaceName <String>
-ResourceGroupName <String>
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[<CommonParameters>] Get-AzEventHubKey
-Name <String>
-NamespaceName <String>
-ResourceGroupName <String>
[-SubscriptionId <String[]>]
-AliasName <String>
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[<CommonParameters>] Get-AzEventHubKey
-Name <String>
-NamespaceName <String>
-ResourceGroupName <String>
[-SubscriptionId <String[]>]
-EventHubName <String>
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[<CommonParameters>] Description
Gets an EventHub SAS key
Examples
Example 1: Get keys of an EventHub Namespace authorization rule
Get-AzEventHubKey -ResourceGroupName myResourceGroup -NamespaceName myNamespace -Name RootManageSharedAccessKey
AliasPrimaryConnectionString :
AliasSecondaryConnectionString :
KeyName : RootManageSharedAccessKey
PrimaryConnectionString : 000000000000
PrimaryKey : 000000000000
SecondaryConnectionString : {ConnectionString}
SecondaryKey : {ConnectionString}Gets keys of authorization rule RootManageSharedAccessKey of EventHub namespace myNamespace.
Example 2: Get keys of an EventHub Entity authorization rule
Get-AzEventHubKey -ResourceGroupName myResourceGroup -NamespaceName myNamespace -EventHubName myEventHub -Name RootManageSharedAccessKey
AliasPrimaryConnectionString :
AliasSecondaryConnectionString :
KeyName : RootManageSharedAccessKey
PrimaryConnectionString : 000000000000
PrimaryKey : 000000000000
SecondaryConnectionString : {ConnectionString}
SecondaryKey : {ConnectionString}Gets keys of authorization rule RootManageSharedAccessKey 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 |
-AsJob
Run the command as a job
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| 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 |
-Name
The name of the Authorization Rule
| Type: | String |
| Aliases: | AuthorizationRuleName |
| Position: | Named |
| Default value: | None |
| Required: | True |
| 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 |
-NoWait
Run the command asynchronously
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| 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 |