Get-AzEventHubConsumerGroup

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

Синтаксис

List (По умолчанию)

Get-AzEventHubConsumerGroup
    -EventHubName <String>
    -NamespaceName <String>
    -ResourceGroupName <String>
    [-SubscriptionId <String[]>]
    [-Skip <Int32>]
    [-Top <Int32>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

GetViaIdentityNamespace

Get-AzEventHubConsumerGroup
    -EventHubName <String>
    -Name <String>
    -NamespaceInputObject <IEventHubIdentity>
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Get

Get-AzEventHubConsumerGroup
    -EventHubName <String>
    -Name <String>
    -NamespaceName <String>
    -ResourceGroupName <String>
    [-SubscriptionId <String[]>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

GetViaIdentityEventhub

Get-AzEventHubConsumerGroup
    -Name <String>
    -EventhubInputObject <IEventHubIdentity>
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

GetViaIdentity

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
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False
Aliases:AzureRMContext, AzureCredential

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-EventhubInputObject

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

Свойства параметров

Тип:IEventHubIdentity
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

GetViaIdentityEventhub
Position:Named
Обязательно:True
Значение из конвейера:True
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-EventHubName

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

Свойства параметров

Тип:String
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

List
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False
GetViaIdentityNamespace
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False
Get
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-InputObject

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

Свойства параметров

Тип:IEventHubIdentity
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

GetViaIdentity
Position:Named
Обязательно:True
Значение из конвейера:True
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-Name

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

Свойства параметров

Тип:String
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False
Aliases:ConsumerGroupName

Наборы параметров

GetViaIdentityNamespace
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False
Get
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False
GetViaIdentityEventhub
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-NamespaceInputObject

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

Свойства параметров

Тип:IEventHubIdentity
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

GetViaIdentityNamespace
Position:Named
Обязательно:True
Значение из конвейера:True
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-NamespaceName

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

Свойства параметров

Тип:String
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

List
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False
Get
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-ResourceGroupName

Имя группы ресурсов. Имя нечувствительно к регистру.

Свойства параметров

Тип:String
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

List
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False
Get
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-Skip

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

Свойства параметров

Тип:Int32
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

List
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-SubscriptionId

Идентификатор целевой подписки.

Свойства параметров

Тип:

String[]

Значение по умолчанию:(Get-AzContext).Subscription.Id
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

List
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False
Get
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-Top

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

Свойства параметров

Тип:Int32
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

List
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

CommonParameters

Этот командлет поддерживает общие параметры: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction и -WarningVariable. Дополнительные сведения см. в разделе about_CommonParameters.

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

IEventHubIdentity

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

IConsumerGroup