Resource Identity - ensure RI data is set on Create

[sreallymatt]

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

Ensures Resource Identity data is set on Create (right after setting the id attribute), preventing "Missing Resource Identity After Create" errors in the event the Terraform run errors out before reaching the SetResourceIdentityData call in the Read function.

Note: for framework, we should consider reworking the resource identity helpers to set id and identity data in a single function call

To easily confirm the behaviour, simply return an error right after the d.SetId or metadata.SetID call, observe the error output of:

azurerm_network_interface.test: Still creating... [00m10s elapsed]
╷
│ Error: force an error
│
│   with azurerm_network_interface.test,
│   on main.tf line 61, in resource "azurerm_network_interface" "test":
│   61: resource "azurerm_network_interface" "test" {
│
╵
╷
│ Error: Missing Resource Identity After Create: The Terraform provider unexpectedly returned no resource identity after having no errors in the resource create. This is always a problem with the provider and should be reported to the provider developer
│
│   with azurerm_network_interface.test,
│   on main.tf line 61, in resource "azurerm_network_interface" "test":
│   61: resource "azurerm_network_interface" "test" {

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)

note: TestAccNetworkProfile_resourceIdentity failed due to resources being left in the resource group, unrelated to these changes

note: TestAccPrivateDnsZone_resourceIdentity failed due to resources being left in the resource group, unrelated to these changes

Change Log

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

• azurerm_resource - support for the thing1 property [GH-00000]

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 #31155
Fixes #31200

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.

[github-actions]

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.