Regola del linter - usa tipi di descrizione

Questa regola richiede che i tipi definiti dall'utente abbiano un decoratore non vuoto @description . Descrizioni chiare spiegano lo scopo previsto dei tipi che definisci.

Note

Questa regola è disattivata di default. Cambia il livello inbicepconfig.json per attivarlo. I tipi che hanno un @discriminator decoratore non sono valutati secondo questa regola.

Codice regola Linter

Usare il valore seguente nel file di configurazione Bicep per personalizzare le impostazioni delle regole:

use-description-types

Soluzione

Il seguente tipo definito dall'utente non regge questa regola perché non ha descrizione:

type StorageConfig = {
  name: string
  sku: string
}

Per risolvere il problema, aggiungi un decoratore non vuoto @description :

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

Passaggi successivi

Per ulteriori informazioni su linter, vedere Usare linter di Bicep.