Remove-AzEventHub

Reference

Module:: Az.EventHub

Removes the specified Event Hub.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Syntax

Remove-AzEventHub
      [-ResourceGroupName] <String>
      [-Namespace] <String>
      [-Name] <String>
      [-PassThru]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-AzEventHub
      [-InputObject] <PSEventHubAttributes>
      [-PassThru]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-AzEventHub
      [-ResourceId] <String>
      [-PassThru]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Remove-AzEventHub cmdlet removes and deletes the specified Event Hub from the given namespace.

Examples

Example 1

Remove-AzEventHub -ResourceGroupName MyResourceGroupName -Namespace MyNamespaceName -Name MyEventHubName

Removes the Event Hub `MyEventHubName`.

Example 2: InputObject - Using Variable:

$inputobject = Get-AzEventHub <params>
Remove-AzEventHub -InputObject $inputobject

Example 3: InputObject Using Piping:

Get-AzEventHub <params> | Remove-AzEventHub

Example 4: ResourceId - Using Variable:

$resourceid = Get-AzEventHub <params>
Remove-AzEventHub -ResourceId $resourceid.Id

Example 5: ResourceId - Using string:

Remove-AzEventHub -ResourceId "/subscriptions/xxxx-xxxxx-xxxxxx-xxxxxx/resourceGroups/ResourceGroupName/providers/Microsoft.EventHub/namespaces/NamespaceName/eventhubs/EventHubName"

Parameters

-AsJob

Run cmdlet in the background

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

-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:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

Eventhub Object

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

-Name

EventHub Name

Type:	String
Aliases:	EventHubName
Position:	2
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-Namespace

Namespace Name

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

-PassThru

Specifying this will return true if the command was successful.

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

-ResourceGroupName

Resource Group Name

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

-ResourceId

Eventhub Resource Id

Type:	String
Position:	0
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

PSEventHubAttributes

Outputs

Boolean