New-​Azure​Rm​Event​Hub​Key

Creates a new primary or secondary key for the specified Event Hubs authorization rule.

Syntax

New-AzureRmEventHubKey
   [-ResourceGroup] <String>
   [-NamespaceName] <String>
   [-EventHubName] <String>
   [-RegenerateKey] <String>
   [-Confirm]
   [-WhatIf]
   -AuthorizationRuleName <String>
   [<CommonParameters>]

Description

The New-AzureRmEventHubKey cmdlet regenerates the primary or secondary SAS key for the specified Event Hubs authorization rule.

Examples

Example 1

PS C:\> New-AzureRmEventHubKey -ResourceGroup MyResourceGroupName -NamespaceName MyNamespaceName -EventHubName MyEventHubName -AuthorizationRuleName MyAuthRuleName -RegenerateKey PrimaryKey

Regenerates the primary key for the authorization rule MyAuthRuleName.

Example 2

PS C:\> New-AzureRmEventHubKey -ResourceGroup MyResourceGroupName -NamespaceName MyNamespaceName -EventHubName MyEventHubName -AuthorizationRuleName MyAuthRuleName -RegenerateKey SecondaryKey

Regenerates the secondary key for the authorization rule MyAuthRuleName.

Required Parameters

-AuthorizationRuleName

Authorization rule name.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-EventHubName

The Event Hub name.

Type:String
Position:2
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-NamespaceName

The Event Hubs namespace name.

Type:String
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-RegenerateKey

Key to regenerate: PrimaryKey or SecondaryKey.

Type:String
Parameter Sets:PrimaryKey, SecondaryKey
Position:4
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ResourceGroup

The name of the resource group.

Type:String
Position:0
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Optional Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False
-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

System.String

Outputs

Microsoft.Azure.Commands.EventHub.Models.ListKeysAttributes