如何为AzureResourceManagerTemplateDeployment@3正确使用YAML变量文件

问题描述 #

希望通过YAML变量文件替代ARM参数文件，实现多个Bicep部署任务复用变量，同时避免流水线任务中重复定义变量，但部署时出现以下错误：

There was an error while overriding 'tags' parameter because of 'SyntaxError: Unexpected end of JSON input', make sure it follows JavaScript Object Notation (JSON)

相关代码内容：

vars.yml #

rsgName: "rsg1"
location: "westus"
tags: |
  {
  "tag1": "tagA",
  "tag2": "tagB"
  }

deploy.yml #

- task: AzureResourceManagerTemplateDeployment@3
    inputs:
      deploymentScope: 'Subscription'
      azureResourceManagerConnection: ${{ parameters.azureServiceConnection }}
      subscriptionId: ${{ variables.subId }}
      templateLocation: 'Linked artifact'
      csmFile: ./template.bicep
      overrideParameters: >
        -rsgName ${{ variables.rsgName }}
        -location ${{ variables.location }}
        -tags ${{ variables.tags }}
      deploymentMode: 'Validation'

template.bicep #

param rsgName string
param location string

targetScope = 'subscription'

resource resourceGroup 'Microsoft.Resources/resourceGroups@2021-04-01' = {
  name: rsgName
  location: location
  tags: tags
}

错误原因 #

1. tags变量格式问题：用|定义的多行字符串包含换行和缩进，传递给部署任务时会被解析成不合法的JSON（换行和多余空格破坏了JSON结构）。
2. Bicep参数缺失：模板中未定义tags参数，直接在资源中引用tags会导致参数未找到的问题。
3. 参数传递未转义：JSON字符串中的特殊字符（如冒号、逗号）在overrideParameters中未被正确包裹，会被流水线任务误解析。

正确语法与解决方案 #

方案一：修正变量格式与参数传递 #

1. 调整vars.yml中的tags变量：将多行JSON改为单行合法JSON字符串，避免换行和多余空格：

rsgName: "rsg1"
location: "westus"
tags: '{"tag1": "tagA", "tag2": "tagB"}'

2. 修正deploy.yml的参数传递：用单引号包裹tags变量，防止特殊字符被误解析：

- task: AzureResourceManagerTemplateDeployment@3
    inputs:
      deploymentScope: 'Subscription'
      azureResourceManagerConnection: ${{ parameters.azureServiceConnection }}
      subscriptionId: ${{ variables.subId }}
      templateLocation: 'Linked artifact'
      csmFile: ./template.bicep
      overrideParameters: >
        -rsgName ${{ variables.rsgName }}
        -location ${{ variables.location }}
        -tags '${{ variables.tags }}'
      deploymentMode: 'Validation'

3. 完善Bicep模板：添加tags参数，类型设为object：

param rsgName string
param location string
param tags object = {} // 可选设置默认值

targetScope = 'subscription'

resource resourceGroup 'Microsoft.Resources/resourceGroups@2021-04-01' = {
  name: rsgName
  location: location
  tags: tags
}

方案二：用YAML对象转JSON（更易维护） #

如果希望tags变量在YAML中保持对象格式（便于编辑），可以在流水线中转换为JSON字符串：

1. 修改vars.yml为YAML对象：

rsgName: "rsg1"
location: "westus"
tags:
  tag1: "tagA"
  tag2: "tagB"

2. 在流水线中添加转换步骤（以Azure DevOps为例）：

- pwsh: |
    $tagsJson = ${{ convertToJson(variables.tags) }}
    Write-Host "##vso[task.setvariable variable=tagsJson]$tagsJson"
  displayName: 'Convert tags to JSON'

- task: AzureResourceManagerTemplateDeployment@3
    inputs:
      deploymentScope: 'Subscription'
      azureResourceManagerConnection: ${{ parameters.azureServiceConnection }}
      subscriptionId: ${{ variables.subId }}
      templateLocation: 'Linked artifact'
      csmFile: ./template.bicep
      overrideParameters: >
        -rsgName ${{ variables.rsgName }}
        -location ${{ variables.location }}
        -tags '$(tagsJson)'
      deploymentMode: 'Validation'

3. Bicep模板保持方案一的修改（添加tags参数）。

补充说明 #

• 若需要在多个流水线任务中复用变量，可将vars.yml作为变量组导入（Azure DevOps中支持），或用template关键字引用该文件。
• 传递复杂类型参数时，确保JSON格式严格合法，无多余换行、空格，且用引号包裹避免解析错误。

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