Bicep updates for validation and clean up

[Elinora White (ElinoraWhite)]

Change

• Updates to bicep files and straggling parameter files.
• Added tweaks to parameter validation and docs.
• Added example for PSRule integration as WAF aligned tests.

Type of Change

Please delete options that are not relevant.

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)

Checklist

• I'm sure there are no other open Pull Requests for the same update/change
• My corresponding pipelines / checks run clean and green without any errors or warnings
• My code follows the style guidelines of this project
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation (readme)
• I did format my code

[Elinora White (ElinoraWhite)]

Sebastian Gräf (@segraef) Something to get the process started.

[Alexander Sehr (AlexanderSehr)]

All changes for the ARM templates can be ignored/removed as those templates will be removed within the next week(s). The same is true for anything pointing at them (aka references).

All other parts (like the analysis) look good. In any case thanks for the updates, it just happens that the repo will only contain bicep, but not ARM templates.

[Elinora White (ElinoraWhite)]

@MrMCake Let me know if you want to chat on the updates.

[Alexander Sehr (AlexanderSehr)]

Will be introduced once the work surrounding #1624 is completed

[Elinora White (ElinoraWhite)]

@MrMCake Is this something that we can reactivate now #1624 is done, or are we waiting for #1787 as well?

[Alexander Sehr (AlexanderSehr)]

Hey @BernieWhite please excuse the very late reply - have always had your PR in the back of my head as we get closer to enabling its implementation (finally). So we are we at now:

• The one major 'issue' we're currently wrapping up (ETA end of this month, ideally sooner) is #1791 which will unblock PSRule for us (finally). Everthing until now was pretty much enabling the Bicep-Test files, #1791 is implementing them
• Erika Gressi (@eriqua) was so keen to start working on PSRule and testing it with several of our already prepared modules. To roll it out on scale, we have several issues like
  • [Feature Request]: PSRule integration - container #2149
  • [PSRule] Run PSRule pre-flight validation on diff (PR check) #2150
  • [PSRule] Discuss PSRule validation results and update modules/module tests accordingly #2151
  • [Feature Request]: Integrate PSRule PoC #2026.

As far as I'm concerned, this will be our next big focus area once 1791 is merged - and any guidance you can provide is naturally more than welcome. If I understood Erika Gressi (@eriqua) correctly, it will be some work to both finetune the rules for CARML (as some rules, for example, apply better to solutions rather than modules) and also address any findings. :)

[Erika Gressi (eriqua)]

@BernieWhite PSRule has finally been integrated with GitHub workflows. Ref:

• [PSRule] Run PSRule pre-flight validation on the whole library (scheduled pipeline) #2425
• [PSRule] Integrate PSRule pre-flight checks with GH module validation workflows #2426

Currently this is implemented in audit mode. Meanwhile, we're working on module tests to adhere with the rules. Ref:

• [PSRule] Discuss PSRule validation results and update modules/module tests accordingly #2151

This was very much thanks to this draft PR, which helped us getting the base of the implementation.

@BernieWhite Alexander Sehr (@AlexanderSehr) if you agree I would then suggest to close this PR.

[Elinora White (ElinoraWhite)]

@BernieWhite PSRule has finally been integrated with GitHub workflows. Ref:

• [PSRule] Run PSRule pre-flight validation on the whole library (scheduled pipeline) #2425
• [PSRule] Integrate PSRule pre-flight checks with GH module validation workflows #2426

Currently this is implemented in audit mode. Meanwhile, we're working on module tests to adhere with the rules. Ref:

• [PSRule] Discuss PSRule validation results and update modules/module tests accordingly #2151

This was very much thanks to this draft PR, which helped us getting the base of the implementation.

@BernieWhite Alexander Sehr (@AlexanderSehr) if you agree I would then suggest to close this PR.

Erika Gressi (@eriqua) Great work. Yep. Sounds good to me.