Azure Data Factory REST API调用无法传递参数问题排查

问题描述 #

我正在编写一个用于触发Azure Data Factory（ADF）管道执行的简单PowerShell脚本，代码片段如下：

$callUri = "https://management.azure.com/subscriptions/$($Config.subId)/resourceGroups/$($config.azRg)/providers/Microsoft.DataFactory/factories/$($config.factoryName)/pipelines/$pipeName/createRun?api-version=2018-06-01"
Write-Host $callUri
$headers = @{
    Authorization = "Bearer $AccessToken" 
    Content       = 'application/json'
}

$body = "{""param1"":""abc""}"

$ret = Invoke-RestMethod -Method Post -Uri $callUri -Headers $headers -Body $pipeParams
return  $ret 

目前遇到的问题是：Azure端已成功执行管道，但参数值未被传入。

错误分析与修复 #

你的代码存在三个关键问题，导致参数无法正确传入：

1. 变量引用错误 #

你定义了存储参数内容的变量$body，但调用Invoke-RestMethod时传入的是未定义的$pipeParams，相当于没有传递任何参数内容。

2. 请求头字段错误 #

请求头中指定内容类型的字段应该是Content-Type，而不是Content，ADF服务无法识别错误的头字段，会忽略请求体中的参数。

3. ADF接口参数格式不符合要求 #

ADF的createRun接口要求管道参数必须嵌套在parameters对象下，而不是直接使用顶层键值对。

修正后的完整代码 #

$callUri = "https://management.azure.com/subscriptions/$($Config.subId)/resourceGroups/$($config.azRg)/providers/Microsoft.DataFactory/factories/$($config.factoryName)/pipelines/$pipeName/createRun?api-version=2018-06-01"
Write-Host $callUri
$headers = @{
    Authorization  = "Bearer $AccessToken" 
    "Content-Type" = 'application/json'
}

# 按照ADF要求的格式构造参数，嵌套在parameters对象中
$body = @"
{
    "parameters": {
        "param1": "abc"
    }
}
"@

$ret = Invoke-RestMethod -Method Post -Uri $callUri -Headers $headers -Body $body
return $ret 

额外建议 #

• 建议使用PowerShell的ConvertTo-Json来构造JSON请求体，避免手动拼接字符串出现转义错误，示例如下：

$bodyObject = @{
    parameters = @{
        param1 = "abc"
    }
}
$body = $bodyObject | ConvertTo-Json

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