使用GitHub Actions部署Synapse代码时覆盖参数不生效问题

你的脚本存在两处关键问题导致覆盖参数不生效，修正后即可正常更新参数：

1. JSON语法错误 #

OverrideArmParameters内的JSON格式不符合规范，存在两处语法问题：

• 第二行键值对末尾缺少逗号："synapsedev196-WorkspaceDefaultSqlServer_connectionString" : "" 需改为"synapsedev196-WorkspaceDefaultSqlServer_connectionString" : "",
• 最后一行键值对多了末尾逗号："AzureDataLakeStorage1_properties_typeProperties_url": "https://adlstr16.dfs.core.windows.net/", 需改为"AzureDataLakeStorage1_properties_typeProperties_url": "https://adlstr16.dfs.core.windows.net/"

2. YAML缩进错误 #

environment、CLIENTID等参数属于with块的子参数，需要和TargetWorkspaceName等参数保持同级缩进，当前缩进过多会导致这些参数被识别为OverrideArmParameters的内容，action无法正确读取。

修正后的完整脚本 #

name: workspace deployment
on:
  push:
    branches: [ workspace_publish ]
jobs:
  release:
    runs-on: windows-latest
    steps:
      - uses: actions/checkout@v3
      - uses: azure/synapse-workspace-deployment@release-1.0
        with:
          TargetWorkspaceName: 'synapseprod196'
          TemplateFile: ./synapsedev196/TemplateForWorkspace.json
          ParametersFile: ./synapsedev196/TemplateParametersForWorkspace.json
          OverrideArmParameters: |
              {
                "workspaceName": "synapseprod196",
                "synapsedev196-WorkspaceDefaultSqlServer_connectionString" : "",
                "AzureDataLakeStorage1_accountKey": "",
                "synapsedev196-WorkspaceDefaultStorage_properties_typeProperties_url": "https://adlstr16.dfs.core.windows.net",
                "AzureDataLakeStorage1_properties_typeProperties_url": "https://adlstr16.dfs.core.windows.net/"
              }
          environment: 'Azure Public'
          CLIENTID : ''
          CLIENTSECRET : ''
          resourceGroup: 'SynDev'
          subscriptionId: ''
          tenantId: ''
          DeleteArtifactsNotInTemplate: 'true'
          managedIdentity: 'False'

额外验证要点 #

• 确认OverrideArmParameters中的参数名称与TemplateParametersForWorkspace.json内的参数名完全一致（包括大小写、下划线、连字符），名称不匹配会导致覆盖失效
• 敏感信息如CLIENTSECRET建议存储在GitHub Secrets中，通过${{ secrets.YOUR_SECRET_NAME }}引用，避免明文泄露
• 可通过VSCode等工具的JSON校验功能，提前确认OverrideArmParameters内的JSON格式正确

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