How to Import an Azure Event Hub Consumer Group into Terraform

Import Azure Event Hub Consumer Group with Terraback (recommended)

Terraback reverse-engineers your live infrastructure: it reads the Azure Event Hubs resource with read-only credentials, generates the HCL, and produces the exact import block. Two commands take you from a live Azure Event Hub Consumer Group to managed Terraform.

terraback scan all azure --subscription-id YOUR_ID

terraback azure import --method bulk

The Terraform import block

Terraback emits a Terraform 1.5+ import block like the one below. Because the block lives in your configuration, the import is reviewable in a pull request and repeatable across environments.

import {
  to = azurerm_eventhub_consumer_group.analytics
  id = "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/prod-rg/providers/Microsoft.EventHub/namespaces/prod-ehns/eventhubs/telemetry/consumergroups/analytics"
}

Example azurerm_eventhub_consumer_group configuration

Here is a realistic Azure Event Hub Consumer Group block. Terraback generates a fuller version from your actual resource attributes; this is a minimal, valid starting point.

resource "azurerm_eventhub_consumer_group" "analytics" {
  name                = "analytics"
  namespace_name      = "prod-ehns"
  eventhub_name       = "telemetry"
  resource_group_name = "prod-rg"
}

Gotchas when importing a Azure Event Hub Consumer Group

• The ID nests under the event hub and namespace; the consumergroups segment is lowercase in the resource ID.
• The namespace and event hub import separately as azurerm_eventhub_namespace and azurerm_eventhub.
• Every event hub has a built-in $Default consumer group that already exists and should not be recreated.
• All four arguments (name, namespace_name, eventhub_name, resource_group_name) are immutable; a change forces a new consumer group.

Doing it manually with terraform import

The native approach is to write the azurerm_eventhub_consumer_group block by hand, then run terraform import azurerm_eventhub_consumer_group.example <import-id> for every resource, one at a time. That works for a handful of resources, but it does not scale: you author all the HCL yourself and repeat the command for each item. Terraback generates the HCL and the import blocks for your whole account in one pass.

Import other Azure resources