get Consume Group
Use this data source to access information about an existing Event Hubs Consumer Group within an Event Hub.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const test = azure.eventhub.getConsumeGroup({
name: testAzurermEventhubConsumerGroup.name,
namespaceName: testAzurermEventhubNamespace.name,
eventhubName: testAzurermEventhub.name,
resourceGroupName: testAzurermResourceGroup.name,
});
Content copied to clipboard
import pulumi
import pulumi_azure as azure
test = azure.eventhub.get_consume_group(name=test_azurerm_eventhub_consumer_group["name"],
namespace_name=test_azurerm_eventhub_namespace["name"],
eventhub_name=test_azurerm_eventhub["name"],
resource_group_name=test_azurerm_resource_group["name"])
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
var test = Azure.EventHub.GetConsumeGroup.Invoke(new()
{
Name = testAzurermEventhubConsumerGroup.Name,
NamespaceName = testAzurermEventhubNamespace.Name,
EventhubName = testAzurermEventhub.Name,
ResourceGroupName = testAzurermResourceGroup.Name,
});
});
Content copied to clipboard
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/eventhub"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := eventhub.GetConsumeGroup(ctx, &eventhub.GetConsumeGroupArgs{
Name: testAzurermEventhubConsumerGroup.Name,
NamespaceName: testAzurermEventhubNamespace.Name,
EventhubName: testAzurermEventhub.Name,
ResourceGroupName: testAzurermResourceGroup.Name,
}, nil)
if err != nil {
return err
}
return nil
})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.eventhub.EventhubFunctions;
import com.pulumi.azure.eventhub.inputs.GetConsumeGroupArgs;
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) {
final var test = EventhubFunctions.getConsumeGroup(GetConsumeGroupArgs.builder()
.name(testAzurermEventhubConsumerGroup.name())
.namespaceName(testAzurermEventhubNamespace.name())
.eventhubName(testAzurermEventhub.name())
.resourceGroupName(testAzurermResourceGroup.name())
.build());
}
}
Content copied to clipboard
variables:
test:
fn::invoke:
function: azure:eventhub:getConsumeGroup
arguments:
name: ${testAzurermEventhubConsumerGroup.name}
namespaceName: ${testAzurermEventhubNamespace.name}
eventhubName: ${testAzurermEventhub.name}
resourceGroupName: ${testAzurermResourceGroup.name}
Content copied to clipboard
API Providers
This data source uses the following Azure API Providers:
Microsoft.EventHub
: 2024-01-01
Return
A collection of values returned by getConsumeGroup.
Parameters
argument
A collection of arguments for invoking getConsumeGroup.
suspend fun getConsumeGroup(eventhubName: String, name: String, namespaceName: String, resourceGroupName: String): GetConsumeGroupResult
Return
A collection of values returned by getConsumeGroup.
Parameters
eventhub Name
Specifies the name of the EventHub.
name
Specifies the name of the EventHub Consumer Group resource.
namespace Name
Specifies the name of the grandparent EventHub Namespace.
resource Group Name
The name of the resource group in which the EventHub Consumer Group's grandparent Namespace exists.
See also
suspend fun getConsumeGroup(argument: suspend GetConsumeGroupPlainArgsBuilder.() -> Unit): GetConsumeGroupResult
Return
A collection of values returned by getConsumeGroup.
Parameters
argument
Builder for com.pulumi.azure.eventhub.kotlin.inputs.GetConsumeGroupPlainArgs.