Overview/Summary

Change in the READMEs of each of the modules which has a deployment snippet and also amendment of Resource Group Names to conform to CAF Standardisation. A PR to work on Issue #267 and #290

This PR fixes/adds/changes/removes

1. Adds CAF Standardisation to Resource Group Names
2. Adds deployment names into snippets
3. Conforms deployment methods including names to CARML standards

Breaking Changes

1. N/A - documentation

Testing Evidence

As part of this Pull Request I have

• [X] Read the Contribution Guide and ensured this PR is compliant with the guide
• [X] Ensured the resource API versions in .bicep file/s I am adding/editing are using the latest API version possible
• [X] Checked for duplicate Pull Requests
• [X] Associated it with relevant GitHub Issues
• [X] (ALZ Bicep Core Team Only) Associated it with relevant ADO Items
• [X] Ensured my code/branch is up-to-date with the latest changes in the main branch
• [X] Performed testing and provided evidence.
• [X] 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)
• [X] Updated relevant and associated documentation (e.g. Contribution Guide, Module READMEs, Wiki Docs etc.)
• [X] If relevant, created or updated Code Tours here

@JamJarchitect Can we do this for all Bicep docs (like orchestration and CRML etc.)

Cheers

This should now be done @jtracey93

@JamJarchitect sorry buddy.

Can we add and alz prefix to the deployment names just so they are easy to find/remember for users?

Also do we need to add a note for all bash usage that pwsh needs to be installed for the inputObject to work?

@jtracey93 prefix added, naming conventions done, NOTE added on bash on Private DNS zone as well. Any reviewer(s) are welcome!

/azp run validateazcloud

Azure Pipelines successfully started running 1 pipeline(s).

@msftbot do not merge until @jtracey93 Jack Tracey FTE & @rjygraham Ryan Graham FTE have approved

Hello @jtracey93!

Because you've given me some instructions on how to help merge this pull request, I'll be modifying my merge approach. Here's how I understand your requirements for merging this pull request:

• I'll only merge this pull request if it's approved by @jtracey93 and @rjygraham

If this doesn't seem right to you, you can tell me to cancel these instructions and use the auto-merge policy that has been configured for this repository. Try telling me "forget everything I just told you".

@jtracey93, @JamJarchitect rather than litter the PR with comments. My assumption is that Azure CLI commands would target a Bash shell and therefore we can't count on PowerShell being available. Should the Azure CLI snippets be updated to be "PowerShell free"? Apologies if I missed a conversation where we said this would be ok.

@jtracey93 Jack Tracey FTE, @JamJarchitect James Jones FTE rather than litter the PR with comments. My assumption is that Azure CLI commands would target a Bash shell and therefore we can't count on PowerShell being available. Should the Azure CLI snippets be updated to be "PowerShell free"? Apologies if I missed a conversation where we said this would be ok.

As discussed in scrum call, we have decided that we want the bash stuff to be native and no PowerShell (even if its cross platform).

@mblant & @rjygraham if there is suggestions you have for converting the below into bash native, then that would be awesome and @JamJarchitect can pick up when back from OOF and update this PR:

$inputObject = @(
'--name',           ('alz-ContainerRegistry-{0}' -f (-join (Get-Date -Format 'yyyyMMddTHHMMssffffZ')[0..63])),
'--resource-group', 'Bicep_ACR',
'--parameters',     '@infra-as-code/bicep/CRML/containerRegistry/parameters/containerRegistry.parameters.all.json',
'--template-file',  "infra-as-code/bicep/CRML/containerRegistry/containerRegistry.bicep",
)

az deployment group create @inputObject

/azp run validateazcloud

Commenter does not have sufficient privileges for PR 312 in repo Azure/ALZ-Bicep

/azp run validateazcloud

Azure Pipelines successfully started running 1 pipeline(s).

@rjygraham are you good to give this a review now @JamJarchitect has converted the bash to native cli?

sorry to chase @rjygraham have you had a chance to review this one, or do we need to reassign?

@jtracey93 This looks good to me.

@JamJarchitect can we resolve the merge conflicts here and then we can look to merge 👍

@jtracey93 those last two amendments were done. should all be good now!

/azp run validateazcloud

Azure Pipelines successfully started running 1 pipeline(s).