Azure Classic v5.43.0, May 6 23

azure.eventhub.EventHubConsumerGroup

Explore with Pulumi AI

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

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

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

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

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

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

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleEventHubNamespace, err := eventhub.NewEventHubNamespace(ctx, "exampleEventHubNamespace", &eventhub.EventHubNamespaceArgs{
			Location:          exampleResourceGroup.Location,
			ResourceGroupName: exampleResourceGroup.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, "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
	})
}

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 exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()        
            .location("West Europe")
            .build());

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

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

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

    }
}

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_event_hub_namespace = azure.eventhub.EventHubNamespace("exampleEventHubNamespace",
    location=example_resource_group.location,
    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 Europe"});
const exampleEventHubNamespace = new azure.eventhub.EventHubNamespace("exampleEventHubNamespace", {
    location: exampleResourceGroup.location,
    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",
});

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

Create EventHubConsumerGroup Resource

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

@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)
@overload
def EventHubConsumerGroup(resource_name: str,
                          args: EventHubConsumerGroupArgs,
                          opts: Optional[ResourceOptions] = 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.

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.
args 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 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.

name String: The unique name of the resource.
args 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

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.

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.

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.

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)

Resource lookup is not supported in YAML

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.

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.

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.

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.

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

Package Details

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