1. Packages
  2. Azure Classic
  3. API Docs
  4. eventhub
  5. ConsumerGroup

We recommend using Azure Native.

Azure Classic v5.81.0 published on Monday, Jun 24, 2024 by Pulumi

azure.eventhub.ConsumerGroup

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.81.0 published on Monday, Jun 24, 2024 by Pulumi

    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",
    });
    
    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")
    
    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 {
    		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
    	})
    }
    
    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",
        });
    
    });
    
    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());
    
        }
    }
    
    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
    

    Create ConsumerGroup Resource

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

    Constructor syntax

    new ConsumerGroup(name: string, args: ConsumerGroupArgs, opts?: CustomResourceOptions);
    @overload
    def ConsumerGroup(resource_name: str,
                      args: ConsumerGroupArgs,
                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def ConsumerGroup(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      eventhub_name: Optional[str] = None,
                      namespace_name: Optional[str] = None,
                      resource_group_name: Optional[str] = None,
                      name: Optional[str] = None,
                      user_metadata: Optional[str] = None)
    func NewConsumerGroup(ctx *Context, name string, args ConsumerGroupArgs, opts ...ResourceOption) (*ConsumerGroup, error)
    public ConsumerGroup(string name, ConsumerGroupArgs args, CustomResourceOptions? opts = null)
    public ConsumerGroup(String name, ConsumerGroupArgs args)
    public ConsumerGroup(String name, ConsumerGroupArgs args, CustomResourceOptions options)
    
    type: azure:eventhub:ConsumerGroup
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args ConsumerGroupArgs
    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 ConsumerGroupArgs
    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 ConsumerGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ConsumerGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ConsumerGroupArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var consumerGroupResource = new Azure.EventHub.ConsumerGroup("consumerGroupResource", new()
    {
        EventhubName = "string",
        NamespaceName = "string",
        ResourceGroupName = "string",
        Name = "string",
        UserMetadata = "string",
    });
    
    example, err := eventhub.NewConsumerGroup(ctx, "consumerGroupResource", &eventhub.ConsumerGroupArgs{
    	EventhubName:      pulumi.String("string"),
    	NamespaceName:     pulumi.String("string"),
    	ResourceGroupName: pulumi.String("string"),
    	Name:              pulumi.String("string"),
    	UserMetadata:      pulumi.String("string"),
    })
    
    var consumerGroupResource = new ConsumerGroup("consumerGroupResource", ConsumerGroupArgs.builder()
        .eventhubName("string")
        .namespaceName("string")
        .resourceGroupName("string")
        .name("string")
        .userMetadata("string")
        .build());
    
    consumer_group_resource = azure.eventhub.ConsumerGroup("consumerGroupResource",
        eventhub_name="string",
        namespace_name="string",
        resource_group_name="string",
        name="string",
        user_metadata="string")
    
    const consumerGroupResource = new azure.eventhub.ConsumerGroup("consumerGroupResource", {
        eventhubName: "string",
        namespaceName: "string",
        resourceGroupName: "string",
        name: "string",
        userMetadata: "string",
    });
    
    type: azure:eventhub:ConsumerGroup
    properties:
        eventhubName: string
        name: string
        namespaceName: string
        resourceGroupName: string
        userMetadata: string
    

    ConsumerGroup 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 ConsumerGroup 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 ConsumerGroup 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 ConsumerGroup Resource

    Get an existing ConsumerGroup 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?: ConsumerGroupState, opts?: CustomResourceOptions): ConsumerGroup
    @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) -> ConsumerGroup
    func GetConsumerGroup(ctx *Context, name string, id IDInput, state *ConsumerGroupState, opts ...ResourceOption) (*ConsumerGroup, error)
    public static ConsumerGroup Get(string name, Input<string> id, ConsumerGroupState? state, CustomResourceOptions? opts = null)
    public static ConsumerGroup get(String name, Output<String> id, ConsumerGroupState 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/consumerGroup:ConsumerGroup consumerGroup1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.EventHub/namespaces/namespace1/eventhubs/eventhub1/consumerGroups/consumerGroup1
    

    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.
    azure logo

    We recommend using Azure Native.

    Azure Classic v5.81.0 published on Monday, Jun 24, 2024 by Pulumi