Usare Bicep linter

Bicep linter controlla i file Bicep per individuare errori di sintassi e violazioni delle procedure consigliate. Linter consente di applicare gli standard di codifica fornendo indicazioni durante lo sviluppo. È possibile personalizzare le procedure consigliate da usare per controllare il file.

Requisiti di Linter

Linter è integrato nell'interfaccia della riga di comando di Bicep e nell'estensione Bicep per Visual Studio Code. Per usarlo, è necessario avere l'interfaccia della riga di comando di Bicep versione 0.4 o successiva.

Regole predefinite

Il set predefinito di regole linter è minimo e ottenuto da test case arm-ttk. L'estensione e l'interfaccia della riga di comando di Bicep controllano le regole seguenti, che vengono impostate sul livello di avviso.

Regola Linter Livello predefinito
nomeutentedellamministratore-non-dovrebbe-essere-letterale avvertimento
parametri-degli-artefatti avvertimento
Pulizia del decompilatore avvertimento
valori-espliciti-per-parametri-loc spento
max-asserzioni Errore
max-outputs Errore
Parametri massimi Errore
max-risorse Errore
max-variabili Errore
ambito di template di implementazione annidata Errore
metadati senza conflitti avvertimento
nessuna-risorsa-di-implementazione avvertimento
nessuna-risorsa-esplicita avvertimento
no-hardcoded-env-urls avvertimento
posizione-non-codificata-in-hard spento
nessun output codificato in modo statico spento
no-loc-expr-outside-parameters spento
no-nome-modulo spento
no-dipendenze-non-necessarie avvertimento
nessuna risorsa esistente non utilizzata avvertimento
nessuna-importazione-inutilizzata avvertimento
Nessun parametro inutilizzato avvertimento
Nessun tipo non utilizzato avvertimento
nessuna-variabile-inutilizzata avvertimento
le uscite non dovrebbero contenere segreti avvertimento
prefer-interpolazione avvertimento
prefer-unquoted-property-names (preferisci nomi di proprietà senza virgolette) avvertimento
proteggi-comandoeseguire-segreti avvertimento
parametro-secure-default avvertimento
parametri-sicuri-in-distribuzione-annidata avvertimento
parametri-protetti-nel-file-dei-parametri avvertimento
proteggere-i-segreti-nei-parametri avvertimento
semplificare l'interpolazione avvertimento
simplify-json-null avvertimento
Descrizione-Usa-Output spento
Usa-descrizione-parametri spento
Proprietà-tipo-descrizione-uso spento
Descrizione-Uso-Tipi spento
use-description-vars spento
usare-proprietà-parente avvertimento
usa-le-versioni-API-più-recenti spento
usare-versione-powershell-az-recente avvertimento
utilizzare-versioni-recenti-del-modulo spento
usa-tipo-di-risorsa-riconosciuto avvertimento
usare-funzioni-ID-risorsa spento
riferimento-al-simbolo-della-risorsa-usata avvertimento
accesso-sicuro-all'uso avvertimento
usa-valore-sicuro-per-input-sicuri avvertimento
usa-identificatori-di-risorse-stabili avvertimento
usare-immagoine-vm-stabile avvertimento
usare-tipi-definiti-dall'utente spento
circuito chiuso condizionale spento

È possibile abilitare o disabilitare tutte le regole linter e controllare il modo in cui vengono applicate usando un file di configurazione. Per eseguire l'override del comportamento predefinito, creare un filebicepconfig.json con le impostazioni personalizzate. Per altre informazioni sull'applicazione di tali impostazioni, vedere Aggiungere impostazioni personalizzate nel file di configurazione bicep.

Usare in Visual Studio Code

Lo screenshot seguente illustra il linter in Visual Studio Code:

Utilizzo di linter Bicep in Visual Studio Code.

Nel riquadro PROBLEMI lo screenshot mostra quattro errori, un avviso e un messaggio di informazioni. Il messaggio informativo mostra il file di configurazione Bicep usato. Mostra solo queste informazioni quando si imposta verbose su true nel file di configurazione.

Passare il cursore del mouse su una delle aree problematiche. Il linter fornisce i dettagli sull'errore o sull'avviso. Selezionare l'area, che mostra anche una lampadina blu:

Utilizzo di linter Bicep in Visual Studio Code - mostra quickfix.

Selezionare la lampadina o il collegamento Correzione rapida per visualizzare la soluzione:

Utilizzo di linter Bicep in Visual Studio Code - mostra soluzione quickfix.

Selezionare la soluzione per risolvere automaticamente il problema.

Usare nell'interfaccia della riga di comando di Bicep

Lo screenshot seguente mostra il linter nella riga di comando. L'output del comando lint e del comando di compilazione mostra eventuali violazioni delle regole.

Utilizzo di linter Bicep nella riga di comando.

È possibile integrare questi controlli come parte delle pipeline CI/CD. È possibile usare un'azione GitHub per tentare una compilazione bicep. Gli errori causano il fallimento delle pipeline.

Ridurre al minimo i falsi positivi.

In alcuni casi, una regola presenta falsi positivi. Ad esempio, potrebbe essere necessario includere un collegamento a un archivio BLOB direttamente senza usare la funzione environment() .

È possibile eliminare le regole del linter Bicep usando disable-next-line e disable-diagnostics. Vedere Direttive. Se si desidera eliminare una regola linter, modificare il livello della regola in Off in bicepconfig.json. Nell'esempio seguente la no-deployments-resources regola viene eliminata:

{
  "analyzers": {
    "core": {
      "rules": {
        "no-deployments-resources": {
          "level": "off"
        }
      }
    }
  }
}

Passaggi successivi

  • Last updated on