`azurerm_api_management_api` - change `id` format so specific `revision`s can be managed by Terraform #23031

mbfrahry · 2023-08-21T22:36:11Z

Supersedes #22380

This is taking the existing work that was done by @kevjallen and smoothing out some of the edge cases around the azurerm_api_management_api and azurerm_api_management_api_release resources.

Unfortunately, this resource is broken around revisions without a good path forward to fix existing issues. To fix issues around revision will require manual work by importing the revision in with the new id format

…erm-apim-revisions into nexient-llc-main

…wrong revision

…ay we are using revisions

stephybun

Thanks @mbfrahry, minor comment otherwise LGTM 🌭

internal/services/apimanagement/migration/api_v0_to_v1.go

Co-authored-by: stephybun <[email protected]>

stephybun · 2023-08-24T13:30:12Z

@mbfrahry @katbyte - had an internal discussion and this should not be merged yet.

internal discussion - we have concerns about the semicolon in the ID

celsocoutinho-tangany · 2023-11-20T11:41:16Z

Are there any plans to merge this PR?

tombuildsstuff

LGTM 👍

<Actions> <action id="f410411e63aff4bb73a81c2aec1d373cf8a903e63b30dee2006b0030d8a94cc8"> <h3>Bump Terraform `azurerm` provider version</h3> <details id="1d9343c012f5434ac9fe8a98135bae3667b399259be16d9b14302ea3bd424a24"> <summary>Update Terraform lock file</summary> <p>changes detected:
	"hashicorp/azurerm" updated from "3.88.0" to "3.89.0" in file ".terraform.lock.hcl"</p> <details> <summary>3.89.0</summary> <pre>Changelog retrieved from:
	https://github.com/hashicorp/terraform-provider-azurerm/releases/tag/v3.89.0
FEATURES:

* New Data Source: `azurerm_data_factory_trigger_schedule` ([#24572](hashicorp/terraform-provider-azurerm#24572 New Data Source: `azurerm_data_factory_trigger_schedules` ([#24572](hashicorp/terraform-provider-azurerm#24572 New Data Source: `azurerm_ip_groups` ([#24540](hashicorp/terraform-provider-azurerm#24540 New Data Source: `azurerm_nginx_certificate` ([#24577](hashicorp/terraform-provider-azurerm#24577 New Resource: `azurerm_chaos_studio_target` ([#24580](hashicorp/terraform-provider-azurerm#24580 New Resource: `azurerm_elastic_san_volume_group` ([#24166](hashicorp/terraform-provider-azurerm#24166 New Resource: `azurerm_netapp_account_encryption` ([#23733](hashicorp/terraform-provider-azurerm#23733 New Resource: `azurerm_redhat_openshift_cluster` ([#24375](https://github.com/hashicorp/terraform-provider-azurerm/issues/24375))

ENHANCEMENTS:

* dependencies: updating to `v0.66.1` of `github.com/hashicorp/go-azure-helpers` ([#24561](hashicorp/terraform-provider-azurerm#24561 dependencies: updating to `v0.20240124.1115501` of `github.com/hashicorp/go-azure-sdk` ([#24619](hashicorp/terraform-provider-azurerm#24619 `bot`: updating to API Version `2021-05-01-preview` ([#24555](hashicorp/terraform-provider-azurerm#24555 `containerservice`: the SDK Clients now support logging ([#24564](hashicorp/terraform-provider-azurerm#24564 `cosmosdb`: updating to API Version `2023-04-15` ([#24541](hashicorp/terraform-provider-azurerm#24541 `loadtestservice`: updating to use the base layer from `hashicorp/go-azure-sdk` rather than `Azure/go-autorest` (and support logging) ([#24578](hashicorp/terraform-provider-azurerm#24578 `managedidentity`: updating to use the base layer from `hashicorp/go-azure-sdk` rather than `Azure/go-autorest` (and support logging) ([#24578](hashicorp/terraform-provider-azurerm#24578 `azurerm_api_management_api` - change the `id` format so specific `revision`s can be managed by Terraform ([#23031](hashicorp/terraform-provider-azurerm#23031 `azurerm_data_protection_backup_vault` - the `redundancy` propety can now be set to `ZoneRedundant` ([#24556](hashicorp/terraform-provider-azurerm#24556 `azurerm_data_factory_integration_runtime_azure_ssis` - support for the `credential_name` property ([#24458](hashicorp/terraform-provider-azurerm#24458 `azurerm_orchestrated_virtual_machine_scale_set` - support `2022-datacenter-azure-edition-hotpatch` and `2022-datacenter-azure-edition-hotpatch-smalldisk` hotpatching images ([#23500](hashicorp/terraform-provider-azurerm#23500 `azurerm_stream_analytics_job` - support for the `sku_name` property ([#24554](https://github.com/hashicorp/terraform-provider-azurerm/issues/24554))

BUG FIXES:

* Data Source: `azurerm_app_service` - parsing the API Response for `app_service_plan_id` case-insensitively ([#24626](hashicorp/terraform-provider-azurerm#24626 Data Source: `azurerm_function_app` - parsing the API Response for `app_service_plan_id` case-insensitively ([#24626](hashicorp/terraform-provider-azurerm#24626 `azurerm_app_configuration_key` - the value for the `value` property can now be removed/emptied ([#24582](https://github.com/hashicorp/terraform-provider-azurerm/issues/24582))

* `azurerm_app_service` - parsing the API Response for `app_service_plan_id` case-insensitively ([#24626](hashicorp/terraform-provider-azurerm#24626 `azurerm_app_service_plan` - fix casing in `serverFarms` due to ID update ([#24562](hashicorp/terraform-provider-azurerm#24562 `azurerm_app_service_slot` - parsing the API Response for `app_service_plan_id` case-insensitively ([#24626](hashicorp/terraform-provider-azurerm#24626 `azurerm_automation_schedule` - only one `monthly_occurence` block can now be specified ([#24614](hashicorp/terraform-provider-azurerm#24614 `azurerm_cognitive_deployment` - the `model.version` property is no longer required ([#24264](hashicorp/terraform-provider-azurerm#24264 `azurerm_container_app` - multiple `custom_scale_rule` can not be updated ([#24509](hashicorp/terraform-provider-azurerm#24509 `azurerm_container_registry_task_schedule_run_now` - prevent issue where the incorrect scheduled run in tracked if there have been multiple ([#24592](hashicorp/terraform-provider-azurerm#24592 `azurerm_function_app` - parsing the API Response for `app_service_plan_id` case-insensitively ([#24626](hashicorp/terraform-provider-azurerm#24626 `azurerm_function_app_slot` - parsing the API Response for `app_service_plan_id` case-insensitively ([#24626](hashicorp/terraform-provider-azurerm#24626 `azurerm_logic_app_standard` - now will parse the app service ID insensitively ([#24562](hashicorp/terraform-provider-azurerm#24562 `azurerm_logic_app_workflow` - the `workflow_parameters` will now correctly handle information specified by `$connections` ([#24141](hashicorp/terraform-provider-azurerm#24141 `azurerm_mssql_managed_instance_security_alert_policy` - can not update empty storage attributes ([#24553](hashicorp/terraform-provider-azurerm#24553 `azurerm_network_interface` - the `ip_configuration` properties are no longer added to a Load Balancer Backend if one of those `ip_configurations` is associated with a backend ([#24470](https://github.com/hashicorp/terraform-provider-azurerm/issues/24470))


</pre> </details> </details> <a href="https://infra.ci.jenkins.io/job/terraform-jobs/job/azure/job/main/1052/">Jenkins pipeline link</a> </action> </Actions> --- <table> <tr> <td width="77"> <img src="https://www.updatecli.io/images/updatecli.png" alt="Updatecli logo" width="50" height="50"> </td> <td> <p> Created automatically by <a href="https://www.updatecli.io/">Updatecli</a> </p> <details><summary>Options:</summary> <br /> <p>Most of Updatecli configuration is done via <a href="https://www.updatecli.io/docs/prologue/quick-start/">its manifest(s)</a>.</p> <ul> <li>If you close this pull request, Updatecli will automatically reopen it, the next time it runs.</li> <li>If you close this pull request and delete the base branch, Updatecli will automatically recreate it, erasing all previous commits made.</li> </ul> <p> Feel free to report any issues at <a href="https://github.com/updatecli/updatecli/issues">github.com/updatecli/updatecli</a>.<br /> If you find this tool useful, do not hesitate to star <a href="https://github.com/updatecli/updatecli/stargazers">our GitHub repository</a> as a sign of appreciation, and/or to tell us directly on our <a href="https://matrix.to/#/#Updatecli_community:gitter.im">chat</a>! </p> </details> </td> </tr> </table> Co-authored-by: Jenkins Infra Bot (updatecli) <[email protected]> Co-authored-by: Damien Duportal <[email protected]>

celsocoutinho-tangany · 2024-01-30T15:36:19Z

Can someone provide a working configuration on how to create new revisions on existing APIM APIs? It is not working for me... Perhaps @mbfrahry @tombuildsstuff @rcskosir @stephybun ?

Andrei-Predoiu · 2024-03-13T18:00:50Z

Has anyone come across this bug?
terraform wants to recreate all my azurerm_api_management_gateway_api every time i run terraform apply
#25239

github-actions · 2024-04-18T02:07:12Z

I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active contributions.
If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

kevjallen-nexient and others added 13 commits June 30, 2023 09:47

add existing fix

85e48e9

add fix for updating revision without version

8c2cdd6

add state migration

7fd50a3

use fmt to update id

7f42b2b

remove unnecessary property

ba41f45

make migration point-in-time, remove fields

ac5ffd3

remove comment

e903e4e

Merge remote-tracking branch 'upstream/main'

ffa866a

Merge branch 'main' of github.com:nexient-llc/terraform-provider-azur…

442bcf1

…erm-apim-revisions into nexient-llc-main

Remove creating a new id based off only the name as it's getting the …

40178ca

…wrong revision

remove delete revisions option as it isn't working with the current w…

79d0eaa

…ay we are using revisions

don't remove revision from apiId for releases

13d09c2

Fix docs

bbcaa2a

github-actions bot added documentation service/api-management size/XL labels Aug 21, 2023

stephybun previously approved these changes Aug 22, 2023

View reviewed changes

internal/services/apimanagement/migration/api_v0_to_v1.go Outdated Show resolved Hide resolved

Update internal/services/apimanagement/migration/api_v0_to_v1.go

f31f568

Co-authored-by: stephybun <[email protected]>

stephybun assigned tombuildsstuff Aug 24, 2023

stephybun mentioned this pull request Sep 5, 2023

fix error when adding revisions to existing APIs #22380

Closed

This comment was marked as off-topic.

Sign in to view

tombuildsstuff approved these changes Dec 7, 2023

View reviewed changes

tombuildsstuff added this to the v3.85.0 milestone Dec 7, 2023

stephybun added enhancement state-migration labels Dec 11, 2023

tombuildsstuff modified the milestones: v3.85.0, v3.86.0 Dec 14, 2023

tombuildsstuff approved these changes Jan 10, 2024

View reviewed changes

tombuildsstuff modified the milestones: v3.86.0, v3.88.0 Jan 10, 2024

rcskosir mentioned this pull request Jan 18, 2024

API Management - Cannot add a revision to an existing API #12720

Closed

rcskosir linked an issue Jan 18, 2024 that may be closed by this pull request

API Management - Cannot add a revision to an existing API #12720

Closed

rcskosir mentioned this pull request Jan 18, 2024

creating an APIM revision results in error message Can't change property ApiVersion for non-current revision #18093

Closed

1 task

rcskosir linked an issue Jan 18, 2024 that may be closed by this pull request

creating an APIM revision results in error message Can't change property ApiVersion for non-current revision #18093

Closed

1 task

mbfrahry merged commit d16fbb1 into main Jan 19, 2024
24 checks passed

mbfrahry deleted the nexient-llc-main branch January 19, 2024 19:54

mbfrahry added a commit that referenced this pull request Jan 19, 2024

Update CHANGELOG.md for #23031

4ba5f59

STaegtmeier mentioned this pull request Jan 31, 2024

azurerm_api_management_subscription creates invalid key when api_id is set using azurerm_api_management_api data source #23399

Open

1 task

alexwiese mentioned this pull request Feb 6, 2024

terraform always wants to recreate azurerm_api_management_api_tag #24705

Closed

1 task

This was referenced Mar 3, 2024

Breaking change introduced on azurerm_api_management_subscription in v3.89.0 related to azurerm_api_management_api #25020

Open

azurerm_api_management_api_operation_tag creates / overwrites tag instead of just attaching #25098

Open

alexwiese mentioned this pull request Mar 12, 2024

Don't remove the revison suffix from the api_id of the API tag #25168

Merged

github-actions bot locked as resolved and limited conversation to collaborators Apr 18, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

`azurerm_api_management_api` - change `id` format so specific `revision`s can be managed by Terraform #23031

`azurerm_api_management_api` - change `id` format so specific `revision`s can be managed by Terraform #23031

mbfrahry commented Aug 21, 2023

stephybun left a comment •

edited

Loading

stephybun commented Aug 24, 2023

This comment was marked as off-topic.

celsocoutinho-tangany commented Nov 20, 2023

tombuildsstuff left a comment

celsocoutinho-tangany commented Jan 30, 2024 •

edited

Loading

Andrei-Predoiu commented Mar 13, 2024 •

edited

Loading

github-actions bot commented Apr 18, 2024

azurerm_api_management_api - change id format so specific revisions can be managed by Terraform #23031

azurerm_api_management_api - change id format so specific revisions can be managed by Terraform #23031

Conversation

mbfrahry commented Aug 21, 2023

stephybun left a comment • edited Loading

Choose a reason for hiding this comment

stephybun commented Aug 24, 2023

This comment was marked as off-topic.

celsocoutinho-tangany commented Nov 20, 2023

tombuildsstuff left a comment

Choose a reason for hiding this comment

celsocoutinho-tangany commented Jan 30, 2024 • edited Loading

Andrei-Predoiu commented Mar 13, 2024 • edited Loading

github-actions bot commented Apr 18, 2024

`azurerm_api_management_api` - change `id` format so specific `revision`s can be managed by Terraform #23031

`azurerm_api_management_api` - change `id` format so specific `revision`s can be managed by Terraform #23031

stephybun left a comment •

edited

Loading

celsocoutinho-tangany commented Jan 30, 2024 •

edited

Loading

Andrei-Predoiu commented Mar 13, 2024 •

edited

Loading