azurerm_api_management_custom_domain: resource gets updated every time

[AmudaPalani]

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

Affected Resource(s)

• azurerm_api_management_custom_domain

Terraform Configuration Files

Debug Output

Panic Output

Expected Behaviour

Since this resource already exists and no changes were requested, this should not be updated.

Actual Behaviour

resource gets updated every time.

Steps to Reproduce

1. terraform apply

Important Factoids

References

• #0000

[larsmaes]

👍

same issue here. This also reulst in downtime because the service gets restarted when this change gets applied

[larsmaes]

This also results in the removal of the custom domain in the first run; and when i run it again it get added again and so on..

[hgutvik]

I would also like to add a couple of things.

First, it's not very clear whether or not one should include the default proxy in the custom domains definition.
The example usage shown in Terraform azurerm_api_management_custom_domain docs only lists the custom domains.
The automated tests for azurerm_api_management_custom_domain list the default proxy along with the custom domains.
Perhaps clarify this in the docs, and align with tests?

Second, I'll add some additional info from our attempts, might help for debugging.
We tried both the approaches mentioned above, resulting in slightly different behavior:

(a) Defining only our custom domains

This approach performs the same updates on every apply after initial creation.

Definition - azurerm_api_management_custom_domain

• proxy (custom)
• developer_portal
• management

The initial create-deployment runs successfully and correctly.

Running terraform plan/apply (same code - no changes):

• Update azurerm_api_management - delete hostname_configuration (containing only the three custom domains):
  
• Update azurerm_api_management_custom_domain - replace default proxy with custom proxy
  

(b) Defining default proxy along with our custom domains

This approach performs almost the same update as above, except split in two steps, in consequent pairs of apply.
The slight difference is that the custom domains, when added back in, are not conflicting with the default proxy in Terraform, but added in addition to it.

Definition - azurerm_api_management_custom_domain

• proxy (custom)
• proxy (default)
• developer_portal
• management

Like above, the initial create-deployment runs successfully and correctly.

1st Running terraform plan/apply (same code - no changes):

• Update azurerm_api_management - delete hostname_configuration (containing only the three custom domains):
  

Result of apply: all custom domains deleted. The default proxy remains, and gets default_ssl_binding auto-toggled to true.

2nd Running terraform plan/apply (same code - no changes):

• Update azurerm_api_management_custom_domain - add custom domains alongside the default proxy, and toggle default_ssl_binding of default proxy correctly back to false
  

Result of apply: custom domains added back in, alongside the default proxy, which gets default_ssl_binding toggled correctly back to false

3rd Running terraform plan/apply (same code - no changes) [same as 1st]:

• Update azurerm_api_management - delete hostname_configuration (containing only the three custom domains):
  

And so it goes, 4th terraform plan / apply is identical to 1st one.

[maximivanov]

Getting same problem here.

A related Github issue where the need for the azurerm_api_management_custom_domain resource was originally raised: #3058

For those who can't wait till this bug is fixed:

There's also a workaround in the comments there with a custom domain configured via a call to an external script: #3058 (comment)

And a blog post by the same guy: https://www.jeanpaulsmit.com/2020/03/terraform-deploy-apim/#custom-domains

[kensykora]

The latest version of azurerm fixed this issue, thank you @patst!

[katbyte]

closing as it sounds like its fixed!

[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.