policy assignment - validate policy assignment name length

[ezhong-msft]

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

Docs were added previously but the validation wasn't being enforced
https://github.com/hashicorp/terraform-provider-azurerm/pull/21549/files

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).
• (n/a) 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)

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

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.

[sreallymatt]

Thanks @ezhong-msft, left one comment inline

[sreallymatt]

Quickly testing this, it seems the API does accept names of only 1 character like the other *_policy_assignment resources, so to avoid breaking existing configurations that may be using that we should change this to 1

Suggested change

	validation.StringLenBetween(3, 24),
	validation.StringLenBetween(1, 24),

E.g. this worked:

resource "azurerm_management_group_policy_assignment" "test" {
  name                 = "a"
  management_group_id  = azurerm_management_group.test.id
  policy_definition_id = data.azurerm_policy_definition.test.id
  parameters = jsonencode({
    "listOfAllowedLocations" = {
      "value" = [azurerm_resource_group.test.location]
    }
  })
}

Could you update the documentation as well?

[stanleyz]

And MS doc also states it accept 1-24 characters.

https://learn.microsoft.com/en-us/azure/azure-resource-manager/management/resource-name-rules

Can we have the provider document updated accordingly as well? Thanks.

[ezhong-msft]

Ah thanks for the docs, was not aware this existed. Updated the length and added the additional validations too.

[stanleyz]

Thanks @ezhong-msft , I'll leave this to @sreallymatt for review as he is the owner of this component.

The code looks good to me in general, however wondering whether we should make it super clear in the doc as about what characters are not allowed, but I am not too fussy about this.

Thanks again for the work.

[sreallymatt]

Thanks @ezhong-msft LGTM ✅

[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.