次の方法で共有

Set-AzEventHubConsumerGroup

  • リファレンス
モジュール:
Az.EventHub

指定した Event Hubs コンシューマー グループを更新します。

構文

Set-AzEventHubConsumerGroup
   [-ResourceGroupName] <String>
   [-Namespace] <String>
   [-EventHub] <String>
   [-Name] <String>
   [[-UserMetadata] <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

説明

Set-AzEventHubConsumerGroup コマンドレットは、指定された Event Hubs コンシューマー グループを更新します。

例

例 1

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

コンシューマー グループ 'MyConsumerGroupName' のユーザー メタデータを "Testing" に設定します。

パラメーター

-Confirm

コマンドレットの実行前に確認を求めるメッセージが表示されます。

型:SwitchParameter
Aliases:cf
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-DefaultProfile

Azure との通信のために使用される資格情報、アカウント、テナント、サブスクリプションです。

型:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-EventHub

EventHub 名

型:String
Aliases:EventHubName
配置:2
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-Name

ConsumerGroup 名

型:String
Aliases:ConsumerGroupName
配置:3
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-Namespace

名前空間名

型:String
Aliases:NamespaceName
配置:1
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-ResourceGroupName

リソース グループ名

型:String
配置:0
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-UserMetadata

ConsumerGroup のユーザー メタデータ

型:String
配置:4
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-WhatIf

コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。

型:SwitchParameter
Aliases:wi
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

入力

String

出力

PSConsumerGroupAttributes