PMNFR1 - Module Naming
ID: PMNFR1 - Category: Naming - Module Naming
Pattern Modules MUST follow the below naming conventions (all lower case).
Important
The module’s approved name is captured in the module proposal issue. The related module index page and CSV file remain published lookup references.
Module owners must use the name approved in the module proposal, not construct a new one. If it differs from the index, confirm the correction with the AVM core team.
Correct descriptive fields through the metadata review process. Changing moduleDisplayName does not rename the module or change its repository path.
Bicep Pattern Module Naming
- Naming convention:
avm/ptn/<hyphenated grouping/category name>/<hyphenated pattern module name> - Example:
avm/ptn/compute/app-tier-vmssoravm/ptn/avd-lza/management-planeoravm/ptn/3-tier/web-app - Segments:
ptndefines this as a pattern module<hyphenated grouping/category name>is a hierarchical grouping of pattern modules by category, with each word separated by dashes, such as:- project name, e.g.,
avd-lza, - primary resource provider, e.g.,
computeornetwork, or - architecture, e.g.,
3-tier
- project name, e.g.,
<hyphenated pattern module name>is a term describing the module’s function, with each word separated by dashes, e.g.,app-tier-vmss= Application Tier VMSS;management-plane= Azure Virtual Desktop Landing Zone Accelerator Management Plane
Terraform Pattern Module Naming
- Naming convention:
avm-ptn-<pattern module name>(Module name for registry)terraform-<provider>-avm-ptn-<pattern module name>(GitHub repository name to meet registry naming requirements)
- Example:
avm-ptn-apptiervmssoravm-ptn-avd-lza-managementplane - Segments:
<provider>is a legacy requirement of the Terraform registry. This must be set toazureptndefines this as a pattern module<pattern module name>is a term describing the module’s function, e.g.,apptiervmss= Application Tier VMSS;avd-lza-managementplane= Azure Virtual Desktop Landing Zone Accelerator Management Plane