Azure CLI中PowerShell调用az rest命令的JSON引号问题解析

在使用Azure CLI的az rest命令时，许多开发者会遇到一个常见但容易被忽视的问题：当通过PowerShell传递JSON请求体时，双引号会被意外剥离，导致API调用失败。本文将深入分析这一问题的根源，并提供多种解决方案。

问题现象

开发者在尝试使用az rest命令调用Azure成本管理的Scheduled Actions API时，遇到了"Invalid property in the request"的错误。有趣的是，同样的JSON请求体通过PowerShell的Invoke-RestMethod却能正常工作。

错误信息显示服务端无法识别请求中的属性，这表明JSON格式在传输过程中已被破坏。经过分析，这实际上是PowerShell与命令行参数解析交互时产生的经典问题。

问题根源

在PowerShell环境下执行az rest命令时，JSON字符串中的双引号会被PowerShell解释器处理。具体来说：

1. PowerShell首先解析$jsonString变量并移除双引号
2. 处理后的字符串再传递给az命令
3. Azure CLI接收到的已经是格式不正确的JSON

这种参数传递过程中的引号剥离现象，不仅影响az rest命令，也是许多命令行工具在PowerShell环境下的共性问题。

解决方案

1. 使用文件输入方式（推荐）

最可靠的解决方案是将JSON内容保存到临时文件中，然后通过@filename语法引用：

$jsonObject | ConvertTo-Json -Depth 10 | Out-File "temp.json"
az rest --method put --url "${baseUrlCreateScheduledAction}?api-version=${apiVersion}" --body @temp.json
Remove-Item "temp.json"

这种方法完全避免了PowerShell对JSON内容的任何处理，确保原始JSON格式被完整传递。

2. 使用单引号包裹JSON

对于简单场景，可以用单引号包裹JSON字符串：

az rest --method put --url "${baseUrlCreateScheduledAction}?api-version=${apiVersion}" --body '$jsonString'

但这种方法在JSON本身包含单引号时会出现问题，且不推荐用于复杂JSON结构。

3. 转义双引号

可以手动转义JSON中的所有双引号：

$escapedJson = $jsonString -replace '"', '\"'
az rest --method put --url "${baseUrlCreateScheduledAction}?api-version=${apiVersion}" --body $escapedJson

这种方法虽然可行，但增加了代码复杂度，容易出错。

最佳实践建议

1. 对于复杂JSON请求，始终优先使用文件输入方式
2. 在PowerShell脚本中，对az命令的参数传递保持警惕
3. 开发过程中，可使用--debug参数输出实际发送的请求内容
4. 考虑将常用API调用封装为PowerShell函数，隐藏实现细节

总结

Azure CLI的az rest命令是一个强大的工具，但在PowerShell环境下使用时需要注意参数传递的特殊性。理解PowerShell的参数解析机制，选择适当的JSON传递方式，可以避免许多隐性问题。文件输入法是最可靠、最安全的解决方案，特别适合生产环境使用。