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                 :

Возвращает группу потребителей по умолчанию сущности myEventHubeventhub.

Пример 2. Вывод списка всех групп потребителей в сущности EventHub

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

Выводит список всех групп потребителей в сущности myEventHub из пространства myNamespaceимен.

Параметры

-DefaultProfile

Параметр DefaultProfile не работает. Используйте параметр SubscriptionId, если он доступен при выполнении командлета в другой подписке.

Тип:	PSObject
Aliases:	AzureRMContext, AzureCredential
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-EventhubInputObject

Параметр удостоверения

Тип:	IEventHubIdentity
Position:	Named
Default value:	None
Обязательно:	True
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-EventHubName

Имя концентратора событий

Тип:	String
Position:	Named
Default value:	None
Обязательно:	True
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-InputObject

Параметр удостоверения

Тип:	IEventHubIdentity
Position:	Named
Default value:	None
Обязательно:	True
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-Name

Имя группы потребителей

Тип:	String
Aliases:	ConsumerGroupName
Position:	Named
Default value:	None
Обязательно:	True
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-NamespaceInputObject

Параметр удостоверения

Тип:	IEventHubIdentity
Position:	Named
Default value:	None
Обязательно:	True
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-NamespaceName

Имя пространства имен

Тип:	String
Position:	Named
Default value:	None
Обязательно:	True
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-ResourceGroupName

Имя группы ресурсов в подписке Azure.

Тип:	String
Position:	Named
Default value:	None
Обязательно:	True
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-Skip

Пропуск используется только в том случае, если предыдущая операция вернула частичный результат. Если предыдущий ответ содержит элемент nextLink, значение элемента nextLink будет включать параметр пропуска, указывающий начальную точку для последующих вызовов.

Тип:	Int32
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-SubscriptionId

Учетные данные подписки, которые однозначно определяют подписку Microsoft Azure. Идентификатор подписки формирует часть URI для каждого вызова службы.

Тип:	String[]
Position:	Named
Default value:	(Get-AzContext).Subscription.Id
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-Top

Можно использовать для ограничения количества результатов до последних N usageDetails.

Тип:	Int32
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

Входные данные

IEventHubIdentity

Выходные данные

IConsumerGroup