azuread_users - Support nonunique mail nicknames

[wyattfry]

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

Data Source azuread_users - Support nonunique mail nicknames when retrieving users by their mail nicknames. Azure does not require that this property be unique, this PR updates the retrieval and validation to more closely match the Azure API.

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"

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.

• azuread_users - * azuread_users - Support nonunique mail nicknames [azuread_users - Support nonunique mail nicknames #1762] [azuread_users - Support nonunique mail nicknames #1762]

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

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 @wyattfry, before I give this a more thorough review, I was just wondering about the implementation here and I've left a comment inline

[sreallymatt]

New test is failing at the moment:

[sreallymatt]

Thanks @wyattfry LGTM ✅

[sreallymatt]