无需部署失败，如何验证Azure IaC资源的合法命名？

以下是几种实用的预部署验证方式，能避免因命名不符合Azure资源要求导致的部署失败：

1. 依赖Bicep IDE插件的实时校验 #

Bicep的VS Code插件会根据Azure资源类型的官方定义，对名称做基础校验。比如：

• 当你为Microsoft.Security/DefenderForStorageSettings@2022-12-01-preview设置非current的名称时，插件会直接在编辑器中标红提示错误，无需等到部署阶段。
• 对于有固定命名前缀/格式要求的资源（如VM自动关机计划），如果名称不符合shutdown-computevm-开头的规则，部分场景下插件也会给出警告。

2. 编写自定义命名校验函数 #

针对特定资源的命名规则，在Bicep中编写自定义函数来强制校验，不符合规则时直接抛出错误：

// 校验VM自动关机计划的命名格式
var validateAutoShutdownName = (inputName string) => {
  if !startsWith(inputName, 'shutdown-computevm-') {
    error('VM自动关机计划名称必须以"shutdown-computevm-"开头')
  }
}

// 使用示例
var targetVmName = 'my-production-vm'
var autoShutdownScheduleName = 'shutdown-computevm-${targetVmName}'
// 执行校验，不符合则在编译阶段报错
validateAutoShutdownName(autoShutdownScheduleName)

resource autoShutdown 'Microsoft.DevTestLab/schedules@2018-09-15' = {
  name: autoShutdownScheduleName
  // 其他资源配置...
}

这种方式能在Bicep编译阶段就拦截错误，不用等到部署。

3. 配置Bicep Linter自定义规则 #

通过bicepconfig.json配置自定义的Linter规则，对指定资源类型的命名做强制校验：

1. 在项目根目录创建bicepconfig.json文件，添加如下规则：

{
  "analyzers": {
    "core": {
      "rules": {
        "enforce-autoshutdown-naming": {
          "level": "error",
          "description": "VM自动关机计划名称必须符合shutdown-computevm-{vmName}格式",
          "given": "[resourceType()]",
          "when": "equals('Microsoft.DevTestLab/schedules')",
          "then": {
            "assert": "matches(name, '^shutdown-computevm-.+$')"
          }
        },
        "enforce-defender-storage-naming": {
          "level": "error",
          "description": "Defender for Storage设置资源名称必须为current",
          "given": "[resourceType()]",
          "when": "equals('Microsoft.Security/DefenderForStorageSettings')",
          "then": {
            "assert": "equals(name, 'current')"
          }
        }
      }
    }
  }
}

2. 运行bicep lint ./your-template.bicep命令，Linter会自动检查所有资源的命名是否符合规则，不符合则输出错误信息。

4. 固化常用资源的命名模板 #

对于有固定命名要求的资源，直接在Bicep中写死或通过代码片段生成合规名称：

• 比如Defender for Storage设置资源，直接将名称设为current，无需动态生成：

resource defenderStorage 'Microsoft.Security/DefenderForStorageSettings@2022-12-01-preview' = {
  name: 'current'
  parent: storageAccount
  // 其他配置...
}

• 对于VM自动关机计划，封装成可复用的模块，模块内部自动生成合规名称，调用时只需传入VM名称即可。

内容的提问来源于stack exchange，提问作者dropsoid