New Resource: `azurerm_nat_gateway_public_ip_prefix_v6_association` by neil-yechenwei · Pull Request #31325 · hashicorp/terraform-provider-azurerm

neil-yechenwei · 2025-12-09T06:29:04Z

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 comments along the lines of "+1", "me too" or "any updates", they generate extra noise for PR followers and do not help prioritize for review

Description

This PR is to support new association resource azurerm_nat_gateway_public_ip_prefix_v6_association for new feature publicIpPrefixesV6. This PR depends on #31197. Once PR 31197 is merged, please don't merge this PR since I will rebase the code.

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 relevant 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)

--- PASS: TestAccNatGatewayPublicIpPrefixV6Association_requiresImport (192.23s)
--- PASS: TestAccNatGatewayPublicIpPrefixV6Association_basic (145.13s)

Change Log

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

New Resource: azurerm_nat_gateway_public_ip_prefix_v6_association

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 # 0000

AI Assistance Disclosure

AI Assisted - This contribution was made by, or with the assistance of, AI/LLMs

Rollback Plan

If a change needs to be reverted, we will publish an updated version of the provider.

Changes to Security Controls

Are there any changes to security controls (access controls, encryption, logging) in this pull request? If so, explain.

Note

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

…ort for new SKU StandardV2

teowa · 2025-12-11T00:51:15Z

Thanks @neil-yechenwei , LGTM!

ms-henglu · 2025-12-11T04:44:25Z

+				if props := model.Properties; props != nil {
+					publicIpPrefixesV6 := make([]natgateways.SubResource, 0)
+
+					if publicIPPrefixesV6 := props.PublicIPPrefixesV6; publicIPPrefixesV6 != nil {


publicIPPrefixesV6 is re-assigned here in the if-condition.

ms-henglu · 2025-12-11T04:44:45Z

+				if props := model.Properties; props != nil {
+					publicIpPrefixesV6 := make([]natgateways.SubResource, 0)
+
+					if publicIPPrefixesV6 := props.PublicIPPrefixesV6; publicIPPrefixesV6 != nil {


Same as above.

ms-henglu · 2025-12-11T04:45:11Z

+
+type NatGatewayPublicIpPrefixV6AssociationResource struct{}
+
+func TestAccNatGatewayPublicIpPrefixV6Association_basic(t *testing.T) {


Add a test to verify multiple associations

neil-yechenwei · 2025-12-11T05:27:53Z

@ms-henglu , thanks for the comments. I updated PR. Please take another look. Below is the latest test result.

--- PASS: TestAccNatGatewayPublicIpPrefixV6Association_multipleAssociations (229.01s)
--- PASS: TestAccNatGatewayPublicIpPrefixV6Association_requiresImport (187.13s)
--- PASS: TestAccNatGatewayPublicIpPrefixV6Association_basic (156.21s)

…m into natgatewaypublicipv6prefixassociation

ms-zhenhua · 2026-04-08T06:45:53Z

+			natGateway.Model.Properties.PublicIPPrefixesV6 = pointer.To(publicIpPrefixesV6)
+
+			if err := client.CreateOrUpdateThenPoll(ctx, *id.First, *natGateway.Model); err != nil {
+				return fmt.Errorf("removing association between %s and %s: %+v", *id.First, *id.Second, err)


Suggested change

return fmt.Errorf("removing association between %s and %s: %+v", *id.First, *id.Second, err)

return fmt.Errorf("deleting %s: %+v", id, err)

ms-zhenhua · 2026-04-08T06:46:51Z

+
+			var state NATGatewayPublicIpPrefixV6AssociationModel
+			if err := metadata.Decode(&state); err != nil {
+				return err


Suggested change

return err

return fmt.Errorf("decoding: %+v", err)

ms-zhenhua · 2026-04-08T06:47:36Z

+A NAT Gateway and IPv6 Public IP Prefix association can be imported using the `resource id`, e.g.
+
+```shell
+terraform import azurerm_nat_gateway_public_ip_prefix_v6_association.example "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup1/providers/Microsoft.Network/natGateways/natGateway1|/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup1/providers/Microsoft.Network/publicIPPrefixes/publicIPPrefix1"


Suggested change

terraform import azurerm_nat_gateway_public_ip_prefix_v6_association.example "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup1/providers/Microsoft.Network/natGateways/natGateway1|/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup1/providers/Microsoft.Network/publicIPPrefixes/publicIPPrefix1"

terraform import azurerm_nat_gateway_public_ip_prefix_v6_association.example "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Network/natGateways/gateway1|/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Network/publicIPPrefixes/prefix1"

ms-zhenhua · 2026-04-08T06:48:15Z

+
+In addition to the Arguments listed above - the following Attributes are exported:
+
+* `id` - The (Terraform specific) ID of the Association between the NAT Gateway and the IPv6 Public IP Prefix.


Suggested change

* `id` - The (Terraform specific) ID of the Association between the NAT Gateway and the IPv6 Public IP Prefix.

* `id` - The ID of the Association between the NAT Gateway and the IPv6 Public IP Prefix.

ms-zhenhua · 2026-04-08T06:48:49Z

+			natGateway.Model.Properties.PublicIPPrefixesV6 = pointer.To(publicIpPrefixesV6)
+
+			if err := client.CreateOrUpdateThenPoll(ctx, *natGatewayId, *natGateway.Model); err != nil {
+				return fmt.Errorf("updating %s: %+v", *natGatewayId, err)


Suggested change

return fmt.Errorf("updating %s: %+v", *natGatewayId, err)

return fmt.Errorf("creating %s: %+v", id, err)

teowa · 2026-04-08T07:26:19Z

Hi @ms-zhenhua , thanks for reviewing! I have updated the code, please take another look.

ms-zhenhua

LGTM~

teowa · 2026-04-08T23:39:00Z

wuxu92

Thanks for the updates on this PR! could you please have a look and update it to align with comment in #31321 (review) as these two PRs are very similar.

teowa · 2026-04-09T05:52:03Z

Hi @wuxu92 , thanks for reviewing. I have updated the code, please take another look.

wuxu92

Thanks @teowa The resource looks good now. could you please add the identity support for the new resource with guidance: ./contributing/topics/guide-resource-identity.md . also add identity support for the ipv6 association resource. Thanks!

teowa · 2026-04-09T08:38:14Z

Hi @wuxu92 , ResourceWithIdentity is not implemented here because this resource uses a composite Terraform ID:

terraform-provider-azurerm/vendor/github.com/hashicorp/go-azure-helpers/resourcemanager/commonids/composite_resource_id.go

Lines 14 to 22 in 6f5f895

    
           type CompositeResourceID[T1 resourceids.ResourceId, T2 resourceids.ResourceId] struct { 
        
           	// First specifies the first component of this Resource ID. 
        
           	// This is in the format `{first}|{second}`. 
        
           	First T1 
        
           	// Second specifies the second component of this Resource ID 
        
           	// This is in the format `{first}|{second}`. 
        
           	Second T2 
        
           }

The identity framework behind ResourceWithIdentity expects a single segment-based ARM-style ID built from Segments(), not a pipe-delimited composite ID.

terraform-provider-azurerm/internal/sdk/resource.go

Lines 112 to 117 in 6f5f895

    
           type ResourceWithIdentity interface { 
        
           	Resource 
        
           	// Identity returns the resource's identity type 
        
           	Identity() resourceids.ResourceId 
        
           }

terraform-provider-azurerm/vendor/github.com/hashicorp/go-azure-helpers/resourcemanager/resourceids/interface.go

Lines 6 to 19 in 6f5f895

    
           type ResourceId interface { 
        
           	// FromParseResult populates the Resource ID using the ParseResult provided in `input` 
        
           	FromParseResult(input ParseResult) error 
        
           	// ID returns the fully formatted ID for this Resource ID 
        
           	ID() string 
        
           	// String returns a friendly description of the components of this Resource ID 
        
           	// which is suitable for use in error messages (for example 'MyThing %q / Resource Group %q') 
        
           	String() string 
        
           	// Segments returns an ordered list of expected Segments that make up this Resource ID 
        
           	Segments() []Segment 
        
           }

sreallymatt · 2026-04-13T18:03:18Z

Is being discussed internally with @wuxu92

sreallymatt · 2026-04-17T16:01:15Z

superseded by #32195

“neil-yechenwei” added 8 commits November 26, 2025 11:55

azurerm_nat_gateway/azurerm_public_ip/azurerm_public_ip_prefix - supp…

5e0cac4

…ort for new SKU StandardV2

update md file

8669186

update md

1ca4e10

update md file

c1dcf3c

Add CustomizeDiff Validtor for new sku StandardV2

e882770

update tc

9cd164f

Merge remote-tracking branch 'upstream/main' into networkskuv2

f5906bd

New Resource: azurerm_nat_gateway_public_ip_prefix_v6_association

edcadd3

neil-yechenwei requested review from a team, WodansSon and magodo as code owners December 9, 2025 06:29

neil-yechenwei marked this pull request as draft December 9, 2025 06:29

github-actions bot added documentation service/network size/XL labels Dec 9, 2025

update pointer

cccf269

ms-henglu suggested changes Dec 11, 2025

View reviewed changes

github-actions bot assigned ms-henglu Dec 11, 2025

github-actions bot added the waiting-response label Dec 11, 2025

update per comments

c7aab3f

github-actions bot removed the waiting-response label Dec 11, 2025

neil-yechenwei requested a review from ms-henglu December 11, 2025 05:27

merge latest change

25eb518

rcskosir added the new-resource label Mar 25, 2026

teowa added 4 commits March 30, 2026 07:18

Merge branch 'main' of github.com:hashicorp/terraform-provider-azurer…

2197008

…m into natgatewaypublicipv6prefixassociation

fix

b8740c6

fix doc

0cde3ad

remove wrong change

b69d9d5

ms-zhenhua suggested changes Apr 8, 2026

View reviewed changes

github-actions bot assigned ms-zhenhua Apr 8, 2026

github-actions bot added the waiting-response label Apr 8, 2026

fix

ab0cd16

github-actions bot added waiting-response and removed waiting-response labels Apr 8, 2026

teowa removed the waiting-response label Apr 8, 2026

ms-zhenhua approved these changes Apr 8, 2026

View reviewed changes

WodansSon marked this pull request as ready for review April 8, 2026 08:32

mybayern1974 unassigned ms-zhenhua and ms-henglu Apr 8, 2026

wuxu92 reviewed Apr 9, 2026

View reviewed changes

github-actions bot added the waiting-response label Apr 9, 2026

fix

d52575f

github-actions bot removed the waiting-response label Apr 9, 2026

teowa added 2 commits April 9, 2026 05:38

fix

31cc754

fix

fd47f86

wuxu92 reviewed Apr 9, 2026

View reviewed changes

github-actions bot added the waiting-response label Apr 9, 2026

teowa removed the waiting-response label Apr 9, 2026

sreallymatt added the waiting-response label Apr 13, 2026

mybayern1974 added the ready label Apr 16, 2026

teowa mentioned this pull request Apr 17, 2026

azurerm_nat_gateway_public_ip_prefix_association - support associating IPv6 Public IP Prefixes #32195

Merged

15 tasks

sreallymatt closed this Apr 17, 2026


		type NatGatewayPublicIpPrefixV6AssociationResource struct{}

		func TestAccNatGatewayPublicIpPrefixV6Association_basic(t *testing.T) {

	return fmt.Errorf("removing association between %s and %s: %+v", id.First, id.Second, err)
	return fmt.Errorf("deleting %s: %+v", id, err)

	terraform import azurerm_nat_gateway_public_ip_prefix_v6_association.example "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup1/providers/Microsoft.Network/natGateways/natGateway1\|/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup1/providers/Microsoft.Network/publicIPPrefixes/publicIPPrefix1"
	terraform import azurerm_nat_gateway_public_ip_prefix_v6_association.example "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Network/natGateways/gateway1\|/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Network/publicIPPrefixes/prefix1"


		In addition to the Arguments listed above - the following Attributes are exported:

		* `id` - The (Terraform specific) ID of the Association between the NAT Gateway and the IPv6 Public IP Prefix.

	* `id` - The (Terraform specific) ID of the Association between the NAT Gateway and the IPv6 Public IP Prefix.
	* `id` - The ID of the Association between the NAT Gateway and the IPv6 Public IP Prefix.

	return fmt.Errorf("updating %s: %+v", *natGatewayId, err)
	return fmt.Errorf("creating %s: %+v", id, err)

Conversation

neil-yechenwei commented Dec 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Community Note

Description

PR Checklist

Changes to existing Resource / Data Source

Testing

Change Log

Related Issue(s)

AI Assistance Disclosure

Rollback Plan

Changes to Security Controls

Uh oh!

teowa commented Dec 11, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

neil-yechenwei commented Dec 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

teowa commented Apr 8, 2026

Uh oh!

ms-zhenhua left a comment

Choose a reason for hiding this comment

Uh oh!

teowa commented Apr 8, 2026

Uh oh!

wuxu92 left a comment

Choose a reason for hiding this comment

Uh oh!

teowa commented Apr 9, 2026

Uh oh!

wuxu92 left a comment

Choose a reason for hiding this comment

Uh oh!

teowa commented Apr 9, 2026

Uh oh!

sreallymatt commented Apr 13, 2026

Uh oh!

sreallymatt commented Apr 17, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

10 participants

neil-yechenwei commented Dec 9, 2025 •

edited

Loading

neil-yechenwei commented Dec 11, 2025 •

edited

Loading