Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

azurerm_virtual_network_gateway - update the resource with existing Nat Rules #25690

Merged
merged 5 commits into from
Apr 25, 2024

Conversation

neil-yechenwei
Copy link
Contributor

@neil-yechenwei neil-yechenwei commented Apr 22, 2024

Community Note

  • Please vote on this PR by adding a 👍 reaction to the original PR to help the community and maintainers prioritize for review
  • Please do not leave "+1" or "me too" comments, they generate extra noise for PR followers and do not help prioritize for review

Description

Currently, azurerm_virtual_network_gateway would always delete the nat rules of Virtual Network Gateway when updating any property of Virtual Network Gateway. Because the nat rules of Virtual Network Gateway is managed by azurerm_virtual_network_gateway_nat_rule and azurerm_virtual_network_gateway doesn't handle the nat rule in the update operation so that azurerm_virtual_network_gateway would always delete the nat rules.

The test cases in below latest test result are also failed with same error in Teamcity Daily run. So they're not related with this PR.
image

PR Checklist

  • I have followed the guidelines in our Contributing Documentation.
  • I have checked to ensure there aren't other open Pull Requests for the same update/change.
  • I have checked if my changes close any open issues. If so please include appropriate closing keywords below.
  • I have updated/added Documentation as required written in a helpful and kind way to assist users that may be unfamiliar with the resource / data source.
  • I have used a meaningful PR title to help maintainers and other users understand this change and help prevent duplicate work.
    For example: “resource_name_here - description of change e.g. adding property new_property_name_here

Changes to existing Resource / Data Source

  • I have added an explanation of what my changes do and why I'd like you to include them (This may be covered by linking to an issue above, but may benefit from additional explanation).
  • I have written new tests for my resource or datasource changes & updated any relevent documentation.
  • I have successfully run tests with my changes locally. If not, please provide details on testing challenges that prevented you running the tests.
  • (For changes that include a state migration only). I have manually tested the migration path between relevant versions of the provider.

Testing

  • My submission includes Test coverage as described in the Contribution Guide and the tests pass. (if this is not possible for any reason, please include details of why you did or could not add test coverage)

Change Log

Below please provide what should go into the changelog (if anything) conforming to the Changelog Format documented here.

  • azurerm_virtual_network_gateway - update the resource with existing Nat Rules

This is a (please select all that apply):

  • Bug Fix
  • New Feature (ie adding a service, resource, or data source)
  • Enhancement
  • Breaking Change

Related Issue(s)

Fixes #25683

Note

If this PR changes meaningfully during the course of review please update the title and description as required.

@neil-yechenwei neil-yechenwei marked this pull request as draft April 22, 2024 07:13
@neil-yechenwei neil-yechenwei marked this pull request as ready for review April 22, 2024 09:09
@neil-yechenwei neil-yechenwei marked this pull request as draft April 22, 2024 09:41
@github-actions github-actions bot added size/L and removed size/M labels Apr 22, 2024
@neil-yechenwei neil-yechenwei marked this pull request as ready for review April 22, 2024 14:24
@neil-yechenwei neil-yechenwei marked this pull request as draft April 22, 2024 14:26
@github-actions github-actions bot added size/M and removed size/L labels Apr 22, 2024
@neil-yechenwei neil-yechenwei marked this pull request as ready for review April 22, 2024 23:22
Copy link
Member

@jackofallops jackofallops left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @neil-yechenwei - Thanks for this PR. It looks OK in principal, but since the resource uses a combined CreateUpdate the code will fail to check the err as it stands. Can you take a look at reworking this to ensure that error handling for the Get is performed for both call types?

Thanks!

@@ -657,8 +657,8 @@ func resourceVirtualNetworkGatewayCreateUpdate(d *pluginsdk.ResourceData, meta i

id := parse.NewVirtualNetworkGatewayID(subscriptionId, d.Get("resource_group_name").(string), d.Get("name").(string))

existing, err := client.Get(ctx, id.ResourceGroup, id.Name)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will not handle the value for err in the update case, can you take a look at implementing differently to make sure error checking is done in both cases?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated

@neil-yechenwei
Copy link
Contributor Author

@jackofallops , thanks for the comments. I updated PR. Please take another look. The test cases in below latest test result that I just now re-triggered are also failed with same error in Teamcity Daily run. So they're not related with this PR.

image

Copy link
Member

@jackofallops jackofallops left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @neil-yechenwei - Thanks for the changes, this LGTM now 👍

@jackofallops jackofallops merged commit 6caeb23 into hashicorp:main Apr 25, 2024
31 checks passed
@github-actions github-actions bot added this to the v3.101.0 milestone Apr 25, 2024
jackofallops added a commit that referenced this pull request Apr 25, 2024
dduportal referenced this pull request in jenkins-infra/azure Apr 26, 2024
<Actions>
<action
id="f410411e63aff4bb73a81c2aec1d373cf8a903e63b30dee2006b0030d8a94cc8">
        <h3>Bump Terraform `azurerm` provider version</h3>
<details
id="1d9343c012f5434ac9fe8a98135bae3667b399259be16d9b14302ea3bd424a24">
            <summary>Update Terraform lock file</summary>
<p>changes detected:&#xA;&#x9;&#34;hashicorp/azurerm&#34; updated from
&#34;3.100.0&#34; to &#34;3.101.0&#34; in file
&#34;.terraform.lock.hcl&#34;</p>
            <details>
                <summary>3.101.0</summary>
<pre>Changelog retrieved
from:&#xA;&#x9;https://github.com/hashicorp/terraform-provider-azurerm/releases/tag/v3.101.0&#xA;ENHANCEMENTS:&#xA;&#xA;*
dependencies: updating to `v0.20240424.1114424` of
`github.com/hashicorp/go-azure-sdk`
([#25749](hashicorp/terraform-provider-azurerm#25749
dependencies: updating to `v0.27.0` of
`github.com/tombuildsstuff/giovanni`
([#25702](hashicorp/terraform-provider-azurerm#25702
dependencies: updating `golang.org/x/net` to `0.23.0`&#xA;*
`azurerm_cognitive_account` - the `kind` property now supports
`ConversationalLanguageUnderstanding`
([#25735](hashicorp/terraform-provider-azurerm#25735
`azurerm_container_app_custom_domain` - support the ability to use Azure
Managed Certificates
([#25356](https://github.com/hashicorp/terraform-provider-azurerm/issues/25356))&#xA;&#xA;BUG
FIXES:&#xA;&#xA;* Data Source: `azurerm_application_insights` - set
correct AppID in data source
([#25687](hashicorp/terraform-provider-azurerm#25687
`azurerm_virtual_network` - suppress diff in ordering for
`address_space` due to inconsistent API response
([#23793](hashicorp/terraform-provider-azurerm#23793
`azurerm_storage_data_lake_gen2_filesystem` - add context deadline for
import
([#25712](hashicorp/terraform-provider-azurerm#25712
`azurerm_virtual_network_gateway` - preserve existing `nat_rules` on
updates
([#25690](https://github.com/hashicorp/terraform-provider-azurerm/issues/25690))&#xA;&#xA;&#xA;</pre>
            </details>
        </details>
<a
href="https://infra.ci.jenkins.io/job/updatecli/job/azure/job/main/135/">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]>
Copy link

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.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 26, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update on virtualNetworkGateways fails when azurerm_virtual_network_gateway_nat_rule is in use
2 participants