Remove-​Azure​Rm​Iot​Hub​Event​Hub​Consumer​Group

Deletes an eventhub consumergroup.

Syntax

Remove-AzureRmIotHubEventHubConsumerGroup
      [-ResourceGroupName] <String>
      [-Name] <String>
      [-EventHubEndpointName] <String>
      [-EventHubConsumerGroupName] <String>
      [-Confirm]
      [-WhatIf]
      [<CommonParameters>]

Description

Deletes an eventhub consumergroup.

Examples

Example 1 Remove eventhub consumergroup from the telemetry eventhub

PS C:\> Remove-AzureRmIotHubEventHubConsumerGroup -ResourceGroupName "myresourcegroup" -Name "myiothub" -EventHubEndpointName events -EventHubConsumerGroupName myconsumergroup

Removes the consumergroup named myconsumergroup from the IotHub named "myiothub"

Required Parameters

-EventHubConsumerGroupName

Name of the Event hub consumer group.

Type:String
Position:3
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-EventHubEndpointName

Name of the event hub endpoint. The possible values are events, operationsMonitoringEvents.

Type:String
Position:2
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Name

Name of the IoT hub.

Type:String
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ResourceGroupName

Name of the resource group.

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

Optional 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
-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

System.String

Outputs

System.Collections.Generic.IEnumerable`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]