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

Description

設定 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

目標訂用帳戶的標識碼。

類型:	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

共用方式為