你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Set-AzEventHubConsumerGroup

参考

模块:: Az.EventHub

设置 EventHub 使用者组

语法

Set-AzEventHubConsumerGroup
   -Name <String>
   -NamespaceName <String>
   -EventHubName <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String>]
   -UserMetadata <String>
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-AzEventHubConsumerGroup
   -InputObject <IEventHubIdentity>
   -UserMetadata <String>
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

说明

设置 EventHub 使用者组

示例

示例 1：更新 EventHub 使用者组

Set-AzEventHubConsumerGroup -ResourceGroupName myResourceGroup -NamespaceName myNamespace -EventHubName myEventHub -Name myConsumerGroup -UserMetadata "Example Metadata"

CreatedAt                    : 9/13/2022 9:20:47 AM
Id                           : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace
                               /eventhubs/eh1/consumergroups/myConsumerGroup
Location                     : australiaeast
Name                         : myConsumerGroup
ResourceGroupName            : myResourceGroup
UpdatedAt                    : 9/13/2022 9:20:47 AM
UserMetadata                 : Example Metadata

更新在 EventHub 实体myEventHub下创建的使用者组myConsumerGroup。

示例 2：使用 InputObject 参数集更新 EventHub 使用者组

$consumerGroup = Get-AzEventHubConsumerGroup -ResourceGroupName myResourceGroup -NamespaceName myNamespace -EventHubName myEventHub -Name myConsumerGroup
Set-AzEventHubConsumerGroup -InputObject $consumerGroup -UserMetadata "Example Metadata"

CreatedAt                    : 9/13/2022 9:20:47 AM
Id                           : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace
                               /eventhubs/eh1/consumergroups/myConsumerGroup
Location                     : australiaeast
Name                         : myConsumerGroup
ResourceGroupName            : myResourceGroup
UpdatedAt                    : 9/13/2022 9:20:47 AM
UserMetadata                 : Example Metadata

更新在 EventHub 实体myEventHub下创建的使用者组myConsumerGroup。

参数

-AsJob

以作业身份运行命令

类型:	SwitchParameter
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-Confirm

提示你在运行 cmdlet 之前进行确认。

类型:	SwitchParameter
别名:	cf
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-DefaultProfile

用于与 Azure 通信的凭据、帐户、租户和订阅。

类型:	PSObject
别名:	AzureRMContext, AzureCredential
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-EventHubName

EventHub 的名称

类型:	String
Position:	Named
默认值:	None
必需:	True
接受管道输入:	False
接受通配符:	False

-InputObject

标识参数。若要构造，请参阅 INPUTOBJECT 属性的 NOTES 部分并创建哈希表。

类型:	IEventHubIdentity
Position:	Named
默认值:	None
必需:	True
接受管道输入:	True
接受通配符:	False

-Name

使用者组的名称。

类型:	String
别名:	ConsumerGroupName
Position:	Named
默认值:	None
必需:	True
接受管道输入:	False
接受通配符:	False

-NamespaceName

EventHub 命名空间的名称

类型:	String
Position:	Named
默认值:	None
必需:	True
接受管道输入:	False
接受通配符:	False

-NoWait

异步运行命令

类型:	SwitchParameter
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-ResourceGroupName

资源组的名称。此名称不区分大小写。

类型:	String
Position:	Named
默认值:	None
必需:	True
接受管道输入:	False
接受通配符:	False

-SubscriptionId

目标订阅的 ID。

类型:	String
Position:	Named
默认值:	(Get-AzContext).Subscription.Id
必需:	False
接受管道输入:	False
接受通配符:	False

-UserMetadata

用户元数据是一个占位符，用于存储最大长度为 1024 的用户定义字符串数据。例如，它可用于存储描述性数据，例如团队列表及其联系信息，还可以存储用户定义的配置设置。

类型:	String
Position:	Named
默认值:	None
必需:	True
接受管道输入:	False
接受通配符:	False

-WhatIf

显示运行该 cmdlet 时会发生什么情况。 cmdlet 未运行。

类型:	SwitchParameter
别名:	wi
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

输入

IEventHubIdentity

输出

IConsumerGroup

通过