Added Management Group Suffix Parameter parTopLevelManagementGroupSuffix

[mbrat2005]

Overview/Summary

Added a Management Group suffix parameter, enabling users to further customize the name of deployed management groups.

The suffix value will need to include a delimiter if the customer desires (to keep logic simple).

Child and custom management groups will also have the suffix appended.

#452
AB#26778

This PR fixes/adds/changes/removes

1. Adds the parTopLevelManagementGroupSuffix parameter to the managementGroups, alzDefaultPolicyAssignments, hubPeeredSpoke, mgDiagSettingsAll, and subPlacementAll deployments
2. Updates readmes to document parameter

Breaking Changes

None

Testing Evidence

Tested management group and policy deployments

Name                                          Type                       Value
                          ============================================  =========================  ==========
                          outTopLevelManagementGroupId                  String                     "/providers/Microsoft.Management/managementGroups/alz-mtb"
                          outPlatformManagementGroupId                  String                     "/providers/Microsoft.Management/managementGroups/alz-platform-mtb"
                          outPlatformManagementManagementGroupId        String                     "/providers/Microsoft.Management/managementGroups/alz-platform-management-mtb"
                          outPlatformConnectivityManagementGroupId      String                     "/providers/Microsoft.Management/managementGroups/alz-platform-connectivity-mtb"
                          outPlatformIdentityManagementGroupId          String                     "/providers/Microsoft.Management/managementGroups/alz-platform-identity-mtb"
                          outLandingZonesManagementGroupId              String                     "/providers/Microsoft.Management/managementGroups/alz-landingzones-mtb"
                          outLandingZoneChildrenManagementGroupIds      Array                      ["/providers/Microsoft.Management/managementGroups/alz-landingzones-corp-mtb","/providers/Microsoft.Management/managementGroups/alz-landingzones-online-mtb"]
                          outSandboxManagementGroupId                   String                     "/providers/Microsoft.Management/managementGroups/alz-sandbox-mtb"
                          outDecommissionedManagementGroupId            String                     "/providers/Microsoft.Management/managementGroups/alz-decommissioned-mtb"
                          outTopLevelManagementGroupName                String                     "alz-mtb"
                          outPlatformManagementGroupName                String                     "alz-platform-mtb"
                          outPlatformManagementManagementGroupName      String                     "alz-platform-management-mtb"
                          outPlatformConnectivityManagementGroupName    String                     "alz-platform-connectivity-mtb"
                          outPlatformIdentityManagementGroupName        String                     "alz-platform-identity-mtb"
                          outLandingZonesManagementGroupName            String                     "alz-landingzones-mtb"
                          outLandingZoneChildrenManagementGroupNames    Array                      ["Corp","Online"]
                          outSandboxManagementGroupName                 String                     "alz-sandbox-mtb"
                          outDecommissionedManagementGroupName          String                     "alz-decommissioned-mtb"

As part of this Pull Request I have

• Read the Contribution Guide and ensured this PR is compliant with the guide
• Ensured the resource API versions in .bicep file/s I am adding/editing are using the latest API version possible
• Checked for duplicate Pull Requests
• Associated it with relevant GitHub Issues
• (ALZ Bicep Core Team Only) Associated it with relevant ADO Items
• Ensured my code/branch is up-to-date with the latest changes in the main branch
• Performed testing and provided evidence.
• Updated one or more of the following tests (if required)
  • Unit
  • Linting
  • E2E (End-To-End)
  • ValidateAzCloud (Base validation in Azure Cloud)
  • ValidateMcCloud (Base validation in Azure China Cloud)
• Updated relevant and associated documentation (e.g. Contribution Guide, Module READMEs, Wiki Docs etc.)
• If relevant, created or updated Code Tours here

[jtracey93]

Looks great @mbrat2005, thanks as always.

A couple of suggestions as the management group name is also know more commonly as the ID, so just clarifying that in the suggestions.

Also there are some linter errors with trailing whitespaces and end of lines/files. Simply openning the files in VS Code and doing a format (Shift + Alt + F) will resolve it with the .editorconfig extension installed (which should be recommended when you load the ALZ-Bicep repo 👊

[jtracey93]

/azp run validateazcloud

[azure-pipelines]

Azure Pipelines successfully started running 1 pipeline(s).

[jtracey93]

/azp run e2e

[azure-pipelines]

Azure Pipelines successfully started running 1 pipeline(s).

[jtracey93]

LGTM