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

Creates an eventhub consumer group.

Syntax

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

Description

Creates a consumer group in the Eventhub associated with the specified IotHub.

Examples

Example 1: Add a consumer group to the telemetry eventhub

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

Adds a new consumergroup named "myconsumergroup" to the eventhub for telemetry events in the iothub named "myiothub"

Example 2: Add a consumer group to the operations monitoring eventhub

PS C:\> Add-AzureRmIotHubEventHubConsumerGroup -ResourceGroupName "myresourcegroup" -Name "myiothub" -EventHubEndpointName "operationsMonitoringEvents" -EventHubConsumerGroupName "myconsumergroup"

Adds a new consumergroup named "myconsumergroup" to the eventhub for operations monitoring events in the iothub named "myiothub"

Required Parameters

-EventHubConsumerGroupName

Name of the EventHub ConsumerGroup that you want to add.

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

Name of the EventHub Endpoint. Possible values 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:False
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:False
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]]