Event Hub Message Retention Change Removes Capture Description

[hitty5]

Is there an existing issue for this?

• I have searched the existing issues

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 Version

1.3.2

AzureRM Provider Version

3.37.0

Affected Resource(s)/Data Source(s)

azurerm_eventhub

Terraform Configuration Files

resource "azurerm_resource_group" "example" {
  name     = "rg-evh-capturing-test-dev"
  location = "West Europe"
}

resource "azurerm_eventhub_namespace" "example" {
  name                = "evhns-capturing-test-dev"
  location            = azurerm_resource_group.example.location
  resource_group_name = azurerm_resource_group.example.name
  sku                 = "Standard"
  capacity            = 1
}

resource "azurerm_eventhub" "example" {
  name                = "caputuring"
  namespace_name      = azurerm_eventhub_namespace.example.name
  resource_group_name = azurerm_resource_group.example.name
  partition_count     = 2
  message_retention   = 1

  capture_description {
    enabled             = true
    encoding            = "Avro"
    interval_in_seconds = 60
    size_limit_in_bytes = 104857600 # 100 MB
    skip_empty_archives = true
    destination {
      name                = "EventHubArchive.AzureBlockBlob"
      archive_name_format = "{Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}"
      blob_container_name = "example"
      storage_account_id  = azurerm_storage_account.example.id
    }
  }
}

resource "azurerm_storage_account" "example" {
  account_replication_type = "LRS"
  account_tier             = "Standard"
  location                 = "West Europe"
  name                     = "stexamplecapturingdev"
  resource_group_name      = azurerm_resource_group.example.name
}

Debug Output/Panic Output

first apply

azurerm_resource_group.example: Refreshing state... [id=/subscriptions/xxxx/resourceGroups/rg-evh-capturing-test-dev]
azurerm_eventhub_namespace.example: Refreshing state... [id=/subscriptions/xxxx/resourceGroups/rg-evh-capturing-test-dev/providers/Microsoft.EventHub/namespaces/evhns-capturin
g-test-dev]
azurerm_storage_account.example: Refreshing state... [id=/subscriptions/xxxx/resourceGroups/rg-evh-capturing-test-dev/providers/Microsoft.Storage/storageAccounts/stexamplecapt
uringdev]
azurerm_eventhub.example: Refreshing state... [id=/subscriptions/xxxx/resourceGroups/rg-evh-capturing-test-dev/providers/Microsoft.EventHub/namespaces/evhns-capturing-test-dev
/eventhubs/caputuring]

Terraform used the selected providers to generate the following execution plan. Resource actions are indicated with the following symbols:
~ update in-place

Terraform will perform the following actions:

# azurerm_eventhub.example will be updated in-place
~ resource "azurerm_eventhub" "example" {
id                  = "/subscriptions/xxxx/resourceGroups/rg-evh-capturing-test-dev/providers/Microsoft.EventHub/namespaces/evhns-capturing-test-dev/eventhubs/caputuri
ng"
~ message_retention   = 1 -> 7
name                = "caputuring"
# (5 unchanged attributes hidden)

        # (1 unchanged block hidden)
    }

Plan: 0 to add, 1 to change, 0 to destroy.

second apply

azurerm_resource_group.example: Refreshing state... [id=/subscriptions/xxxx/resourceGroups/rg-evh-capturing-test-dev]
azurerm_eventhub_namespace.example: Refreshing state... [id=/subscriptions/xxxx/resourceGroups/rg-evh-capturing-test-dev/providers/Microsoft.EventHub/namespaces/evhns-capturin
g-test-dev]
azurerm_storage_account.example: Refreshing state... [id=/subscriptions/xxxx/resourceGroups/rg-evh-capturing-test-dev/providers/Microsoft.Storage/storageAccounts/stexamplecapt
uringdev]
azurerm_eventhub.example: Refreshing state... [id=/subscriptions/xxxx/resourceGroups/rg-evh-capturing-test-dev/providers/Microsoft.EventHub/namespaces/evhns-capturing-test-dev
/eventhubs/caputuring]

Terraform used the selected providers to generate the following execution plan. Resource actions are indicated with the following symbols:
  ~ update in-place

Terraform will perform the following actions:

  # azurerm_eventhub.example will be updated in-place
  ~ resource "azurerm_eventhub" "example" {
        id                  = "/subscriptions/xxxx/resourceGroups/rg-evh-capturing-test-dev/providers/Microsoft.EventHub/namespaces/evhns-capturing-test-dev/eventhubs/caputuri
ng"
        name                = "caputuring"
        # (6 unchanged attributes hidden)

      + capture_description {
          + enabled             = true
          + encoding            = "Avro"
          + interval_in_seconds = 60
          + size_limit_in_bytes = 104857600
          + skip_empty_archives = true

          + destination {
              + archive_name_format = "{Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}"
              + blob_container_name = "example"
              + name                = "EventHubArchive.AzureBlockBlob"
              + storage_account_id  = "/subscriptions/xxxx/resourceGroups/rg-evh-capturing-test-dev/providers/Microsoft.Storage/storageAccounts/stexamplecapturingdev"
            }
        }
    }

Plan: 0 to add, 1 to change, 0 to destroy.

Expected Behaviour

Changing the message retention period keeps the "capture_description" block.

Actual Behaviour

1. First TF apply creates the resources accordingly to the config
2. Changing the message retention and applying again removes the "caputre_description" blog without show this change in the execution plan
3. Second TF apply creates the "capture_description" again

Steps to Reproduce

1. terraform apply
2. Change message_retention from 1 to 7
3. terraform apply

Important Factoids

No response

References

No response

[xiaxyi]

Thanks @hitty5 for raising this issue, you may refer to pr #19836 for the fix.

Feel free to let me know if you have any questions or concerns.

[github-actions]

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 have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.