Get-AzureRmEventGridTopic

Reference

Module:: AzureRM.EventGrid

Gets the details of an Event Grid topic, or gets a list of all Event Grid topics in the current Azure subscription.

Warning

The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.

Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.

Syntax

Get-AzureRmEventGridTopic
   [[-ResourceGroupName] <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

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

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

Description

The Get-AzureRmEventGridTopic cmdlet gets either the details of a specified Event Grid Topic, or a list of all Event Grid topics in the current Azure subscription. If the topic name is provided, the details of a single Event Grid Topic is returned. If the topic name is not provided, a list of topics is returned.

Examples

Example 1

PS C:\> Get-AzureRmEventGridTopic -ResourceGroup MyResourceGroupName -Name Topic1

Gets the details of Event Grid topic `Topic1` in resource group `MyResourceGroupName`.

Example 2

PS C:\> Get-AzureRmEventGridTopic -ResourceId "/subscriptions/$subscriptionId/resourceGroups/MyResourceGroupName/providers/Microsoft.EventGrid/topics/Topic1"

Gets the details of Event Grid topic `Topic1` in resource group `MyResourceGroupName`.

Example 3

PS C:\> Get-AzureRmEventGridTopic -ResourceGroup MyResourceGroupName

List all the Event Grid topics in resource group `MyResourceGroupName`.

Example 4

PS C:\> Get-AzureRmEventGridTopic

List all the Event Grid topics in the subscription.

Parameters

-DefaultProfile

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

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

-Name

EventGrid Topic Name.

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

-ResourceGroupName

Resource Group Name.

Type:	String
Aliases:	ResourceGroup
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-ResourceId

Resource Identifier representing the Event Grid Topic.

Type:	String
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

Inputs

String

Outputs

PSTopic

PSTopicListInstance