azurerm_eventhub_consumer_group doesn't support '$Default' consumer group name

[olitomlinson]

Community Note

• Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritize this request
• Please do not leave "+1" or "me too" comments, they generate extra noise for issue followers and do not help prioritize the request
• If you are interested in working on this issue or have submitted a pull request, please leave a comment

Terraform (and AzureRM Provider) Version

• Terraform v0.12.28
• provider.azurerm v2.1.0

Affected Resource(s)

• azurerm_eventhub_consumer_group

Terraform Configuration Files

resource "azurerm_eventhub_consumer_group" "example" {
  name                = "$Default"
  namespace_name      = azurerm_eventhub_namespace.example.name
  eventhub_name       = azurerm_eventhub.example.name
  resource_group_name = azurerm_resource_group.example.name
  user_metadata       = "some-meta-data"
}

Debug Output

Panic Output

Expected Behavior

Should have accepted the name $Default as this is the name that the azure portal assigns by default if one is not specified, when using the Basic Tier Event Hub Namespace.

Actual Behavior

Error: invalid value for name (The consumer group name can contain only letters, numbers, periods (.), hyphens (-),and underscores (_), up to 50 characters, and it must begin and end with a letter or number.)

Steps to Reproduce

As per example above

1. terraform apply

Important Factoids

References

• #0000

[favoretti]

It is a default consumer group, you don't need to create it, moreover, you can't manage it in any way.

[jackofallops]

For clarity - The Resource cannot create or otherwise manage $Default, however, the Data Source should be able to reference this special case.

[ghost]

This has been released in version 2.28.0 of the provider. Please see the Terraform documentation on provider versioning or reach out if you need any assistance upgrading. As an example:

provider "azurerm" {
    version = "~> 2.28.0"
}
# ... other configuration ...

[ghost]

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.

If you feel this issue should be reopened, we encourage creating a new issue linking back to this one for added context. If you feel I made an error 🤖 🙉 , please reach out to my human friends 👉 [email protected]. Thanks!