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

Description

取得指定取用者群組的描述。

範例

範例 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

從命名空間 myNamespace列出實體 myEventHub 中的所有取用者群組。

參數

-DefaultProfile

DefaultProfile 參數無法運作。 如果針對不同的訂用帳戶執行 Cmdlet，請使用 SubscriptionId 參數。

類型:	PSObject
別名:	AzureRMContext, AzureCredential
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-EventhubInputObject

Identity 參數

類型:	IEventHubIdentity
Position:	Named
預設值:	None
必要:	True
接受管線輸入:	True
接受萬用字元:	False

-EventHubName

事件中樞名稱

類型:	String
Position:	Named
預設值:	None
必要:	True
接受管線輸入:	False
接受萬用字元:	False

-InputObject

Identity 參數

類型:	IEventHubIdentity
Position:	Named
預設值:	None
必要:	True
接受管線輸入:	True
接受萬用字元:	False

-Name

取用者組名

類型:	String
別名:	ConsumerGroupName
Position:	Named
預設值:	None
必要:	True
接受管線輸入:	False
接受萬用字元:	False

-NamespaceInputObject

Identity 參數

類型:	IEventHubIdentity
Position:	Named
預設值:	None
必要:	True
接受管線輸入:	True
接受萬用字元:	False

-NamespaceName

命名空間名稱

類型:	String
Position:	Named
預設值:	None
必要:	True
接受管線輸入:	False
接受萬用字元:	False

-ResourceGroupName

Azure 訂用帳戶內的資源組名。

類型:	String
Position:	Named
預設值:	None
必要:	True
接受管線輸入:	False
接受萬用字元:	False

-Skip

只有在先前的作業傳回部分結果時，才會使用Skip。 如果先前的回應包含 nextLink 元素，則 nextLink 元素的值會包含 skip 參數，指定要用於後續呼叫的起點。

類型:	Int32
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-SubscriptionId

可唯一識別Microsoft Azure 訂用帳戶的訂用帳戶認證。 訂用帳戶標識碼會形成每個服務呼叫 URI 的一部分。

類型:	String[]
Position:	Named
預設值:	(Get-AzContext).Subscription.Id
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-Top

可用來將結果數目限制為最新的 N usageDetails。

類型:	Int32
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

輸入

IEventHubIdentity

輸出

IConsumerGroup