Set-AzEventHubConsumerGroup
設定 EventHub 取用者群組
Syntax
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 |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Confirm
執行 Cmdlet 之前先提示您確認。
類型: | SwitchParameter |
Aliases: | cf |
Position: | Named |
預設值: | None |
必要: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DefaultProfile
用於與 Azure 通訊的認證、帳戶、租用戶和訂用帳戶。
類型: | PSObject |
Aliases: | AzureRMContext, AzureCredential |
Position: | Named |
預設值: | None |
必要: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-EventHubName
EventHub 的名稱
類型: | String |
Position: | Named |
預設值: | None |
必要: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InputObject
識別參數。 若要建構,請參閱 INPUTOBJECT 屬性的 NOTES 區段並建立哈希表。
類型: | IEventHubIdentity |
Position: | Named |
預設值: | None |
必要: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Name
取用者群組的名稱。
類型: | String |
Aliases: | ConsumerGroupName |
Position: | Named |
預設值: | None |
必要: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-NamespaceName
EventHub 命名空間的名稱
類型: | String |
Position: | Named |
預設值: | None |
必要: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-NoWait
以異步方式執行命令
類型: | SwitchParameter |
Position: | Named |
預設值: | None |
必要: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ResourceGroupName
資源群組的名稱。 名稱不區分大小寫。
類型: | String |
Position: | Named |
預設值: | None |
必要: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-SubscriptionId
目標訂用帳戶的標識碼。
類型: | String |
Position: | Named |
預設值: | (Get-AzContext).Subscription.Id |
必要: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-UserMetadata
用戶元數據是一個佔位元,用來儲存長度上限為1024的使用者定義字串數據。 例如,它可以用來儲存描述性數據,例如小組清單及其連絡資訊,也可以儲存使用者定義的組態設定。
類型: | String |
Position: | Named |
預設值: | None |
必要: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WhatIf
顯示執行 Cmdlet 後會發生的情況。 未執行 Cmdlet。
類型: | SwitchParameter |
Aliases: | wi |
Position: | Named |
預設值: | None |
必要: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
輸入
輸出
意見反應
https://aka.ms/ContentUserFeedback。
即將登場:在 2024 年,我們將逐步淘汰 GitHub 問題作為內容的意見反應機制,並將它取代為新的意見反應系統。 如需詳細資訊,請參閱:提交並檢視相關的意見反應