如何在Azure自定义脚本扩展中传递Terraform变量至PowerShell

1. 修复脚本编码问题 #

这是最常见的触发原因：PowerShell脚本如果保存为带BOM的UTF-8格式，Azure自定义脚本扩展执行时会把开头的BOM字符解析成乱码（也就是你看到的?Param）。

• 用VS Code打开脚本，点击右下角编码标识，切换为**UTF-8无BOM（UTF-8 without BOM）**后保存。
• 或者用PowerShell命令批量转换编码：

  Get-Content .\your-script.ps1 -Encoding UTF8 | Set-Content .\your-script-fixed.ps1 -Encoding UTF8NoBOM
  

2. 规范Terraform变量传递方式 #

确保变量传递时的命令行格式正确，避免解析错误：

正确配置示例 #

假设你要传递var.target_value到脚本的TargetParam参数：

resource "azurerm_virtual_machine_extension" "custom_script" {
  name                 = "CustomScriptExtension"
  virtual_machine_id   = azurerm_windows_virtual_machine.vm.id
  publisher            = "Microsoft.Compute"
  type                 = "CustomScriptExtension"
  type_handler_version = "1.10"

  settings = jsonencode({
    "commandToExecute" = "powershell -ExecutionPolicy Unrestricted -File ./deploy-script.ps1 -TargetParam ${var.target_value}"
    "fileUris"         = ["https://your-storage-blob-url/deploy-script.ps1"]
  })
}

• 如果变量包含空格、引号等特殊字符，用urlencode()处理避免命令行解析失败：

  "commandToExecute" = "powershell -ExecutionPolicy Unrestricted -File ./deploy-script.ps1 -TargetParam ${urlencode(var.target_value)}"
  

3. 验证脚本参数定义 #

确保PowerShell脚本的参数定义无多余字符：

param(
    [string]$TargetParam
)

# 后续业务逻辑
Write-Host "Received parameter: $TargetParam"

注意param关键字前不能有任何不可见字符或乱码，空行也要确保干净。

4. 调试排查技巧 #

• 把Terraform生成的commandToExecute命令复制到本地PowerShell执行，复现并定位错误。
• 查看Azure VM上的扩展日志：Windows路径为C:\WindowsAzure\Logs\Plugins\Microsoft.Compute.CustomScriptExtension\，Linux路径为/var/log/azure/Microsoft.Compute.CustomScriptExtension/，日志会记录完整的执行过程和错误详情。

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