Get-AzureRmEventGridTopicType

Reference

Module:: AzureRM.EventGrid

Gets the details about the topic types supported by Azure Event Grid.

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-AzureRmEventGridTopicType
   [[-Name] <String>]
   [-IncludeEventTypeData]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

Gets the details of topic types supported by Azure Event Grid. If a topic type name is specified, details about that topic type are returned. If a topic type name is not specified, details about all topic types are returned. If IncludeEventTypes is specified, information about event types supported by each topic type is included in the response.

Examples

Example 1

PS C:\> Get-AzureRmEventGridTopicType

Gets a list of the topic types.

Example 2

PS C:\> Get-AzureRmEventGridTopicType -Name "Microsoft.Storage.StorageAccounts"

Gets information about the StorageAccounts topic type.

Example 3

PS C:\> Get-AzureRmEventGridTopicType -Name "Microsoft.Storage.StorageAccounts" -IncludeEventTypeData

Gets information about the StorageAccounts topic type, including the event types supported by StorageAccounts.

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

-IncludeEventTypeData

If specified, the response will include the event types supported by a topic type.

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

-Name

EventGrid Topic Type Name.

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

Inputs

String

Outputs

PSTopicTypeInfoListInstance

PSTopicTypeInfo

Share via