search

Azure / Azure-Verified-Modules

Azure Verified Modules (AVM) is an initiative to consolidate and set the standards for what a good Infrastructure-as-Code module looks like. Modules will then align to these standards, across languages (Bicep, Terraform etc.) and will then be classified as AVMs and available from their respective language specific registries.
https://aka.ms/AVM
MIT License
348 stars 82 forks source link

[Documentation Update]: Define Bicep UDT specs and usage (container issue) #1559

Open eriqua opened 2 weeks ago

eriqua commented 2 weeks ago

Check for previous/existing GitHub issues

Description

Document both specs and contribution guidelines related to User Defined Types (UDT) for Bicep resource modules

### Tasks
- [ ] Contribution guidelines - how to use AVMCommonTypes utility module in resource modules
- [ ] New Spec - All objects and array of objects SHOULD define UDT to better leverage automatic documentation and intellisense.
- [ ] New Spec - All UDT MUST be singular and non nullable
- [ ] Contribution guidelines - how to define UDT for objects and array of objects
- [ ] New Spec - All top level custom types MUST be exported and have a type description
- [ ] New Spec - All custom types must be singular and MUST NOT be nullable
microsoft-github-policy-service[bot] commented 2 weeks ago

[!IMPORTANT] The "Needs: Triage :mag:" label must be removed once the triage process is complete!

[!TIP] For additional guidance on how to triage this issue/PR, see the AVM Issue Triage documentation.

AlexanderSehr commented 1 week ago

Ref: https://github.com/Azure/bicep-registry-modules/pull/3582#issuecomment-2417782383