Skip to content

Use template parameter descriptions#

Operational Excellence · All resources · Azure.Template.ParameterMetadata

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.


Last update: 2021-09-24