Get-AzureRmIotHubEventHubConsumerGroup
Gets all the eventhub consumergroups.
Warning
The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.
Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.
Syntax
Get-AzureRmIotHubEventHubConsumerGroup
[-ResourceGroupName] <String>
[-Name] <String>
[-EventHubEndpointName] <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Description
Gets all the eventhub consumergroups for the different EventHubs used by IotHub.
Examples
Example 1 Gets all the eventhub consumergroups for the telemetry eventhub
PS C:\> Get-AzureRmIotHubEventHubConsumerGroup -ResourceGroupName "myresourcegroup" -Name "myiothub" -EventHubEndpointName "events"Gets all the eventhub consumergroups for the telemetry eventhub for the iothub named myiothub
Example 2 Gets all the eventhub consumergroups for the operationsmonitoring eventhub
PS C:\> Get-AzureRmIotHubEventHubConsumerGroup -ResourceGroupName "myresourcegroup" -Name "myiothub" -EventHubEndpointName "operationsMonitoringEvents"Gets all the eventhub consumergroups for the operationsMonitoringEvents eventhub for the iothub named myiothub
Parameters
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure
| Type: | IAzureContextContainer |
| Aliases: | AzureRmContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-EventHubEndpointName
Name of the Event Hub endpoint. Possible values events, operationsMonitoringEvents
| Type: | String |
| Accepted values: | events, operationsMonitoringEvents |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Name
Name of the IotHub
| Type: | String |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ResourceGroupName
Resource Group Name
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |