Adicionar configurações do linter no arquivo de configuração do Bicep

Em um arquivo bicepconfig.json, você pode personalizar as configurações de validação para o linter Bicep. O linter usa essas configurações ao avaliar seus arquivos Bicep para melhores práticas.

Este artigo descreve as configurações disponíveis para trabalhar com o linter Bicep.

Personalizar o linter

As configurações de linter estão disponíveis no elemento analyzers. Você pode habilitar ou desabilitar o linter, fornecer valores específicos da regra, bem como definir o nível de regras.

O exemplo a seguir mostra as regras que estão disponíveis para configuração.

{
  "analyzers": {
    "core": {
      "enabled": true,
      "rules": {
        "adminusername-should-not-be-literal": {
          "level": "warning"
        },
        "artifacts-parameters": {
          "level": "warning"
        },
        "decompiler-cleanup": {
          "level": "warning"
        },
        "explicit-values-for-loc-params": {
          "level": "warning"
        },
        "max-asserts": {
          "level": "warning"
        },
        "max-outputs": {
          "level": "warning"
        },
        "max-params": {
          "level": "warning"
        },
        "max-resources": {
          "level": "warning"
        },
        "max-variables": {
          "level": "warning"
        },
        "nested-deployment-template-scoping": {
          "level": "error"
        },
        "no-conflicting-metadata" : {
          "level": "warning"
        },
        "no-deployments-resources" : {
          "level": "warning"
        },
        "no-hardcoded-env-urls": {
          "level": "warning"
        },
        "no-hardcoded-location": {
          "level": "warning"
        },
        "no-loc-expr-outside-params": {
          "level": "warning"
        },
        "no-unnecessary-dependson": {
          "level": "warning"
        },
        "no-unused-existing-resources": {
          "level": "warning"
        },
        "no-unused-params": {
          "level": "warning"
        },
        "no-unused-vars": {
          "level": "warning"
        },
        "outputs-should-not-contain-secrets": {
          "level": "warning"
        },
        "prefer-interpolation": {
          "level": "warning"
        },
        "prefer-unquoted-property-names": {
          "level": "warning"
        },
        "protect-commandtoexecute-secrets": {
          "level": "warning"
        },
        "secure-parameter-default": {
          "level": "warning"
        },
        "secure-params-in-nested-deploy": {
          "level": "warning"
        },
        "secure-secrets-in-params": {
          "level": "warning"
        },
        "simplify-interpolation": {
          "level": "warning"
        },
        "simplify-json-null": {
          "level": "warning"
        },
        "use-parent-property": {
          "level": "warning"
        },
        "use-recent-api-versions": {
          "level": "warning",
          "maxAllowedAgeInDays": 730
        },
        "use-resource-id-functions": {
          "level": "warning"
        },
        "use-resource-symbol-reference": {
          "level": "warning"
        },
        "use-stable-resource-identifiers": {
          "level": "warning"
        },
        "use-stable-vm-image": {
          "level": "warning"
        }
      }
    }
  }
}

As propriedades são:

  • enabled: especifique true para habilitar o linter e false para desabilitar o linter.
  • verbose: especifique true para mostrar o arquivo bicepconfig.json usado pelo Visual Studio Code.
  • rules: especifique valores específicos da regra. Cada regra tem um nível que determina como o pano responde quando uma violação é encontrada.

Os valores disponíveis para o level são:

level Comportamento em tempo de compilação Comportamento do editor
Error As violações aparecem como Erros na saída de build de linha de comando e causam falha nos builds. O código incorreto é sublinhado com um rabisco vermelho, e aparece na guia Problemas.
Warning As violações aparecem como Avisos na saída de build de linha de comando, mas não causam falha nos builds. O código incorreto é sublinhado com um rabisco amarelo, e aparece na guia Problemas.
Info As violações não aparecem na saída de build de linha de comando. O código incorreto é sublinhado com um rabisco azul, e aparece na guia Problemas.
Off Suprimido completamente. Suprimido completamente.

URLs de ambiente

Para a regra sobre URLs de ambiente embutido em código, você pode personalizar quais URLs são verificadas. Por padrão, as seguintes configurações são aplicadas:

{
  "analyzers": {
    "core": {
      "enabled": true,
      "rules": {
        "no-hardcoded-env-urls": {
          "level": "warning",
          "disallowedhosts": [
            "api.loganalytics.io",
            "api.loganalytics.iov1",
            "asazure.windows.net",
            "azuredatalakeanalytics.net",
            "azuredatalakestore.net",
            "batch.core.windows.net",
            "core.windows.net",
            "database.windows.net",
            "datalake.azure.net",
            "gallery.azure.com",
            "graph.windows.net",
            "login.microsoftonline.com",
            "management.azure.com",
            "management.core.windows.net",
            "region.asazure.windows.net",
            "trafficmanager.net",
            "vault.azure.net"
          ],
          "excludedhosts": [
            "schema.management.azure.com"
          ]
        }
      }
    }
  }
}

Próximas etapas