< Back
Remove-AzureRmIotHubEventHubConsumerGroup
Post
NAME Remove-AzureRmIotHubEventHubConsumerGroup
SYNOPSIS
Deletes an eventhub consumergroup.
SYNTAX
Remove-AzureRmIotHubEventHubConsumerGroup [-ResourceGroupName] <String> [-Name] <String> [-EventHubEndpointName] {events |
operationsMonitoringEvents} [-EventHubConsumerGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-Confirm] [-WhatIf]
[<CommonParameters>]
DESCRIPTION
Deletes an eventhub consumergroup.
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>
EventHub ConsumerGroup Name.
Required? true
Position? 3
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-EventHubEndpointName <String>
EventHub Endpoint Name. Possible values events, operationsMonitoringEvents
Required? true
Position? 2
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
Name of the IotHub
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceGroupName <String>
Resource Group Name
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 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"
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... sumergroup
SYNOPSIS
Deletes an eventhub consumergroup.
SYNTAX
Remove-AzureRmIotHubEventHubConsumerGroup [-ResourceGroupName] <String> [-Name] <String> [-EventHubEndpointName] {events |
operationsMonitoringEvents} [-EventHubConsumerGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-Confirm] [-WhatIf]
[<CommonParameters>]
DESCRIPTION
Deletes an eventhub consumergroup.
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>
EventHub ConsumerGroup Name.
Required? true
Position? 3
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-EventHubEndpointName <String>
EventHub Endpoint Name. Possible values events, operationsMonitoringEvents
Required? true
Position? 2
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
Name of the IotHub
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceGroupName <String>
Resource Group Name
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 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"
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... sumergroup