EventHubConsumerGroup

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

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
        {
            Location = "West US",
        });
        var exampleEventHubNamespace = new Azure.EventHub.EventHubNamespace("exampleEventHubNamespace", new Azure.EventHub.EventHubNamespaceArgs
        {
            Location = "West US",
            ResourceGroupName = exampleResourceGroup.Name,
            Sku = "Basic",
            Capacity = 2,
            Tags = 
            {
                { "environment", "Production" },
            },
        });
        var exampleEventHub = new Azure.EventHub.EventHub("exampleEventHub", new Azure.EventHub.EventHubArgs
        {
            NamespaceName = exampleEventHubNamespace.Name,
            ResourceGroupName = exampleResourceGroup.Name,
            PartitionCount = 2,
            MessageRetention = 2,
        });
        var exampleConsumerGroup = new Azure.EventHub.ConsumerGroup("exampleConsumerGroup", new Azure.EventHub.ConsumerGroupArgs
        {
            NamespaceName = exampleEventHubNamespace.Name,
            EventhubName = exampleEventHub.Name,
            ResourceGroupName = exampleResourceGroup.Name,
            UserMetadata = "some-meta-data",
        });
    }

}

package main

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

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
            Location: pulumi.String("West US"),
        })
        if err != nil {
            return err
        }
        exampleEventHubNamespace, err := eventhub.NewEventHubNamespace(ctx, "exampleEventHubNamespace", &eventhub.EventHubNamespaceArgs{
            Location:          pulumi.String("West US"),
            ResourceGroupName: exampleResourceGroup.Name,
            Sku:               pulumi.String("Basic"),
            Capacity:          pulumi.Int(2),
            Tags: pulumi.Map{
                "environment": pulumi.String("Production"),
            },
        })
        if err != nil {
            return err
        }
        exampleEventHub, err := eventhub.NewEventHub(ctx, "exampleEventHub", &eventhub.EventHubArgs{
            NamespaceName:     exampleEventHubNamespace.Name,
            ResourceGroupName: exampleResourceGroup.Name,
            PartitionCount:    pulumi.Int(2),
            MessageRetention:  pulumi.Int(2),
        })
        if err != nil {
            return err
        }
        _, err = eventhub.NewConsumerGroup(ctx, "exampleConsumerGroup", &eventhub.ConsumerGroupArgs{
            NamespaceName:     exampleEventHubNamespace.Name,
            EventhubName:      exampleEventHub.Name,
            ResourceGroupName: exampleResourceGroup.Name,
            UserMetadata:      pulumi.String("some-meta-data"),
        })
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
example_event_hub_namespace = azure.eventhub.EventHubNamespace("exampleEventHubNamespace",
    location="West US",
    resource_group_name=example_resource_group.name,
    sku="Basic",
    capacity=2,
    tags={
        "environment": "Production",
    })
example_event_hub = azure.eventhub.EventHub("exampleEventHub",
    namespace_name=example_event_hub_namespace.name,
    resource_group_name=example_resource_group.name,
    partition_count=2,
    message_retention=2)
example_consumer_group = azure.eventhub.ConsumerGroup("exampleConsumerGroup",
    namespace_name=example_event_hub_namespace.name,
    eventhub_name=example_event_hub.name,
    resource_group_name=example_resource_group.name,
    user_metadata="some-meta-data")

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

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US"});
const exampleEventHubNamespace = new azure.eventhub.EventHubNamespace("exampleEventHubNamespace", {
    location: "West US",
    resourceGroupName: exampleResourceGroup.name,
    sku: "Basic",
    capacity: 2,
    tags: {
        environment: "Production",
    },
});
const exampleEventHub = new azure.eventhub.EventHub("exampleEventHub", {
    namespaceName: exampleEventHubNamespace.name,
    resourceGroupName: exampleResourceGroup.name,
    partitionCount: 2,
    messageRetention: 2,
});
const exampleConsumerGroup = new azure.eventhub.ConsumerGroup("exampleConsumerGroup", {
    namespaceName: exampleEventHubNamespace.name,
    eventhubName: exampleEventHub.name,
    resourceGroupName: exampleResourceGroup.name,
    userMetadata: "some-meta-data",
});

Deprecated: azure.eventhub.EventHubConsumerGroup has been deprecated in favor of azure.eventhub.ConsumerGroup

Create a EventHubConsumerGroup Resource

new EventHubConsumerGroup(name: string, args: EventHubConsumerGroupArgs, opts?: CustomResourceOptions);

def EventHubConsumerGroup(resource_name, opts=None, eventhub_name=None, name=None, namespace_name=None, resource_group_name=None, user_metadata=None, __props__=None);

func NewEventHubConsumerGroup(ctx *Context, name string, args EventHubConsumerGroupArgs, opts ...ResourceOption) (*EventHubConsumerGroup, error)

public EventHubConsumerGroup(string name, EventHubConsumerGroupArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args EventHubConsumerGroupArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args EventHubConsumerGroupArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args EventHubConsumerGroupArgs: The arguments to resource properties.
opts 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 Programming Model docs.

Inputs

The EventHubConsumerGroup resource accepts the following input properties:

EventhubName string: Specifies the name of the EventHub. Changing this forces a new resource to be created.
NamespaceName string: Specifies the name of the grandparent EventHub Namespace. Changing this forces a new resource to be created.
ResourceGroupName 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 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 string: Specifies the name of the EventHub. Changing this forces a new resource to be created.
NamespaceName string: Specifies the name of the grandparent EventHub Namespace. Changing this forces a new resource to be created.
ResourceGroupName 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 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 string: Specifies the name of the EventHub. Changing this forces a new resource to be created.
namespaceName string: Specifies the name of the grandparent EventHub Namespace. Changing this forces a new resource to be created.
resourceGroupName 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 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 str: Specifies the name of the EventHub. Changing this forces a new resource to be created.
namespace_name str: Specifies the name of the grandparent EventHub Namespace. Changing this forces a new resource to be created.
resource_group_name 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 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.

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 str: The provider-assigned unique ID for this managed resource.

Look up an 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

static get(resource_name, id, opts=None, eventhub_name=None, name=None, namespace_name=None, resource_group_name=None, user_metadata=None, __props__=None);

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)

name: The unique name of the resulting resource.
id: 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: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: 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: The unique name of the resulting resource.
id: 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 string: Specifies the name of the EventHub. Changing this forces a new resource to be created.
Name string: Specifies the name of the EventHub Consumer Group resource. Changing this forces a new resource to be created.
NamespaceName string: Specifies the name of the grandparent EventHub Namespace. Changing this forces a new resource to be created.
ResourceGroupName 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 string: Specifies the name of the EventHub. Changing this forces a new resource to be created.
Name string: Specifies the name of the EventHub Consumer Group resource. Changing this forces a new resource to be created.
NamespaceName string: Specifies the name of the grandparent EventHub Namespace. Changing this forces a new resource to be created.
ResourceGroupName 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 string: Specifies the name of the EventHub. Changing this forces a new resource to be created.
name string: Specifies the name of the EventHub Consumer Group resource. Changing this forces a new resource to be created.
namespaceName string: Specifies the name of the grandparent EventHub Namespace. Changing this forces a new resource to be created.
resourceGroupName 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 str: Specifies the name of the EventHub. Changing this forces a new resource to be created.
name str: Specifies the name of the EventHub Consumer Group resource. Changing this forces a new resource to be created.
namespace_name str: Specifies the name of the grandparent EventHub Namespace. Changing this forces a new resource to be created.
resource_group_name 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.

Package Details

Repository: https://github.com/pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud