Remove-AzureRmEventGridTopic

NAME Remove-AzureRmEventGridTopic



SYNOPSIS

Removes an Azure Event Grid Topic.





SYNTAX

Remove-AzureRmEventGridTopic [-InputObject] <PSTopic> [-DefaultProfile <IAzureContextContainer>] [-PassThru] [-Confirm] [-WhatIf]

[<CommonParameters>]



Remove-AzureRmEventGridTopic [-ResourceGroupName] <String> [-Name] <String> [-DefaultProfile <IAzureContextContainer>] [-PassThru] [-Confirm]

[-WhatIf] [<CommonParameters>]



Remove-AzureRmEventGridTopic [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] [-PassThru] [-Confirm] [-WhatIf]

[<CommonParameters>]





DESCRIPTION

Removes an Azure Event Grid Topic.





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



-InputObject <PSTopic>

EventGrid Topic object.



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByValue)

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



-PassThru [<SwitchParameter>]

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



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-ResourceGroupName <String>

Resource Group Name.



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ResourceId <String>

EventGrid Topic ResourceID.



Required? true

Position? 1

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Confirm [<SwitchParameter>]

Prompts you for confirmation before running the cmdlet.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

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



Required? false

Position? named

Default value False

Accept pipeline input? False

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

System.Object







NOTES









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`.







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... tgridtopic