Skip to content

Azure.Template.ParameterMetadata.md

Latest commit

 

History

History
46 lines (35 loc) · 1.46 KB

Azure.Template.ParameterMetadata.md

File metadata and controls

46 lines (35 loc) · 1.46 KB
Raw
severity Awareness
pillar Operational Excellence
category Release engineering
resource All resources
online version https://azure.github.io/PSRule.Rules.Azure/en/rules/Azure.Template.ParameterMetadata/

Use template parameter descriptions

SYNOPSIS

Set metadata descriptions in Azure Resource Manager (ARM) template for each parameter.

DESCRIPTION

ARM templates supports an additional metadata description to be added to each parameter. The parameter description is visible in Azure when using portal deployment pages. Additionally, descriptions provide context for people editing template and parameter files.

For example:

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "storageAccountType": {
      "type": "string",
      "metadata": {
          "description": "The type of the new storage account created to store the VM disks."
      }
    }
  }
}

RECOMMENDATION

Consider defining a metadata description for each template parameter.

LINKS