Add-AzureRmIotHubEventHubConsumerGroup

NAME Add-AzureRmIotHubEventHubConsumerGroup



SYNOPSIS

Creates an eventhub consumer group.





SYNTAX

Add-AzureRmIotHubEventHubConsumerGroup [-ResourceGroupName] <String> [-Name] <String> [-EventHubEndpointName] {events |

operationsMonitoringEvents} [-EventHubConsumerGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-Confirm] [-WhatIf]

[<CommonParameters>]





DESCRIPTION

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





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



-EventHubConsumerGroupName <String>

Name of the EventHub ConsumerGroup that you want to add.



Required? true

Position? 3

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-EventHubEndpointName <String>

Name of the EventHub Endpoint. Possible values events, operationsMonitoringEvents



Required? true

Position? 2

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Name <String>

Name of the Iot Hub



Required? true

Position? 1

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ResourceGroupName <String>

Name of the Resource Group.



Required? true

Position? 0

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







OUTPUTS

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







NOTES









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"







RELATED LINKS

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