PSRule.Rules.Azure icon indicating copy to clipboard operation
PSRule.Rules.Azure copied to clipboard

Azure.Template.UseDescriptions is reporting an error which we cannot determine the cause of

Open ianbrook opened this issue 3 years ago • 1 comments

Files attached

Pipeline Output ##[error]ArtefactDownload/apptools.json failed Azure.Template.UseDescriptions. Use descriptions for each resource in generated template(bicep, psarm, AzOps) to communicate purpose

apptools.zip

ianbrook avatar Feb 16 '22 21:02 ianbrook

@ianbrook Thanks for logging this.

It's to do with resources in your modules.

For example this route table.

{
  "type": "Microsoft.Network/routeTables",
  "apiVersion": "2020-07-01",
  "name": "[parameters('routeTableName')]",
  "location": "[parameters('location')]",
  "tags": "[parameters('tags')]",
  "properties": {
    "routes": "[parameters('routes')]",
    "disableBgpRoutePropagation": "[parameters('disableBgpPropagation')]"
  }
}

In the Bicep code of the module use the @description('A description') on each resource so someone reading the code understand the purpose.

Please keep this one open and we'll make sure we update the guidance to make this clearer.

BernieWhite avatar Feb 16 '22 22:02 BernieWhite