Get-AzureRmEventHubConsumerGroup
指定した Event Hubs コンシューマー グループの詳細を取得するか、イベント ハブ内のコンシューマー グループの一覧を取得します。
警告
AzureRM PowerShell モジュールは、2024 年 2 月 29 日に正式に非推奨になりました。 引き続きサポートを受け、更新を受け取れるようにするために、AzureRM から Az PowerShell モジュールに移行することをお勧めします。
AzureRM モジュールの機能は今後も使用できますが、メンテナンスやサポートは行われないため、引き続きの使用はユーザーの判断に委ねられ、リスクが発生することがあります。 Az モジュールへの移行に関するガイダンスについては、移行リソースを参照してください。
構文
Get-AzureRmEventHubConsumerGroup
[-ResourceGroupName] <String>
[-Namespace] <String>
[-EventHub] <String>
[[-Name] <String>]
[-MaxCount <Int32>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
説明
Get-AzureRmEventHubConsumerGroup コマンドレットは、指定された Event Hubs コンシューマー グループの詳細、または特定のイベント ハブ内のコンシューマー グループの一覧を取得します。 コンシューマー グループの名前を指定すると、1 つのコンシューマー グループの詳細が返されます。 コンシューマー グループの名前が指定されていない場合は、指定したイベント ハブ内のコンシューマー グループの一覧が返されます。
例
例 1
PS C:\> Get-AzureRmEventHubConsumerGroup -ResourceGroupName MyResourceGroupName -NamespaceName MyNamespaceName -EventHubName MyEventHubName -ConsumerGroupName MyConsumerGroupName
イベント ハブ 'MyEventHubName' のコンシューマー グループ 'MyConsumerGroupName' を取得します。このグループは、リソース グループ 'MyResourceGroupName' を持つ名前空間 'MyNamespaceName' に存在します。
例 2
PS C:\> Get-AzureRmEventHubConsumerGroup -ResourceGroupName MyResourceGroupName -NamespaceName MyNamespaceName -EventHubName MyEventHubName
リソース グループ 'MyResourceGroupName' を持つ名前空間 'MyNamespaceName' に存在する、イベント ハブ 'MyEventHubName' 内のコンシューマー グループの一覧を取得します。
パラメーター
-DefaultProfile
Azure との通信のために使用される資格情報、アカウント、テナント、サブスクリプションです。
型: | IAzureContextContainer |
Aliases: | AzureRmContext, AzureCredential |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-EventHub
EventHub 名
型: | String |
Aliases: | EventHubName |
配置: | 2 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-MaxCount
返される ConsumerGroup の最大数を決定します。
型: | Nullable<T>[Int32] |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Name
ConsumerGroup 名
型: | String |
Aliases: | ConsumerGroupName |
配置: | 3 |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-Namespace
名前空間名
型: | String |
Aliases: | NamespaceName |
配置: | 1 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-ResourceGroupName
リソース グループ名
型: | String |
配置: | 0 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |