Bicep リンターでBicep のコードをチェックする

param location string = 'japaneast'

// NG：locationを明示的に設定していないため、モジュール内のlocationを参照する
module moduleTest 'module.bicep' = {
  name: 'moduleTest'
}

resource storageaccount 'Microsoft.Storage/storageAccounts@2024-03-01' = {
  name: 'storageaccount'
  location: location
  kind: 'StorageV2'
  sku: {
    name: 'Standard_LRS'
  }
}

// NG：モジュール内の規定が東日本以外の場合、他のリージョンが設定される可能性があるため警告となる
param location string = resourceGroup().location

resource staging 'Microsoft.Storage/storageAccounts@2024-03-01' = {
  name: 'stagingTest'
  location: location
  kind: 'StorageV2'
  sku: {
    name: 'Premium_LRS'
  }
}

param location string = 'japaneast'

// OK：モジュールに対しlocationを明示的に設定するため差異が発生しなくなる
module moduleTest 'module.bicep' = {
  name: 'moduleTest'
  params: {
   location: location
  }
}

resource storageaccount 'Microsoft.Storage/storageAccounts@2024-03-01' = {
  name: 'storageaccount'
  location: location
  kind: 'StorageV2'
  sku: {
    name: 'Standard_LRS'
  }
}

// NG：resourceGroupNameを利用していないため警告となる
targetScope = 'subscription'

param resourceGroupName string = 'rg-test'

resource rg 'Microsoft.Resources/resourceGroups@2024-03-01' = {
  name: 'rg-test'
  location: 'japaneast'
}

// OK：resourceGroupNameをnameに利用しているため合格
targetScope = 'subscription'

param resourceGroupName string = 'rg-test'

resource rg 'Microsoft.Resources/resourceGroups@2024-03-01' = {
  name: resourceGroupName
  location: 'japaneast'
}

// NG：セキュリティ保護されたパラメーターに規定値を設定しているため警告となる
@secure()
param databasePassword string = 'p3gT3!f-rGe2BF'

// OK：セキュリティ保護されたパラメーターに規定値を設定しない
@secure()
param databasePassword string

// OK：セキュリティ保護されたパラメーターに空文字を設定する
@secure()
param databasePassword string = ''

// OK：セキュリティ保護されたパラメーターをnewGuid関数で生成する
@secure()
param databasePassword string = newGuid()

az bicep lint <オプション>

# Bicepリンターでmain.bicepをチェックする
az bicep lint -f main.bicep

C:\Users\IKEAShark\Documents\code\bicep\main.bicep(25,7) : Warning no-unused-params: Parameter "databasePassword" is declared but never used. [https://aka.ms/bicep/linter/no-unused-params]
C:\Users\IKEAShark\Documents\code\bicep\main.bicep(25,7) : Warning secure-secrets-in-params: Parameter 'databasePassword' may represent a secret (according to its name) and must be declared with the '@secure()' attribute. [https://aka.ms/bicep/linter/secure-secrets-in-params]

# Bicepリンターの結果をJSON形式で出力する
az bicep lint -f main.bicep --diagnostics-format sarif

{
  "$schema": "https://schemastore.azurewebsites.net/schemas/json/sarif-2.1.0-rtm.6.json",
  "version": "2.1.0",
  "runs": [
    {
      "tool": {
        "driver": {
          "name": "bicep"
        }
      },
      "results": [
        {
          "ruleId": "no-unused-params",
          "message": {
            "text": "Parameter \"databasePassword\" is declared but never used. [https://aka.ms/bicep/linter/no-unused-params]"
          },
          "locations": [
            {
              "physicalLocation": {
                "artifactLocation": {
                  "uri": "file:///C:/Users/IKEAShark/Documents/code/bicep/temp/main.bicep"
                },
                "region": {
                  "startLine": 25,
                  "charOffset": 7
                }
              }
            }
          ]
        },
        {
          "ruleId": "secure-secrets-in-params",
          "message": {
            "text": "Parameter 'databasePassword' may represent a secret (according to its name) and must be declared with the '@secure()' attribute. [https://aka.ms/bicep/linter/secure-secrets-in-params]"
          },
          "locations": [
            {
              "physicalLocation": {
                "artifactLocation": {
                  "uri": "file:///C:/Users/IKEAShark/Documents/code/bicep/temp/main.bicep"
                },
                "region": {
                  "startLine": 25,
                  "charOffset": 7
                }
              }
            }
          ]
        }
      ],
      "columnKind": "utf16CodeUnits"
    }
  ]
}

{
  "analyzers": {
    "core": {
      "enabled": true,
      "rules": {
        "secure-secrets-in-params": {
          "level": "warning"
        }
      }
    }
  }
}