< Back

New-AzureRmEventGridTopicKey

Tue Jan 29, 2019 9:46 pm

NAME New-AzureRmEventGridTopicKey



SYNOPSIS

Regenerates the shared access key for an Azure Event Grid Topic.





SYNTAX

New-AzureRmEventGridTopicKey [-InputObject] <PSTopic> [-KeyName] <String> [-DefaultProfile <IAzureContextContainer>] [-Confirm] [-WhatIf]

[<CommonParameters>]



New-AzureRmEventGridTopicKey [-ResourceGroupName] <String> [-TopicName] <String> [-KeyName] <String> [-DefaultProfile <IAzureContextContainer>]

[-Confirm] [-WhatIf] [<CommonParameters>]



New-AzureRmEventGridTopicKey [-ResourceId] <String> [-KeyName] <String> [-DefaultProfile <IAzureContextContainer>] [-Confirm] [-WhatIf]

[<CommonParameters>]





DESCRIPTION

Regenerates the shared access key for an Azure Event Grid Topic.





PARAMETERS

-DefaultProfile <IAzureContextContainer>

The credentials, account, tenant, and subscription used for communication with azure



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-InputObject <PSTopic>

EventGrid Topic object.



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? false



-KeyName <String>

The name of the key that needs to be regenerated



Required? true

Position? 2

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ResourceGroupName <String>

Resource group name.



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ResourceId <String>

Resource Identifier representing the Event Grid Topic.



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-TopicName <String>

The name of the topic.



Required? true

Position? 1

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Confirm [<SwitchParameter>]

Prompts you for confirmation before running the cmdlet.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

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



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

System.String







OUTPUTS

Microsoft.Azure.Management.EventGrid.Models.TopicSharedAccessKeys







NOTES









Example 1



PS C:\\> New-AzureRmEventGridTopicKey -ResourceGroup MyResourceGroupName -TopicName Topic1 -KeyName key1



Regenerate the key corresponding to key \\'key1'\\ of Event Grid topic `Topic1` in resource group `MyResourceGroupName`.





Example 2



PS C:\\> Get-AzureRmEventGridTopic -ResourceGroup MyResourceGroupName -Name Topic1 | New-AzureRmEventGridTopicKey -KeyName "key1"



Regenerate the key corresponding to key \\'key1'\\ of Event Grid topic `Topic1` in resource group `MyResourceGroupName`.







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... idtopickey