Поделиться через

Добавьте параметры линтера в файл конфигурации Bicep

  • Статья

В файлеbicepconfig.json можно настроить параметры проверки для Bicep linter. Linter использует эти параметры при оценке файлов Bicep с точки зрения лучших практик.

В этой статье описываются параметры, доступные для работы с Bicep linter.

Настроить линтер

Параметры linter находятся в элементе analyzers. Вы можете включить или отключить линтер, указать значения, специфичные для правил, и установить уровень правил.

В следующем примере показаны правила, доступные для настройки.

{
  "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": "off"
        },
        "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"
        }
      }
    }
  }
}

Свойства:

  • enabled: укажите true для включения линтера, false для отключения линтера.
  • режим подробного вывода: установите true, чтобы отобразить файл bicepconfig.json, используемый программой Visual Studio Code.
  • правила: укажите значения, относящиеся к правилу. Каждое правило имеет уровень, определяющий, как линтер (программа контроля кода) реагирует при обнаружении нарушения.

Доступные значения для уровня :

уровень Поведение во время сборки Поведение редактора
Error Нарушения отображаются как ошибки в выходных данных сборки командной строки и приводят к сбою сборки. Код с ошибкой выделяется красной волной и отображается на вкладке "Проблемы".
Warning Нарушения отображаются как предупреждения в выходных данных сборки командной строки, но они не вызывают сбой сборки. Ошибочный код подчеркивается желтой волнистой линией и отображается на вкладке "Проблемы".
Info Нарушения не отображаются в выходных данных сборки командной строки. Ошибочный код подчеркнут синей волнистой линией и появляется во вкладке "Проблемы".
Off Полностью подавлено. Полностью подавлено.

URL-адреса окружения

Для правила о жестко прописанных URL-адресах окружения вы можете настроить, какие URL-адреса проверяются. По умолчанию применяются следующие параметры:

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

Дальнейшие шаги