Skip to content

Latest commit

 

History

History
47 lines (31 loc) · 1.89 KB

CAF.Name.VNG.md

File metadata and controls

47 lines (31 loc) · 1.89 KB
Raw
pillar category online version
Operational Excellence
Resource naming

Use standard virtual network gateway names

SYNOPSIS

Virtual network gateway names should use a standard prefix.

DESCRIPTION

An effective naming convention allows operators to quickly identify resource type, associated workload, deployment environment and Azure region.

For virtual network gateways, the Cloud Adoption Framework recommends using the vgw- prefix.

Requirements for virtual network gateway names:

  • At least 1 character, but no more than 80.
  • Can include alphanumeric, underscore, hyphen, period characters.
  • Can only start with a letter or number, and end with a letter, number or underscore.
  • Virtual network gateway names must be unique within a resource group.

RECOMMENDATION

Consider creating virtual network gateways with a standard name. Additionally consider using Azure Policy to only permit creation using a standard naming convention.

NOTES

This rule does not check if virtual network gateway names are unique.

To configure this rule:

  • Override the CAF_VirtualNetworkGatewayPrefix configuration value with an array of allowed prefixes.
  • Override CAF_UseLowerNames with false to 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.

LINKS