Linter rule - use description types

This rule requires user-defined types to have a non-empty @description decorator. Clear descriptions explain the intended purpose of types that you define.

Linter rule code

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

use-description-types

Solution

The following user-defined type fails this rule because it has no description:

type StorageConfig = {
  name: string
  sku: string
}

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

@description('Configuration values for a storage account.')
type StorageConfig = {
  name: string
  sku: string
}

Next steps

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