Bicep 構成ファイルにリンター設定を追加する
bicepconfig.json ファイルで、Bicep リンターの検証設定をカスタマイズできます。 リンターでは、ベスト プラクティスに関して Bicep ファイルを評価するときに、これらの設定が使用されます。
この記事では、Bicep リンターの操作に使用できる設定について説明します。
リンターのカスタマイズ
リンター設定は、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": "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"
}
}
}
}
}
次のプロパティです。
- enabled: リンターを有効にする場合は true を、リンターを無効にする場合は false を指定します。
- verbose: Visual Studio Code で使用される bicepconfig.json ファイルを表示するには、true を指定します。
- rules: ルール固有の値を入力します。 各ルールには、違反が検出された場合にリンターがどのように応答するかを決定するレベルがあります。
level に使用できる値は次のとおりです。
| level | ビルド時の動作 | エディターの動作 |
|---|---|---|
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"
]
}
}
}
}
}