如何在PowerShell脚本中获取ADO Webhook传递的工作项数据？

核心思路 #

当ADO Service Hook通过REST API触发流水线时，触发请求的完整内容会被ADO自动存入流水线的内置环境变量SYSTEM_HOOKREQUEST_BODY中，你只需要在PowerShell脚本中读取该变量并解析JSON格式的内容，就能访问工作项数据。

具体实现步骤 #

1. 读取钩子请求体
   直接通过环境变量获取Service Hook传递的原始JSON数据：

   $hookRequestBody = $env:SYSTEM_HOOKREQUEST_BODY
   

2. 验证并解析JSON
   先检查是否获取到数据，再将JSON转换为PowerShell可操作的对象：

   # 检查数据是否存在
   if (-not $hookRequestBody) {
       Write-Error "未接收到Service Hook传递的数据"
       exit 1
   }
   
   # 解析JSON，捕获解析错误
   try {
       $hookData = $hookRequestBody | ConvertFrom-Json -ErrorAction Stop
   } catch {
       Write-Error "JSON解析失败: $_"
       exit 1
   }
   

3. 访问工作项数据
   根据ADO工作项更新事件的默认结构，工作项的详细信息存储在resource字段下，你可以按需提取字段：

   # 获取工作项对象
   $workItem = $hookData.resource
   
   # 输出关键信息（示例，可根据实际字段调整）
   Write-Host "工作项ID: $($workItem.id)"
   Write-Host "标题: $($workItem.fields.'System.Title')"
   Write-Host "当前状态: $($workItem.fields.'System.State')"
   Write-Host "更新人: $($workItem.fields.'System.ChangedBy'.displayName)"
   

调试与排查 #

• 如果不确定数据结构，先打印原始请求体内容，查看实际字段路径：

  Write-Host "原始请求体:`n$hookRequestBody"
  

• 检查环境变量是否存在：如果SYSTEM_HOOKREQUEST_BODY为空，确认触发流水线的是Service Hook，而非手动触发或其他方式：

  # 列出所有包含HOOK的环境变量
  Get-ChildItem Env: | Where-Object Name -match "HOOK"
  

• 确认Service Hook配置：确保事件类型为「工作项更新」，且请求已正确关联目标流水线。

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