| pillar | Operational Excellence |
|---|---|
| category | Resource naming |
| online version | https://github.com/microsoft/PSRule.Rules.CAF/blob/main/docs/rules/en/CAF.Name.VNET.md |
Virtual network names should use a standard prefix.
An effective naming convention allows operators to quickly identify resource type, associated workload, deployment environment and Azure region.
For virtual networks, the Cloud Adoption Framework recommends using the vnet- prefix.
Requirements for virtual network names:
- At least 2 characters, but no more than 64.
- Can include alphanumeric, underscore, hyphen, period characters.
- Can only start with a letter or number, and end with a letter, number or underscore.
- VNET names must be unique within a resource group.
Consider creating virtual networks with a standard name. Additionally consider using Azure Policy to only permit creation using a standard naming convention.
This rule does not check if virtual network names are unique.
To configure this rule:
- Override the
CAF_VirtualNetworkPrefixconfiguration value with an array of allowed prefixes. - Override
CAF_UseLowerNameswithfalseto allow mixed case in resource names. By default only lower-case letters and other supported characters are allowed. This option affects all resource name rules.