Linter rule - use description variables

This rule requires every variable to have a non-empty @description decorator. Clear descriptions explain the purpose of values that are calculated in a Bicep file.

Linter rule code

Use the following value in the Bicep configuration file to customize rule settings:

use-description-vars

Solution

The following variable fails this rule because it has no description:

var storageAccountName = '${namePrefix}storage'

To fix the problem, add a non-empty @description decorator:

@description('The name assigned to the storage account.')
var storageAccountName = '${namePrefix}storage'

Next steps

For more information about the linter, see Use Bicep linter.