Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. eventhub
  5. EventHubConsumerGroup

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

azure.eventhub.EventHubConsumerGroup

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure
Deprecated: azure.eventhub.EventHubConsumerGroup has been deprecated in favor of azure.eventhub.ConsumerGroup

Manages a Event Hubs Consumer Group as a nested resource within an Event Hub.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = new azure.core.ResourceGroup("example", {
    name: "example-resources",
    location: "West Europe",
});
const exampleEventHubNamespace = new azure.eventhub.EventHubNamespace("example", {
    name: "acceptanceTestEventHubNamespace",
    location: example.location,
    resourceGroupName: example.name,
    sku: "Basic",
    capacity: 2,
    tags: {
        environment: "Production",
    },
});
const exampleEventHub = new azure.eventhub.EventHub("example", {
    name: "acceptanceTestEventHub",
    namespaceName: exampleEventHubNamespace.name,
    resourceGroupName: example.name,
    partitionCount: 2,
    messageRetention: 2,
});
const exampleConsumerGroup = new azure.eventhub.ConsumerGroup("example", {
    name: "acceptanceTestEventHubConsumerGroup",
    namespaceName: exampleEventHubNamespace.name,
    eventhubName: exampleEventHub.name,
    resourceGroupName: example.name,
    userMetadata: "some-meta-data",
});
Copy
import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example_event_hub_namespace = azure.eventhub.EventHubNamespace("example",
    name="acceptanceTestEventHubNamespace",
    location=example.location,
    resource_group_name=example.name,
    sku="Basic",
    capacity=2,
    tags={
        "environment": "Production",
    })
example_event_hub = azure.eventhub.EventHub("example",
    name="acceptanceTestEventHub",
    namespace_name=example_event_hub_namespace.name,
    resource_group_name=example.name,
    partition_count=2,
    message_retention=2)
example_consumer_group = azure.eventhub.ConsumerGroup("example",
    name="acceptanceTestEventHubConsumerGroup",
    namespace_name=example_event_hub_namespace.name,
    eventhub_name=example_event_hub.name,
    resource_group_name=example.name,
    user_metadata="some-meta-data")
Copy
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/eventhub"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-resources"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleEventHubNamespace, err := eventhub.NewEventHubNamespace(ctx, "example", &eventhub.EventHubNamespaceArgs{
			Name:              pulumi.String("acceptanceTestEventHubNamespace"),
			Location:          example.Location,
			ResourceGroupName: example.Name,
			Sku:               pulumi.String("Basic"),
			Capacity:          pulumi.Int(2),
			Tags: pulumi.StringMap{
				"environment": pulumi.String("Production"),
			},
		})
		if err != nil {
			return err
		}
		exampleEventHub, err := eventhub.NewEventHub(ctx, "example", &eventhub.EventHubArgs{
			Name:              pulumi.String("acceptanceTestEventHub"),
			NamespaceName:     exampleEventHubNamespace.Name,
			ResourceGroupName: example.Name,
			PartitionCount:    pulumi.Int(2),
			MessageRetention:  pulumi.Int(2),
		})
		if err != nil {
			return err
		}
		_, err = eventhub.NewConsumerGroup(ctx, "example", &eventhub.ConsumerGroupArgs{
			Name:              pulumi.String("acceptanceTestEventHubConsumerGroup"),
			NamespaceName:     exampleEventHubNamespace.Name,
			EventhubName:      exampleEventHub.Name,
			ResourceGroupName: example.Name,
			UserMetadata:      pulumi.String("some-meta-data"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "example-resources",
        Location = "West Europe",
    });

    var exampleEventHubNamespace = new Azure.EventHub.EventHubNamespace("example", new()
    {
        Name = "acceptanceTestEventHubNamespace",
        Location = example.Location,
        ResourceGroupName = example.Name,
        Sku = "Basic",
        Capacity = 2,
        Tags = 
        {
            { "environment", "Production" },
        },
    });

    var exampleEventHub = new Azure.EventHub.EventHub("example", new()
    {
        Name = "acceptanceTestEventHub",
        NamespaceName = exampleEventHubNamespace.Name,
        ResourceGroupName = example.Name,
        PartitionCount = 2,
        MessageRetention = 2,
    });

    var exampleConsumerGroup = new Azure.EventHub.ConsumerGroup("example", new()
    {
        Name = "acceptanceTestEventHubConsumerGroup",
        NamespaceName = exampleEventHubNamespace.Name,
        EventhubName = exampleEventHub.Name,
        ResourceGroupName = example.Name,
        UserMetadata = "some-meta-data",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.eventhub.EventHubNamespace;
import com.pulumi.azure.eventhub.EventHubNamespaceArgs;
import com.pulumi.azure.eventhub.EventHub;
import com.pulumi.azure.eventhub.EventHubArgs;
import com.pulumi.azure.eventhub.ConsumerGroup;
import com.pulumi.azure.eventhub.ConsumerGroupArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("example-resources")
            .location("West Europe")
            .build());

        var exampleEventHubNamespace = new EventHubNamespace("exampleEventHubNamespace", EventHubNamespaceArgs.builder()
            .name("acceptanceTestEventHubNamespace")
            .location(example.location())
            .resourceGroupName(example.name())
            .sku("Basic")
            .capacity(2)
            .tags(Map.of("environment", "Production"))
            .build());

        var exampleEventHub = new EventHub("exampleEventHub", EventHubArgs.builder()
            .name("acceptanceTestEventHub")
            .namespaceName(exampleEventHubNamespace.name())
            .resourceGroupName(example.name())
            .partitionCount(2)
            .messageRetention(2)
            .build());

        var exampleConsumerGroup = new ConsumerGroup("exampleConsumerGroup", ConsumerGroupArgs.builder()
            .name("acceptanceTestEventHubConsumerGroup")
            .namespaceName(exampleEventHubNamespace.name())
            .eventhubName(exampleEventHub.name())
            .resourceGroupName(example.name())
            .userMetadata("some-meta-data")
            .build());

    }
}
Copy
resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleEventHubNamespace:
    type: azure:eventhub:EventHubNamespace
    name: example
    properties:
      name: acceptanceTestEventHubNamespace
      location: ${example.location}
      resourceGroupName: ${example.name}
      sku: Basic
      capacity: 2
      tags:
        environment: Production
  exampleEventHub:
    type: azure:eventhub:EventHub
    name: example
    properties:
      name: acceptanceTestEventHub
      namespaceName: ${exampleEventHubNamespace.name}
      resourceGroupName: ${example.name}
      partitionCount: 2
      messageRetention: 2
  exampleConsumerGroup:
    type: azure:eventhub:ConsumerGroup
    name: example
    properties:
      name: acceptanceTestEventHubConsumerGroup
      namespaceName: ${exampleEventHubNamespace.name}
      eventhubName: ${exampleEventHub.name}
      resourceGroupName: ${example.name}
      userMetadata: some-meta-data
Copy

Create EventHubConsumerGroup Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new EventHubConsumerGroup(name: string, args: EventHubConsumerGroupArgs, opts?: CustomResourceOptions);
@overload
def EventHubConsumerGroup(resource_name: str,
                          args: EventHubConsumerGroupArgs,
                          opts: Optional[ResourceOptions] = None)

@overload
def EventHubConsumerGroup(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          eventhub_name: Optional[str] = None,
                          name: Optional[str] = None,
                          namespace_name: Optional[str] = None,
                          resource_group_name: Optional[str] = None,
                          user_metadata: Optional[str] = None)
func NewEventHubConsumerGroup(ctx *Context, name string, args EventHubConsumerGroupArgs, opts ...ResourceOption) (*EventHubConsumerGroup, error)
public EventHubConsumerGroup(string name, EventHubConsumerGroupArgs args, CustomResourceOptions? opts = null)
public EventHubConsumerGroup(String name, EventHubConsumerGroupArgs args)
public EventHubConsumerGroup(String name, EventHubConsumerGroupArgs args, CustomResourceOptions options)

type: azure:eventhub:EventHubConsumerGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. EventHubConsumerGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. EventHubConsumerGroupArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. EventHubConsumerGroupArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. EventHubConsumerGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. EventHubConsumerGroupArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

EventHubConsumerGroup Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The EventHubConsumerGroup resource accepts the following input properties:

EventhubName
This property is required.
Changes to this property will trigger replacement.
string
Specifies the name of the EventHub. Changing this forces a new resource to be created.
NamespaceName
This property is required.
Changes to this property will trigger replacement.
string
Specifies the name of the grandparent EventHub Namespace. Changing this forces a new resource to be created.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group in which the EventHub Consumer Group's grandparent Namespace exists. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
Specifies the name of the EventHub Consumer Group resource. Changing this forces a new resource to be created.
UserMetadata string
Specifies the user metadata.
EventhubName
This property is required.
Changes to this property will trigger replacement.
string
Specifies the name of the EventHub. Changing this forces a new resource to be created.
NamespaceName
This property is required.
Changes to this property will trigger replacement.
string
Specifies the name of the grandparent EventHub Namespace. Changing this forces a new resource to be created.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group in which the EventHub Consumer Group's grandparent Namespace exists. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
Specifies the name of the EventHub Consumer Group resource. Changing this forces a new resource to be created.
UserMetadata string
Specifies the user metadata.
eventhubName
This property is required.
Changes to this property will trigger replacement.
String
Specifies the name of the EventHub. Changing this forces a new resource to be created.
namespaceName
This property is required.
Changes to this property will trigger replacement.
String
Specifies the name of the grandparent EventHub Namespace. Changing this forces a new resource to be created.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group in which the EventHub Consumer Group's grandparent Namespace exists. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
Specifies the name of the EventHub Consumer Group resource. Changing this forces a new resource to be created.
userMetadata String
Specifies the user metadata.
eventhubName
This property is required.
Changes to this property will trigger replacement.
string
Specifies the name of the EventHub. Changing this forces a new resource to be created.
namespaceName
This property is required.
Changes to this property will trigger replacement.
string
Specifies the name of the grandparent EventHub Namespace. Changing this forces a new resource to be created.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group in which the EventHub Consumer Group's grandparent Namespace exists. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. string
Specifies the name of the EventHub Consumer Group resource. Changing this forces a new resource to be created.
userMetadata string
Specifies the user metadata.
eventhub_name
This property is required.
Changes to this property will trigger replacement.
str
Specifies the name of the EventHub. Changing this forces a new resource to be created.
namespace_name
This property is required.
Changes to this property will trigger replacement.
str
Specifies the name of the grandparent EventHub Namespace. Changing this forces a new resource to be created.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group in which the EventHub Consumer Group's grandparent Namespace exists. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. str
Specifies the name of the EventHub Consumer Group resource. Changing this forces a new resource to be created.
user_metadata str
Specifies the user metadata.
eventhubName
This property is required.
Changes to this property will trigger replacement.
String
Specifies the name of the EventHub. Changing this forces a new resource to be created.
namespaceName
This property is required.
Changes to this property will trigger replacement.
String
Specifies the name of the grandparent EventHub Namespace. Changing this forces a new resource to be created.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group in which the EventHub Consumer Group's grandparent Namespace exists. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
Specifies the name of the EventHub Consumer Group resource. Changing this forces a new resource to be created.
userMetadata String
Specifies the user metadata.

Outputs

All input properties are implicitly available as output properties. Additionally, the EventHubConsumerGroup resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing EventHubConsumerGroup Resource

Get an existing EventHubConsumerGroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: EventHubConsumerGroupState, opts?: CustomResourceOptions): EventHubConsumerGroup
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        eventhub_name: Optional[str] = None,
        name: Optional[str] = None,
        namespace_name: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        user_metadata: Optional[str] = None) -> EventHubConsumerGroup
func GetEventHubConsumerGroup(ctx *Context, name string, id IDInput, state *EventHubConsumerGroupState, opts ...ResourceOption) (*EventHubConsumerGroup, error)
public static EventHubConsumerGroup Get(string name, Input<string> id, EventHubConsumerGroupState? state, CustomResourceOptions? opts = null)
public static EventHubConsumerGroup get(String name, Output<String> id, EventHubConsumerGroupState state, CustomResourceOptions options)
resources:  _:    type: azure:eventhub:EventHubConsumerGroup    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
EventhubName Changes to this property will trigger replacement. string
Specifies the name of the EventHub. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
Specifies the name of the EventHub Consumer Group resource. Changing this forces a new resource to be created.
NamespaceName Changes to this property will trigger replacement. string
Specifies the name of the grandparent EventHub Namespace. Changing this forces a new resource to be created.
ResourceGroupName Changes to this property will trigger replacement. string
The name of the resource group in which the EventHub Consumer Group's grandparent Namespace exists. Changing this forces a new resource to be created.
UserMetadata string
Specifies the user metadata.
EventhubName Changes to this property will trigger replacement. string
Specifies the name of the EventHub. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
Specifies the name of the EventHub Consumer Group resource. Changing this forces a new resource to be created.
NamespaceName Changes to this property will trigger replacement. string
Specifies the name of the grandparent EventHub Namespace. Changing this forces a new resource to be created.
ResourceGroupName Changes to this property will trigger replacement. string
The name of the resource group in which the EventHub Consumer Group's grandparent Namespace exists. Changing this forces a new resource to be created.
UserMetadata string
Specifies the user metadata.
eventhubName Changes to this property will trigger replacement. String
Specifies the name of the EventHub. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
Specifies the name of the EventHub Consumer Group resource. Changing this forces a new resource to be created.
namespaceName Changes to this property will trigger replacement. String
Specifies the name of the grandparent EventHub Namespace. Changing this forces a new resource to be created.
resourceGroupName Changes to this property will trigger replacement. String
The name of the resource group in which the EventHub Consumer Group's grandparent Namespace exists. Changing this forces a new resource to be created.
userMetadata String
Specifies the user metadata.
eventhubName Changes to this property will trigger replacement. string
Specifies the name of the EventHub. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. string
Specifies the name of the EventHub Consumer Group resource. Changing this forces a new resource to be created.
namespaceName Changes to this property will trigger replacement. string
Specifies the name of the grandparent EventHub Namespace. Changing this forces a new resource to be created.
resourceGroupName Changes to this property will trigger replacement. string
The name of the resource group in which the EventHub Consumer Group's grandparent Namespace exists. Changing this forces a new resource to be created.
userMetadata string
Specifies the user metadata.
eventhub_name Changes to this property will trigger replacement. str
Specifies the name of the EventHub. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. str
Specifies the name of the EventHub Consumer Group resource. Changing this forces a new resource to be created.
namespace_name Changes to this property will trigger replacement. str
Specifies the name of the grandparent EventHub Namespace. Changing this forces a new resource to be created.
resource_group_name Changes to this property will trigger replacement. str
The name of the resource group in which the EventHub Consumer Group's grandparent Namespace exists. Changing this forces a new resource to be created.
user_metadata str
Specifies the user metadata.
eventhubName Changes to this property will trigger replacement. String
Specifies the name of the EventHub. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
Specifies the name of the EventHub Consumer Group resource. Changing this forces a new resource to be created.
namespaceName Changes to this property will trigger replacement. String
Specifies the name of the grandparent EventHub Namespace. Changing this forces a new resource to be created.
resourceGroupName Changes to this property will trigger replacement. String
The name of the resource group in which the EventHub Consumer Group's grandparent Namespace exists. Changing this forces a new resource to be created.
userMetadata String
Specifies the user metadata.

Import

EventHub Consumer Groups can be imported using the resource id, e.g.

$ pulumi import azure:eventhub/eventHubConsumerGroup:EventHubConsumerGroup consumerGroup1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.EventHub/namespaces/namespace1/eventhubs/eventhub1/consumerGroups/consumerGroup1
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Azure Classic pulumi/pulumi-azure
License
Apache-2.0
Notes
This Pulumi package is based on the azurerm Terraform Provider.

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure