Partilhar via


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

Num ficheiro bicepconfig.json , pode personalizar as definições de validação para o linter Bicep. O linter utiliza estas definições ao avaliar os seus ficheiros bicep para melhores práticas.

Este artigo descreve as definições que estão disponíveis para trabalhar com o linter Bicep.

Personalizar linter

As definições de linter estão disponíveis no analyzers elemento. Pode ativar ou desativar o linter, fornecer valores específicos da regra e definir o nível de regras.

O exemplo seguinte 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": "off"
        },
        "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": "off"
        },
        "no-loc-expr-outside-params": {
          "level": "off"
        },
        "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-recent-module-versions": {
          "level": "warning"
        },
        "use-resource-id-functions": {
          "level": "warning"
        },
        "use-resource-symbol-reference": {
          "level": "warning"
        },
        "use-safe-access": {
          "level": "warning"
        },
        "use-secure-value-for-secure-inputs": {
          "level": "error"
        },
        "use-stable-resource-identifiers": {
          "level": "warning"
        },
        "use-stable-vm-image": {
          "level": "warning"
        },
        "what-if-short-circuiting": {
          "level": "warning"
        }
      }
    }
  }
}

As propriedades são:

  • ativado: especifiqueverdadeiro para ativar o linter, falso para desativar o linter.
  • verboso: especifique true para mostrar o ficheiro bicepconfig.json utilizado pelo Visual Studio Code.
  • regras: especifique valores específicos de regras. Cada regra tem um nível que determina como o linter responde quando é encontrada uma violação.

Os valores disponíveis para o nível são:

nível Comportamento do tempo de compilação Comportamento do editor
Error As violações aparecem como Erros na saída da compilação da linha de comandos e fazem com que a compilação falhe. O código ofensivo é sublinhado com um botão vermelho e aparece no separador Problemas.
Warning As violações aparecem como Avisos na saída da compilação da linha de comandos, mas não fazem com que a compilação falhe. O código ofensivo é sublinhado com um botão amarelo e aparece no separador Problemas.
Info As violações não aparecem na saída da compilação da linha de comandos. O código ofensivo é sublinhado com um botão azul e aparece no separador Problemas.
Off Suprimido completamente. Suprimido completamente.

URLs do ambiente

Para a regra sobre URLs de ambiente codificados, pode personalizar os URLs selecionados. Por predefinição, são aplicadas as seguintes definições:

{
  "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"
          ]
        }
      }
    }
  }
}

Passos seguintes