Skip to content

New-AzEventHubKey.md

Latest commit

 

History

History
260 lines (203 loc) · 5.71 KB

New-AzEventHubKey.md

File metadata and controls

260 lines (203 loc) · 5.71 KB
Raw
external help file
Module Name Az.EventHub
online version https://learn.microsoft.com/powershell/module/az.eventhub/new-azeventhubkey
schema 2.0.0

New-AzEventHubKey

SYNOPSIS

Regenerates an EventHub SAS key

SYNTAX

NewExpandedNamespace (Default)

New-AzEventHubKey -Name <String> -NamespaceName <String> -ResourceGroupName <String>
 [-SubscriptionId <String>] [-KeyType <String>] [-KeyValue <String>] [-DefaultProfile <PSObject>] [-AsJob]
 [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>]

NewExpandedEntity

New-AzEventHubKey -EventHubName <String> -Name <String> -NamespaceName <String> -ResourceGroupName <String>
 [-SubscriptionId <String>] [-KeyType <String>] [-KeyValue <String>] [-DefaultProfile <PSObject>] [-AsJob]
 [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>]

DESCRIPTION

Regenerates an EventHub SAS key

EXAMPLES

Example 1: Regenerate Primary Key of an EventHub Namespace

New-AzEventHubKey -ResourceGroupName myResourceGroup -NamespaceName myNamespace -Name rootmanagesharedaccesskey -KeyType PrimaryKey
KeyName                        : RootManageSharedAccessKey
PrimaryConnectionString        : {primaryConnectionString}
PrimaryKey                     : {primaryKey}
SecondaryConnectionString      : {secondaryConnectionString}
SecondaryKey                   : {secondaryKey}

Regenerate primary key of authorization rule rootmanagesharedaccesskey on EventHub Namespace myNamespace.

Example 2: Regenerate Secondary Key of an EventHub Entity

New-AzEventHubKey -ResourceGroupName myResourceGroup -NamespaceName myNamespace -EventHubName myEventHub -Name rootmanagesharedaccesskey -KeyType SecondaryKey
KeyName                        : RootManageSharedAccessKey
PrimaryConnectionString        : {primaryConnectionString}
PrimaryKey                     : {primaryKey}
SecondaryConnectionString      : {secondaryConnectionString}
SecondaryKey                   : {secondaryKey}

Regenerate secondary key of authorization rule rootmanagesharedaccesskey on EventHub entity myEventHub on EventHub Namespace myNamespace.

PARAMETERS

-AsJob

Run the command as a job

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
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: System.Management.Automation.PSObject
Parameter Sets: (All)
Aliases: AzureRMContext, AzureCredential

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-EventHubName

The name of the EventHub entity.

Type: System.String
Parameter Sets: NewExpandedEntity
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-KeyType

The access key to regenerate.

Type: System.String
Parameter Sets: (All)
Aliases: RegenerateKey

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-KeyValue

Optional, if the key value provided, is set for KeyType or autogenerated Key value set for keyType

Type: System.String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Name

The name of the Authorization Rule

Type: System.String
Parameter Sets: (All)
Aliases: AuthorizationRuleName

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-NamespaceName

The name of EventHub namespace

Type: System.String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-NoWait

Run the command asynchronously

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ResourceGroupName

The name of the resource group. The name is case insensitive.

Type: System.String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-SubscriptionId

The ID of the target subscription.

Type: System.String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: (Get-AzContext).Subscription.Id
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

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

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IAccessKeys

NOTES

RELATED LINKS