< Back
Get-AzureRmEventGridTopic
Post
NAME Get-AzureRmEventGridTopic
SYNOPSIS
Gets the details of an Event Grid topic, or gets a list of all Event Grid topics in the current Azure subscription.
SYNTAX
Get-AzureRmEventGridTopic [-ResourceGroupName] <String> [-Name] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
Get-AzureRmEventGridTopic [[-ResourceGroupName] <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.
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
-Name <String>
EventGrid Topic Name.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceGroupName <String>
Resource Group Name.
Required? false
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
<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
Microsoft.Azure.Commands.EventGrid.Models.PSTopic
OUTPUTS
Microsoft.Azure.Commands.EventGrid.Models.PSTopic
System.Collections.Generic.List`1[[Microsoft.Azure.Commands.EventGrid.Models.PSTopicListInstance, Microsoft.Azure.Commands.EventGrid,
Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]
NOTES
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.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... tgridtopic
SYNOPSIS
Gets the details of an Event Grid topic, or gets a list of all Event Grid topics in the current Azure subscription.
SYNTAX
Get-AzureRmEventGridTopic [-ResourceGroupName] <String> [-Name] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
Get-AzureRmEventGridTopic [[-ResourceGroupName] <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.
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
-Name <String>
EventGrid Topic Name.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceGroupName <String>
Resource Group Name.
Required? false
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
<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
Microsoft.Azure.Commands.EventGrid.Models.PSTopic
OUTPUTS
Microsoft.Azure.Commands.EventGrid.Models.PSTopic
System.Collections.Generic.List`1[[Microsoft.Azure.Commands.EventGrid.Models.PSTopicListInstance, Microsoft.Azure.Commands.EventGrid,
Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]
NOTES
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.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... tgridtopic