Add linter settings in the Bicep config file

  • Article

In a bicepconfig.json file, you can customize validation settings for the Bicep linter. The linter uses these settings when evaluating your Bicep files for best practices.

This article describes the settings that are available for working with the Bicep linter.

Customize linter

The linter settings are available under the analyzers element. You can enable or disable the linter, supply rule-specific values, and set the level of rules.

The following example shows the rules that are available for configuration.

{
  "analyzers": {
    "core": {
      "enabled": true,
      "rules": {
        "adminusername-should-not-be-literal": {
          "level": "warning"
        },
        "artifacts-parameters": {
          "level": "warning"
        },
        "decompiler-cleanup": {
          "level": "warning"
        },
        "max-outputs": {
          "level": "warning"
        },
        "max-params": {
          "level": "warning"
        },
        "max-resources": {
          "level": "warning"
        },
        "max-variables": {
          "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"
        },
        "use-protectedsettings-for-commandtoexecute-secrets": {
          "level": "warning"
        },
        "use-recent-api-versions": {
          "level": "warning"
        },
        "use-resource-id-functions": {
          "level": "warning"
        },
        "use-stable-resource-identifiers": {
          "level": "warning"
        },
        "use-stable-vm-image": {
          "level": "warning"
        }
      }
    }
  }
}

The properties are:

  • enabled: specify true for enabling linter, false for disabling linter.
  • verbose: specify true to show the bicepconfig.json file used by Visual Studio Code.
  • rules: specify rule-specific values. Each rule has a level that determines how the linter responds when a violation is found.

The available values for level are:

level Build-time behavior Editor behavior
Error Violations appear as Errors in command-line build output, and causes the build to fail. Offending code is underlined with a red squiggle and appears in Problems tab.
Warning Violations appear as Warnings in command-line build output, but they don't cause the build to fail. Offending code is underlined with a yellow squiggle and appears in Problems tab.
Info Violations don't appear in the command-line build output. Offending code is underlined with a blue squiggle and appears in Problems tab.
Off Suppressed completely. Suppressed completely.

Environment URLs

For the rule about hardcoded environment URLs, you can customize which URLs are checked on Azure China cloud.

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

Next steps