Set-​Azure​Rm​Event​Hub​Consumer​Group

Updates the specified Event Hubs consumer group.

Syntax

Set-AzureRmEventHubConsumerGroup
   [-ResourceGroupName] <String>
   [-NamespaceName] <String>
   [-EventHubName] <String>
   [-ConsumerGroupName] <String>
   [-Confirm]
   [-WhatIf]
   [-UserMetadata <String>]
   [<CommonParameters>]

Description

The Set-AzureRmEventHubConsumerGroup cmdlet updates the specified Event Hubs consumer group.

Examples

Example 1

PS C:\> Set-AzureRmEventHubConsumerGroup -ResourceGroupName MyResourceGroupName -NamespaceName MyNamespaceName -EventHubName MyEventHubName -ConsumerGroupName MyConsumerGroupName -UserMetadata "Testing"

Sets the user metadata of the consumer group MyConsumerGroupName to "Testing."

Required Parameters

-ConsumerGroupName

The consumer group name.

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

The Event Hub name.

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

The Event Hubs namespace name.

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

Resource group name.

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

User metadata for the consumer group (optional).

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
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

Microsoft.Azure.Commands.EventHub.Models.ConsumerGroupAttributes