Partilhar via

Get-AzEventHubConsumerGroup

  • Referência
Módulo:
Az.EventHub

Obtém uma descrição para o grupo de consumidores especificado.

Sintaxe

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

Obtém uma descrição para o grupo de consumidores especificado.

Exemplos

Exemplo 1: Obter um grupo de consumidores do 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                 :

Obtém o grupo de consumidores padrão da entidade eventhub myEventHub.

Exemplo 2: Listar todos os grupos de consumidores em uma entidade do EventHub

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

Lista todos os grupos de consumidores no myEventHub de entidade do namespace myNamespace.

Parâmetros

-DefaultProfile

O parâmetro DefaultProfile não é funcional. Use o parâmetro SubscriptionId quando disponível se estiver executando o cmdlet em uma assinatura diferente.

Tipo:PSObject
Aliases:AzureRMContext, AzureCredential
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-EventhubInputObject

Parâmetro de identidade

Tipo:IEventHubIdentity
Position:Named
Default value:None
Necessário:True
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-EventHubName

O nome do Hub de Eventos

Tipo:String
Position:Named
Default value:None
Necessário:True
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-InputObject

Parâmetro de identidade

Tipo:IEventHubIdentity
Position:Named
Default value:None
Necessário:True
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-Name

O nome do grupo de consumidores

Tipo:String
Aliases:ConsumerGroupName
Position:Named
Default value:None
Necessário:True
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-NamespaceInputObject

Parâmetro de identidade

Tipo:IEventHubIdentity
Position:Named
Default value:None
Necessário:True
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-NamespaceName

O nome do namespace

Tipo:String
Position:Named
Default value:None
Necessário:True
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-ResourceGroupName

Nome do grupo de recursos dentro da assinatura azure.

Tipo:String
Position:Named
Default value:None
Necessário:True
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-Skip

Ignorar só é usado se uma operação anterior retornou um resultado parcial. Se uma resposta anterior contiver um elemento nextLink, o valor do elemento nextLink incluirá um parâmetro skip que especifica um ponto de partida a ser usado para chamadas subsequentes.

Tipo:Int32
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-SubscriptionId

Credenciais de assinatura que identificam exclusivamente uma assinatura do Microsoft Azure. O ID da assinatura faz parte do URI de cada chamada de serviço.

Tipo:String[]
Position:Named
Default value:(Get-AzContext).Subscription.Id
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-Top

Pode ser usado para limitar o número de resultados ao N usageDetails mais recente.

Tipo:Int32
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

Entradas

IEventHubIdentity

Saídas

IConsumerGroup