Get-AzEventHubConsumerGroup

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

指定したコンシューマー グループの説明を取得します。

構文

Get-AzEventHubConsumerGroup
   -EventHubName <String>
   -NamespaceName <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-Skip <Int32>]
   [-Top <Int32>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzEventHubConsumerGroup
   -EventHubName <String>
   -Name <String>
   -NamespaceInputObject <IEventHubIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzEventHubConsumerGroup
   -EventHubName <String>
   -Name <String>
   -NamespaceName <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzEventHubConsumerGroup
   -Name <String>
   -EventhubInputObject <IEventHubIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzEventHubConsumerGroup
   -InputObject <IEventHubIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

説明

指定したコンシューマー グループの説明を取得します。

例

例 1: EventHub コンシューマー グループを取得する

Get-AzEventHubConsumerGroup -Name '$Default' -NamespaceName myNamespace -ResourceGroupName myResourceGroup -EventHubName myEventHub

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

eventhub エンティティの既定のコンシューマー グループを取得します myEventHub。

例 2: EventHub エンティティ内のすべてのコンシューマー グループを一覧表示する

Get-AzEventHubConsumerGroup -NamespaceName myNamespace -ResourceGroupName myResourceGroup -EventHubName myEventHub

名前空間からエンティティ myEventHub 内のすべてのコンシューマー グループを一覧表示します myNamespace。

パラメーター

-DefaultProfile

DefaultProfile パラメーターは機能しません。 別のサブスクリプションに対してコマンドレットを実行する場合は、使用可能な場合は SubscriptionId パラメーターを使用します。

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

-EventhubInputObject

IDENTITY パラメーター

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

-EventHubName

イベント ハブ名

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

-InputObject

IDENTITY パラメーター

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

-Name

コンシューマー グループ名

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

-NamespaceInputObject

IDENTITY パラメーター

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

-NamespaceName

名前空間名

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

-ResourceGroupName

Azure サブスクリプション内のリソース グループの名前。

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

-Skip

Skip は、前の操作で部分的な結果が返された場合にのみ使用されます。 前の応答に nextLink 要素が含まれている場合、nextLink 要素の値には、後続の呼び出しに使用する開始点を指定する skip パラメーターが含まれます。

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

-SubscriptionId

Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。 サブスクリプション ID は、全ての修理依頼についてURI の一部を生じさせます。

型:String[]
配置:Named
規定値:(Get-AzContext).Subscription.Id
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Top

結果の数を最新の N usageDetails に制限するために使用できます。

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

入力

IEventHubIdentity

出力

IConsumerGroup