Get-AzEventHubConsumerGroup
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>]
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>]
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.
Parameter properties
Type: PSObject
Default value: None Supports wildcards: False DontShow: False Aliases: AzureRMContext, AzureCredential
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Identity Parameter
GetViaIdentityEventhub
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-EventHubName
The Event Hub name
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
List
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
GetViaIdentityNamespace
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Get
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Identity Parameter
GetViaIdentity
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-Name
The consumer group name
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: ConsumerGroupName
Parameter sets
GetViaIdentityNamespace
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Get
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
GetViaIdentityEventhub
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Identity Parameter
GetViaIdentityNamespace
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-NamespaceName
The Namespace name
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
List
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Get
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ResourceGroupName
Name of the resource group within the azure subscription.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
List
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Get
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: 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.
Parameter properties
Type: Int32
Default value: None Supports wildcards: False DontShow: False
Parameter sets
List
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SubscriptionId
Subscription credentials that uniquely identify a Microsoft Azure subscription.
The subscription ID forms part of the URI for every service call.
Parameter properties
Type: String [ ]
Default value: (Get-AzContext).Subscription.Id Supports wildcards: False DontShow: False
Parameter sets
List
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Get
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Top
May be used to limit the number of results to the most recent N usageDetails.
Parameter properties
Type: Int32
Default value: None Supports wildcards: False DontShow: False
Parameter sets
List
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters .
Outputs
