Remove-AzureRmEventGridTopic

Removes an Azure Event Grid Topic.

Important

You've reached a webpage for an outdated version of Azure PowerShell. All versions of the AzureRM PowerShell module are outdated, but not out of support. The Az PowerShell module is now the recommended PowerShell module for interacting with Azure. To get started with the Az PowerShell module, see Install Azure PowerShell. To learn how to migrate to the Az PowerShell module, see Migrate Azure PowerShell from AzureRM to Az.

Syntax

Remove-AzureRmEventGridTopic
      [-ResourceGroupName] <String>
      [-Name] <String>
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzureRmEventGridTopic
      [-ResourceId] <String>
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzureRmEventGridTopic
      [-InputObject] <PSTopic>
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Removes an Azure Event Grid Topic.

Examples

Example 1

PS C:\> Remove-AzureRmEventGridTopic -ResourceGroupName MyResourceGroupName -Name Topic1

Removes the Event Grid topic `Topic1` in resource group `MyResourceGroupName`.

Example 2

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

Removes the Event Grid topic `Topic1` in resource group `MyResourceGroupName`.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DefaultProfile

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

Type:Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-InputObject

EventGrid Topic object.

Type:PSTopic
Position:0
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-Name

EventGrid Topic Name.

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

Returns the status of the Remove operation. By default, this cmdlet does not generate any output.

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

Resource Group Name.

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

EventGrid Topic ResourceID.

Type:String
Position:1
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-WhatIf

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

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

Inputs

String

PSTopic

Parameters: InputObject (ByValue)

Outputs

Boolean