New-AzEventHubKey

Módulo:

Az.EventHub Module

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

Sintaxe

NamespaceAuthorizationRuleSet (Predefinição)

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

EventhubAuthorizationRuleSet

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.

Exemplos

Example 1.1 - Namespace - AuthorizationRule PrimaryKey

PS C:\> New-AzEventHubKey -ResourceGroup MyResourceGroupName -Namespace MyNamespaceName -Name MyAuthRuleName -RegenerateKey PrimaryKey

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

Example 1.2 - EventHub - AuthorizationRule PrimaryKey

PS C:\> New-AzEventHubKey -ResourceGroup MyResourceGroupName -Namespace MyNamespaceName -EventHub MyEventHubName -Name MyAuthRuleName -RegenerateKey PrimaryKey

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

Example 2.1 - Namespace - AuthorizationRule SecondaryKey

PS C:\> New-AzEventHubKey -ResourceGroup MyResourceGroupName -Namespace MyNamespaceName -Name MyAuthRuleName -RegenerateKey SecondaryKey

Example 2.2 - EventHub - AuthorizationRule SecondaryKey

PS C:\> New-AzEventHubKey -ResourceGroup MyResourceGroupName -Namespace MyNamespaceName -EventHub MyEventHubName -Name MyAuthRuleName -RegenerateKey SecondaryKey

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

Parâmetros

-Confirm

Prompts you for confirmation before running the cmdlet.

Propriedades dos parâmetros

Tipo:	SwitchParameter
Default value:	None
Suporta carateres universais:	False
NãoMostrar:	False
Aliases:	cf

Conjuntos de parâmetros

(All)

Position:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

-DefaultProfile

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

Propriedades dos parâmetros

Tipo:	IAzureContextContainer
Default value:	None
Suporta carateres universais:	False
NãoMostrar:	False
Aliases:	AzContext, AzureRmContext, AzureCredential

Conjuntos de parâmetros

(All)

Position:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

-EventHub

EventHub Name

Propriedades dos parâmetros

Tipo:	String
Default value:	None
Suporta carateres universais:	False
NãoMostrar:	False
Aliases:	EventHubName

Conjuntos de parâmetros

EventhubAuthorizationRuleSet

Position:	2
Obrigatório:	True
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	True
Valor dos restantes argumentos:	False

-KeyValue

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

Propriedades dos parâmetros

Tipo:	String
Default value:	None
Suporta carateres universais:	False
NãoMostrar:	False

Conjuntos de parâmetros

(All)

Position:	5
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

-Name

AuthorizationRule Name

Propriedades dos parâmetros

Tipo:	String
Default value:	None
Suporta carateres universais:	False
NãoMostrar:	False
Aliases:	AuthorizationRuleName

Conjuntos de parâmetros

(All)

Position:	3
Obrigatório:	True
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	True
Valor dos restantes argumentos:	False

-Namespace

Namespace Name

Propriedades dos parâmetros

Tipo:	String
Default value:	None
Suporta carateres universais:	False
NãoMostrar:	False
Aliases:	NamespaceName

Conjuntos de parâmetros

(All)

Position:	1
Obrigatório:	True
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	True
Valor dos restantes argumentos:	False

-RegenerateKey

Regenerate Keys - 'PrimaryKey'/'SecondaryKey'

Propriedades dos parâmetros

Tipo:	String
Default value:	None
Valores aceites:	PrimaryKey, SecondaryKey
Suporta carateres universais:	False
NãoMostrar:	False

Conjuntos de parâmetros

(All)

Position:	4
Obrigatório:	True
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

-ResourceGroupName

Resource Group Name

Propriedades dos parâmetros

Tipo:	String
Default value:	None
Suporta carateres universais:	False
NãoMostrar:	False
Aliases:	ResourceGroup

Conjuntos de parâmetros

(All)

Position:	0
Obrigatório:	True
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	True
Valor dos restantes argumentos:	False

-WhatIf

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

Propriedades dos parâmetros

Tipo:	SwitchParameter
Default value:	None
Suporta carateres universais:	False
NãoMostrar:	False
Aliases:	wi

Conjuntos de parâmetros

(All)

Position:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

CommonParameters

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

Entradas

String

Saídas

PSListKeysAttributes