Skip to content

Get-AzEventHubConsumerGroup.md

Latest commit

 

History

History
258 lines (201 loc) · 6.06 KB

Get-AzEventHubConsumerGroup.md

File metadata and controls

258 lines (201 loc) · 6.06 KB
Raw
external help file
Module Name Az.EventHub
online version https://learn.microsoft.com/powershell/module/az.eventhub/get-azeventhubconsumergroup
schema 2.0.0

Get-AzEventHubConsumerGroup

SYNOPSIS

Gets a description for the specified consumer group.

SYNTAX

List (Default)

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

Get

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

GetViaIdentity

Get-AzEventHubConsumerGroup -InputObject <IEventHubIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>]

GetViaIdentityEventhub

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

GetViaIdentityNamespace

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

DESCRIPTION

Gets a description for the specified consumer group.

EXAMPLES

Example 1: Get an EventHub consumer group

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                 :

Gets default consumer group of eventhub entity myEventHub.

Example 2: List all consumer groups in an EventHub entity

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

Lists all consumer groups in entity myEventHub from namespace myNamespace.

PARAMETERS

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Type: System.Management.Automation.PSObject
Parameter Sets: (All)
Aliases: AzureRMContext, AzureCredential

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-EventhubInputObject

Identity Parameter

Type: Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IEventHubIdentity
Parameter Sets: GetViaIdentityEventhub
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-EventHubName

The Event Hub name

Type: System.String
Parameter Sets: Get, GetViaIdentityNamespace, List
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-InputObject

Identity Parameter

Type: Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IEventHubIdentity
Parameter Sets: GetViaIdentity
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Name

The consumer group name

Type: System.String
Parameter Sets: Get, GetViaIdentityEventhub, GetViaIdentityNamespace
Aliases: ConsumerGroupName

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-NamespaceInputObject

Identity Parameter

Type: Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IEventHubIdentity
Parameter Sets: GetViaIdentityNamespace
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-NamespaceName

The Namespace name

Type: System.String
Parameter Sets: Get, List
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ResourceGroupName

The name of the resource group. The name is case insensitive.

Type: System.String
Parameter Sets: Get, List
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Skip

Skip is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skip parameter that specifies a starting point to use for subsequent calls.

Type: System.Int32
Parameter Sets: List
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-SubscriptionId

The ID of the target subscription.

Type: System.String[]
Parameter Sets: Get, List
Aliases:

Required: False
Position: Named
Default value: (Get-AzContext).Subscription.Id
Accept pipeline input: False
Accept wildcard characters: False

-Top

May be used to limit the number of results to the most recent N usageDetails.

Type: System.Int32
Parameter Sets: List
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IEventHubIdentity

OUTPUTS

Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IConsumerGroup

NOTES

RELATED LINKS