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_eventhub_namespace_customer_managed_key - parsing UAI ID fetched from the parent eventhub namespace #25809

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

xiaxyi
Copy link
Contributor

@xiaxyi xiaxyi commented Apr 30, 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

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)

image

Change Log

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

  • azurerm_eventhub_namespace_customer_managed_key - parsing UAI resource ID that's returned by the api.

The resourceGroups staticSegment of the UAI ID was changed to resourcegroups by the api, which caused the mismatch of the same uai that's assigned to the parent eventhub namespace and the uai assigned to the eventhub cmk,

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

Note

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

@Scarlettliuyc
Copy link

Scarlettliuyc commented May 6, 2024

Thanks @xiaxyi . could you please @ reviewer here to pass this updates

if err != nil {
return fmt.Errorf("parsing %q as a User Assigned Identity ID: %+v", item, err)
}
if parentEhnUaiId.ID() == userAssignedIdentity {
Copy link
Member

Choose a reason for hiding this comment

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

Rather than comparing these two IDs by checking the results of .ID() match - can we compare the Resource ID values instead:

Suggested change
if parentEhnUaiId.ID() == userAssignedIdentity {
if resourceids.Match(parentEhnUaiId, userAssignedIdentity) {

The Match function is available in hashicorp/go-azure-helpers#234 fwiw

Copy link
Member

Choose a reason for hiding this comment

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

@tombuildsstuff tombuildsstuff added the upstream/go-azure-helpers This issue/PR has a dependency on an issue/PR in `hashicorp/go-azure-helpers` label May 6, 2024
@xiaxyi
Copy link
Contributor Author

xiaxyi commented May 7, 2024

Thanks @tombuildsstuff for the comment, the userAssignedIdentity in the right side of the equation is a sting that's got by userAssignedIdentity := d.Get("user_assigned_identity_id").(string). We didn't parse the id as there is a validation function in schema to validate the user's input of the user_assigned_identity_id

"user_assigned_identity_id": {
				Type:         pluginsdk.TypeString,
				Optional:     true,
				ValidateFunc: commonids.ValidateUserAssignedIdentityID,
			},

Do we need to parse the user_assigned_identity_id in order to do the resourceids.Match()?

@tombuildsstuff
Copy link
Member

@xiaxyi

Do we need to parse the user_assigned_identity_id in order to do the resourceids.Match()?

Yes, intentionally. By comparing the Resource ID types rather than the literal string value, we can do context-aware comparisons (since we know what each of the Resource ID Segments are, we can compare the IDs with that context - which will help in the future with the some of the casing related items).

@xiaxyi
Copy link
Contributor Author

xiaxyi commented May 13, 2024

Thanks @tombuildsstuff , code is updated, would you mind taking a look and let me know if everything is cool?

@Scarlettliuyc
Copy link

Hi @tombuildsstuff good day, as we have customers are waiting for this fix to update, could please review an approve it ASAP. Thanks in advanced.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
service/event-hubs EventHubs size/XS upstream/go-azure-helpers This issue/PR has a dependency on an issue/PR in `hashicorp/go-azure-helpers`
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants