你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
New-AzEventHubConsumerGroup
Create an Event Hubs consumer group as a nested resource within a Namespace.
Syntax
New-AzEventHubConsumerGroup
-Name <String>
-EventHubName <String>
-NamespaceName <String>
-ResourceGroupName <String>
[-SubscriptionId <String>]
[-UserMetadata <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] New-AzEventHubConsumerGroup
-Name <String>
-EventHubName <String>
-NamespaceInputObject <IEventHubIdentity>
[-UserMetadata <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] New-AzEventHubConsumerGroup
-Name <String>
-EventHubName <String>
-NamespaceInputObject <IEventHubIdentity>
-Parameter <IConsumerGroup>
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] New-AzEventHubConsumerGroup
-Name <String>
-EventhubInputObject <IEventHubIdentity>
[-UserMetadata <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] New-AzEventHubConsumerGroup
-Name <String>
-EventhubInputObject <IEventHubIdentity>
-Parameter <IConsumerGroup>
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
Create an Event Hubs consumer group as a nested resource within a Namespace.
Examples
Example 1: Create an EventHub ConsumerGroup
New-AzEventHubConsumerGroup -Name myConsumerGroup -NamespaceName myNamespace -ResourceGroupName myResourceGroup -EventHubName myEventHub -UserMetadata "Test ConsumerGroup"
CreatedAt : 9/13/2022 9:20:47 AM
Id : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace
/eventhubs/eh1/consumergroups/myConsumerGroup
Location : australiaeast
Name : myConsumerGroup
ResourceGroupName : myResourceGroup
UpdatedAt : 9/13/2022 9:20:47 AM
UserMetadata : Test ConsumerGroupCreates a new consumer group myConsumerGroup for EventHubs entity myEventHub.
Parameters
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DefaultProfile
The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.
| Type: | PSObject |
| Aliases: | AzureRMContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-EventhubInputObject
Identity Parameter
| Type: | IEventHubIdentity |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-EventHubName
The Event Hub name
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Name
The consumer group name
| Type: | String |
| Aliases: | ConsumerGroupName |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-NamespaceInputObject
Identity Parameter
| Type: | IEventHubIdentity |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-NamespaceName
The Namespace name
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Parameter
Single item in List or Get Consumer group operation
| Type: | IConsumerGroup |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ResourceGroupName
Name of the resource group within the azure subscription.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SubscriptionId
Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
| Type: | String |
| Position: | Named |
| Default value: | (Get-AzContext).Subscription.Id |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-UserMetadata
User Metadata is a placeholder to store user-defined string data with maximum length 1024. e.g. it can be used to store descriptive data, such as list of teams and their contact information also user-defined configuration settings can be stored.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
