Skip to content

Latest commit

 

History

History
143 lines (107 loc) · 3.36 KB

Get-AzEventGridTopicKey.md

File metadata and controls

143 lines (107 loc) · 3.36 KB
Raw
external help file Module Name online version schema
Microsoft.Azure.PowerShell.Cmdlets.EventGrid.dll-Help.xml
Az.EventGrid
2.0.0

Get-AzEventGridTopicKey

SYNOPSIS

Gets the shared access keys used to publish events to an Event Grid topic.

SYNTAX

TopicNameParameterSet (Default)

Get-AzEventGridTopicKey [-ResourceGroupName] <String> [-Name] <String>
 [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]

TopicInputObjectParameterSet

Get-AzEventGridTopicKey [-InputObject] <PSTopic> [-DefaultProfile <IAzureContextContainer>]
 [<CommonParameters>]

ResourceIdEventSubscriptionParameterSet

Get-AzEventGridTopicKey [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]

DESCRIPTION

Gets the shared access keys used to publish events to an Event Grid topic.

EXAMPLES

Example 1

Get-AzEventGridTopicKey -ResourceGroup MyResourceGroupName -Name Topic1

Gets the shared access keys of Event Grid topic `Topic1` in resource group `MyResourceGroupName`.

Example 2

Get-AzEventGridTopic -ResourceGroup MyResourceGroupName -Name Topic1 | Get-AzEventGridTopicKey

Gets the shared access keys of Event Grid topic `Topic1` in resource group `MyResourceGroupName`.

PARAMETERS

-DefaultProfile

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

Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
Parameter Sets: (All)
Aliases: AzContext, AzureRmContext, AzureCredential

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

-InputObject

EventGrid Topic object.

Type: Microsoft.Azure.Commands.EventGrid.Models.PSTopic
Parameter Sets: TopicInputObjectParameterSet
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Name

EventGrid Topic Name.

Type: System.String
Parameter Sets: TopicNameParameterSet
Aliases: TopicName

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ResourceGroupName

Resource Group Name.

Type: System.String
Parameter Sets: TopicNameParameterSet
Aliases: ResourceGroup

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

-ResourceId

Resource Identifier representing the Event Grid Topic.

Type: System.String
Parameter Sets: ResourceIdEventSubscriptionParameterSet
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
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

System.String

Microsoft.Azure.Commands.EventGrid.Models.PSTopic

OUTPUTS

Microsoft.Azure.Management.EventGrid.Models.TopicSharedAccessKeys

NOTES

RELATED LINKS