Přidání nastavení linteru do konfiguračního souboru Bicep

  • Článek

V souboru bicepconfig.json můžete přizpůsobit nastavení ověřování pro bicep linter. Linter používá tato nastavení při vyhodnocování souborů Bicep z hlediska osvědčených postupů.

Tento článek popisuje nastavení, která jsou k dispozici pro práci s bicep linter.

Přizpůsobení linteru

Nastavení linteru jsou k dispozici v elementu analyzers . Linter můžete povolit nebo zakázat, zadat hodnoty specifické pro pravidlo a nastavit úroveň pravidel.

Následující příklad ukazuje pravidla, která jsou k dispozici pro konfiguraci.

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

Mezi vlastnosti patří:

  • enabled: Zadejte hodnotu true pro povolení linter, false pro zakázání linter.
  • verbose: Zadáním hodnoty true zobrazíte soubor bicepconfig.json používaný editorem Visual Studio Code.
  • pravidla: Zadejte hodnoty specifické pro pravidlo. Každé pravidlo má úroveň, která určuje, jak linter reaguje při zjištění porušení.

Dostupné hodnoty pro úroveň jsou:

úroveň Chování při sestavení Chování editoru
Error Porušení se zobrazí jako Chyby ve výstupu sestavení příkazového řádku a způsobí selhání sestavení. Urážený kód je podtrženo červenou vlnovkou a zobrazí se na kartě Problémy.
Warning Porušení se zobrazí jako Upozornění ve výstupu sestavení příkazového řádku, ale nezpůsobí selhání sestavení. Urážený kód je podtrženo žlutou vlnovkou a zobrazí se na kartě Problémy.
Info Ve výstupu sestavení příkazového řádku se nezobrazují porušení. Urážený kód je podtrženo modrou vlnovkou a zobrazí se na kartě Problémy.
Off Zcela potlačeno. Zcela potlačeno.

Adresy URL prostředí

U pravidla o pevně zakódovaných adresách URL prostředí můžete přizpůsobit, které adresy URL se kontrolují. Ve výchozím nastavení se použijí následující nastavení:

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

Další kroky