Use comments for each ARM template resource

March 29, 2024 ยท View on GitHub

SYNOPSIS

Use comments for each resource in ARM template to communicate purpose.

DESCRIPTION

ARM templates can optionally include comments in resources. This helps other contributors understand the purpose of the resource.

RECOMMENDATION

Specify comments for each resource in the template.

EXAMPLES

Configure with Azure template

To define Azure template files that pass this rule:

  • Specify comments for each resource in the template.

For example:

"resources": [
  {
    "name": "[variables('storageAccountName')]",
    "type": "Microsoft.Storage/storageAccounts",
    "apiVersion": "2019-06-01",
    "location": "[resourceGroup().location]",
    "comments": "This storage account is used to store the VM disks.",
      ...
  }
]