1. Packages
  2. Azure Native
  3. API Docs
  4. eventhub
  5. ConsumerGroup
Azure Native v1.103.0 published on Friday, Jun 2, 2023 by Pulumi

azure-native.eventhub.ConsumerGroup

Explore with Pulumi AI

azure-native logo
Azure Native v1.103.0 published on Friday, Jun 2, 2023 by Pulumi

    Single item in List or Get Consumer group operation API Version: 2017-04-01.

    Example Usage

    ConsumerGroupCreate

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var consumerGroup = new AzureNative.EventHub.ConsumerGroup("consumerGroup", new()
        {
            ConsumerGroupName = "sdk-ConsumerGroup-5563",
            EventHubName = "sdk-EventHub-6681",
            NamespaceName = "sdk-Namespace-2661",
            ResourceGroupName = "ArunMonocle",
            UserMetadata = "New consumergroup",
        });
    
    });
    
    package main
    
    import (
    	eventhub "github.com/pulumi/pulumi-azure-native-sdk/eventhub"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := eventhub.NewConsumerGroup(ctx, "consumerGroup", &eventhub.ConsumerGroupArgs{
    			ConsumerGroupName: pulumi.String("sdk-ConsumerGroup-5563"),
    			EventHubName:      pulumi.String("sdk-EventHub-6681"),
    			NamespaceName:     pulumi.String("sdk-Namespace-2661"),
    			ResourceGroupName: pulumi.String("ArunMonocle"),
    			UserMetadata:      pulumi.String("New consumergroup"),
    		})
    		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.azurenative.eventhub.ConsumerGroup;
    import com.pulumi.azurenative.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 consumerGroup = new ConsumerGroup("consumerGroup", ConsumerGroupArgs.builder()        
                .consumerGroupName("sdk-ConsumerGroup-5563")
                .eventHubName("sdk-EventHub-6681")
                .namespaceName("sdk-Namespace-2661")
                .resourceGroupName("ArunMonocle")
                .userMetadata("New consumergroup")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    consumer_group = azure_native.eventhub.ConsumerGroup("consumerGroup",
        consumer_group_name="sdk-ConsumerGroup-5563",
        event_hub_name="sdk-EventHub-6681",
        namespace_name="sdk-Namespace-2661",
        resource_group_name="ArunMonocle",
        user_metadata="New consumergroup")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const consumerGroup = new azure_native.eventhub.ConsumerGroup("consumerGroup", {
        consumerGroupName: "sdk-ConsumerGroup-5563",
        eventHubName: "sdk-EventHub-6681",
        namespaceName: "sdk-Namespace-2661",
        resourceGroupName: "ArunMonocle",
        userMetadata: "New consumergroup",
    });
    
    resources:
      consumerGroup:
        type: azure-native:eventhub:ConsumerGroup
        properties:
          consumerGroupName: sdk-ConsumerGroup-5563
          eventHubName: sdk-EventHub-6681
          namespaceName: sdk-Namespace-2661
          resourceGroupName: ArunMonocle
          userMetadata: New consumergroup
    

    Create ConsumerGroup Resource

    new ConsumerGroup(name: string, args: ConsumerGroupArgs, opts?: CustomResourceOptions);
    @overload
    def ConsumerGroup(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      consumer_group_name: Optional[str] = None,
                      event_hub_name: Optional[str] = None,
                      namespace_name: Optional[str] = None,
                      resource_group_name: Optional[str] = None,
                      user_metadata: Optional[str] = None)
    @overload
    def ConsumerGroup(resource_name: str,
                      args: ConsumerGroupArgs,
                      opts: Optional[ResourceOptions] = 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-native:eventhub:ConsumerGroup
    properties: # The arguments to resource properties.
    options: # 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.
    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.

    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

    The Event Hub name

    NamespaceName string

    The Namespace name

    ResourceGroupName string

    Name of the resource group within the azure subscription.

    ConsumerGroupName string

    The consumer group name

    UserMetadata string

    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.

    EventHubName string

    The Event Hub name

    NamespaceName string

    The Namespace name

    ResourceGroupName string

    Name of the resource group within the azure subscription.

    ConsumerGroupName string

    The consumer group name

    UserMetadata string

    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.

    eventHubName String

    The Event Hub name

    namespaceName String

    The Namespace name

    resourceGroupName String

    Name of the resource group within the azure subscription.

    consumerGroupName String

    The consumer group name

    userMetadata String

    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.

    eventHubName string

    The Event Hub name

    namespaceName string

    The Namespace name

    resourceGroupName string

    Name of the resource group within the azure subscription.

    consumerGroupName string

    The consumer group name

    userMetadata string

    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.

    event_hub_name str

    The Event Hub name

    namespace_name str

    The Namespace name

    resource_group_name str

    Name of the resource group within the azure subscription.

    consumer_group_name str

    The consumer group name

    user_metadata str

    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.

    eventHubName String

    The Event Hub name

    namespaceName String

    The Namespace name

    resourceGroupName String

    Name of the resource group within the azure subscription.

    consumerGroupName String

    The consumer group name

    userMetadata String

    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.

    Outputs

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

    CreatedAt string

    Exact time the message was created.

    Id string

    The provider-assigned unique ID for this managed resource.

    Name string

    The name of the resource

    Type string

    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    UpdatedAt string

    The exact time the message was updated.

    CreatedAt string

    Exact time the message was created.

    Id string

    The provider-assigned unique ID for this managed resource.

    Name string

    The name of the resource

    Type string

    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    UpdatedAt string

    The exact time the message was updated.

    createdAt String

    Exact time the message was created.

    id String

    The provider-assigned unique ID for this managed resource.

    name String

    The name of the resource

    type String

    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    updatedAt String

    The exact time the message was updated.

    createdAt string

    Exact time the message was created.

    id string

    The provider-assigned unique ID for this managed resource.

    name string

    The name of the resource

    type string

    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    updatedAt string

    The exact time the message was updated.

    created_at str

    Exact time the message was created.

    id str

    The provider-assigned unique ID for this managed resource.

    name str

    The name of the resource

    type str

    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    updated_at str

    The exact time the message was updated.

    createdAt String

    Exact time the message was created.

    id String

    The provider-assigned unique ID for this managed resource.

    name String

    The name of the resource

    type String

    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    updatedAt String

    The exact time the message was updated.

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:eventhub:ConsumerGroup sdk-ConsumerGroup-5563 /subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.EventHub/namespaces/sdk-Namespace-2661/eventhubs/sdk-EventHub-6681/consumergroups/sdk-ConsumerGroup-5563 
    

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    Azure Native v1.103.0 published on Friday, Jun 2, 2023 by Pulumi