Skip to content

Data Source: azurermEventhubConsumerGroup

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

Example Usage

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as azurerm from "./.gen/providers/azurerm";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: azurerm.
For a more precise conversion please use the --provider flag in convert.*/
new azurerm.dataAzurermEventhubConsumerGroup.DataAzurermEventhubConsumerGroup(
  this,
  "test",
  {
    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}",
  }
);

Argument Reference

  • name - Specifies the name of the EventHub Consumer Group resource.

  • namespaceName - Specifies the name of the grandparent EventHub Namespace.

  • eventhubName - Specifies the name of the EventHub.

  • resourceGroupName - The name of the resource group in which the EventHub Consumer Group's grandparent Namespace exists.

Attributes Reference

The following attributes are exported:

  • id - The EventHub Consumer Group ID.

  • userMetadata - Specifies the user metadata.

Timeouts

The timeouts block allows you to specify timeouts for certain actions:

  • read - (Defaults to 5 minutes) Used when retrieving the EventHub Consumer Group.