GetConsumeGroup

Use this data source to access information about an existing Event Hubs Consumer Group within an Event Hub.

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var test = Output.Create(Azure.EventHub.GetConsumeGroup.InvokeAsync(new Azure.EventHub.GetConsumeGroupArgs
        {
            EventhubName = azurerm_eventhub.Test.Name,
            Name = azurerm_eventhub_consumer_group.Test.Name,
            NamespaceName = azurerm_eventhub_namespace.Test.Name,
            ResourceGroupName = azurerm_resource_group.Test.Name,
        }));
    }

}
package main

import (
    "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 {
        _, err := eventhub.GetConsumeGroup(ctx, &eventhub.GetConsumeGroupArgs{
            EventhubName:      azurerm_eventhub.Test.Name,
            Name:              azurerm_eventhub_consumer_group.Test.Name,
            NamespaceName:     azurerm_eventhub_namespace.Test.Name,
            ResourceGroupName: azurerm_resource_group.Test.Name,
        }, nil)
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_azure as azure

test = azure.eventhub.get_consume_group(eventhub_name=azurerm_eventhub["test"]["name"],
    name=azurerm_eventhub_consumer_group["test"]["name"],
    namespace_name=azurerm_eventhub_namespace["test"]["name"],
    resource_group_name=azurerm_resource_group["test"]["name"])
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const test = pulumi.all([azurerm_eventhub_test.name, azurerm_eventhub_consumer_group_test.name, azurerm_eventhub_namespace_test.name, azurerm_resource_group_test.name]).apply(([azurerm_eventhub_testName, azurerm_eventhub_consumer_group_testName, azurerm_eventhub_namespace_testName, azurerm_resource_group_testName]) => azure.eventhub.getConsumeGroup({
    eventhubName: azurerm_eventhub_testName,
    name: azurerm_eventhub_consumer_group_testName,
    namespaceName: azurerm_eventhub_namespace_testName,
    resourceGroupName: azurerm_resource_group_testName,
}, { async: true }));

Using GetConsumeGroup

function getConsumeGroup(args: GetConsumeGroupArgs, opts?: InvokeOptions): Promise<GetConsumeGroupResult>
function  get_consume_group(eventhub_name=None, name=None, namespace_name=None, resource_group_name=None, opts=None)
func GetConsumeGroup(ctx *Context, args *GetConsumeGroupArgs, opts ...InvokeOption) (*GetConsumeGroupResult, error)
public static class GetConsumeGroup {
    public static Task<GetConsumeGroupResult> InvokeAsync(GetConsumeGroupArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

EventhubName string

Specifies the name of the EventHub.

Name string

Specifies the name of the EventHub Consumer Group resource.

NamespaceName string

Specifies the name of the grandparent EventHub Namespace.

ResourceGroupName string

The name of the resource group in which the EventHub Consumer Group’s grandparent Namespace exists.

EventhubName string

Specifies the name of the EventHub.

Name string

Specifies the name of the EventHub Consumer Group resource.

NamespaceName string

Specifies the name of the grandparent EventHub Namespace.

ResourceGroupName string

The name of the resource group in which the EventHub Consumer Group’s grandparent Namespace exists.

eventhubName string

Specifies the name of the EventHub.

name string

Specifies the name of the EventHub Consumer Group resource.

namespaceName string

Specifies the name of the grandparent EventHub Namespace.

resourceGroupName string

The name of the resource group in which the EventHub Consumer Group’s grandparent Namespace exists.

eventhub_name str

Specifies the name of the EventHub.

name str

Specifies the name of the EventHub Consumer Group resource.

namespace_name str

Specifies the name of the grandparent EventHub Namespace.

resource_group_name str

The name of the resource group in which the EventHub Consumer Group’s grandparent Namespace exists.

GetConsumeGroup Result

The following output properties are available:

EventhubName string
Id string

The provider-assigned unique ID for this managed resource.

Location string
Name string
NamespaceName string
ResourceGroupName string
UserMetadata string

Specifies the user metadata.

EventhubName string
Id string

The provider-assigned unique ID for this managed resource.

Location string
Name string
NamespaceName string
ResourceGroupName string
UserMetadata string

Specifies the user metadata.

eventhubName string
id string

The provider-assigned unique ID for this managed resource.

location string
name string
namespaceName string
resourceGroupName string
userMetadata string

Specifies the user metadata.

eventhub_name str
id str

The provider-assigned unique ID for this managed resource.

location str
name str
namespace_name str
resource_group_name str
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.