New-AzEventHubKey

Reference

Module:: Az.EventHub

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

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Syntax

New-AzEventHubKey
   [-ResourceGroupName] <String>
   [-Namespace] <String>
   [-Name] <String>
   [-RegenerateKey] <String>
   [[-KeyValue] <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

New-AzEventHubKey
   [-ResourceGroupName] <String>
   [-Namespace] <String>
   [-EventHub] <String>
   [-Name] <String>
   [-RegenerateKey] <String>
   [[-KeyValue] <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

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

Examples

Example 1: Namespace - AuthorizationRule PrimaryKey

New-AzEventHubKey -ResourceGroup MyResourceGroupName -Namespace MyNamespaceName -Name MyAuthRuleName -RegenerateKey PrimaryKey

Regenerates the primary key for the authorization rule `MyAuthRuleName`.

Example 2: EventHub - AuthorizationRule PrimaryKey

New-AzEventHubKey -ResourceGroup MyResourceGroupName -Namespace MyNamespaceName -EventHub MyEventHubName -Name MyAuthRuleName -RegenerateKey PrimaryKey

Regenerates the primary key for the authorization rule `MyAuthRuleName`.

Example 3: - Namespace - AuthorizationRule SecondaryKey

New-AzEventHubKey -ResourceGroup MyResourceGroupName -Namespace MyNamespaceName -Name MyAuthRuleName -RegenerateKey SecondaryKey

Example 4: EventHub - AuthorizationRule SecondaryKey

New-AzEventHubKey -ResourceGroup MyResourceGroupName -Namespace MyNamespaceName -EventHub MyEventHubName -Name MyAuthRuleName -RegenerateKey SecondaryKey

Regenerates the secondary key for the authorization rule `MyAuthRuleName`.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

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

-DefaultProfile

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

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-EventHub

EventHub Name

Type:	String
Aliases:	EventHubName
Position:	2
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-KeyValue

A base64-encoded 256-bit key for signing and validating the SAS token.

Type:	String
Position:	5
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-Name

AuthorizationRule Name

Type:	String
Aliases:	AuthorizationRuleName
Position:	3
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-Namespace

Namespace Name

Type:	String
Aliases:	NamespaceName
Position:	1
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-RegenerateKey

Regenerate Keys - 'PrimaryKey'/'SecondaryKey'

Type:	String
Accepted values:	PrimaryKey, SecondaryKey
Position:	4
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceGroupName

Resource Group Name

Type:	String
Aliases:	ResourceGroup
Position:	0
Default value:	None
Accept pipeline input:	True
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:	None
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

String

Outputs

PSListKeysAttributes