使用 REST Api 的 TFS 2015 队列新构建 - 设置需求

Question

我正在尝试使用 TFS 2015.3 REST API 对新构建进行排队，我关注了许多文章但无法使其正常工作。

我在 PowerShell 中执行此操作，标准队列新构建调用仅在传递定义 ID 时有效，但传递除 id 之外的任何其他内容似乎都不起作用。

我的代码：

$buildDef = Invoke-RestMethod -Method Get -UseDefaultCredentials -Uri "$($tfsRoot)/_apis/build/definitions?api-version=2.0&name=$buildDefintionName"        

        $detailedResults = Invoke-RestMethod -Uri $buildDef.Value[0].Url -Method Get -ContentType "application/json" -UseDefaultCredentials

        if ($buildDef.Value[0].Id)
        {
            $agentDemandString = "Agent.Name -equals $agent"
            $demands = $detailedResults.Demands

            $json = "definition: { id:$($buildDef.Value[0].Id) }, demands: $demands" 
            $bodyjson = $json | ConvertTo-Json
            Write-Host "Queuing build $buildDefintionName on agent $agent with parameters $json"
            $build = Invoke-RestMethod -Method Post -UseDefaultCredentials -ContentType application/json -Uri "$($tfsRoot)/_apis/build/builds?api-version=2.0" -Body $bodyjson
        }

我尝试了许多不同的传递要求的变体，但看起来它甚至没有达到那一点，因为它抱怨“构建”参数。

Invoke-RestMethod : {"$id":"1","innerException":null,"message":"值不能为空。\r\n参数名称: build","typeName":"System.ArgumentNullException , mscorlib, 版本=4.0.0.0, 文化=中性

如果我是对的，构建参数包含要执行的构建步骤。这让我认为排队构建正在删除所有现有配置并试图仅依赖于 JsonBody 中传递的内容，这当然不是我想要的。

我应该传递什么以及如何传递才能将新构建排队但有更新/额外的需求。

Answer 1

尝试设置深度：

$bodyjson = $json | ConvertTo-Json -Depth 3

Answer 2

$json = "definition: { id:$($buildDef.Value[0].Id) }, demands: $demands" 不会是有效的 JSON——例如，它不会被包裹在花括号中。

我建议创建一个可以正确转换为有效 JSON 的关联数组。 documentation 中提供的 JSON 示例为：

{
  "definition": {
    "id": 25
  },
  "sourceBranch": "refs/heads/master",
  "parameters": "{\"system.debug\":\"true\",\"BuildConfiguration\":\"debug\",\"BuildPlatform\":\"x64\"}"
}

所以这会生成一个合适的 JSON 对象：

$body = @{
    definition = @{ id=25 }
    sourceBranch = 'refs/heads/master'
    parameters = '{\"system.debug\":\"true\",\"BuildConfiguration\":\"debug\",\"BuildPlatform\":\"x64\"}'
} 

$body | convertto-json

或者，如果您想更加花哨并消除内部 JSON-as-a-string 位：

$body = @{
    definition = @{ id=25 }
    sourceBranch = 'refs/heads/master'
    parameters = (@{'system.debug' = $true; BuildConfiguration='debug'; BuildPlatform='x64'}) | convertto-json -Compress
} 

$body | convertto-json

Answer 3

根据我的测试，我们无法直接使用队列构建 REST Api 设置需求。

构建仍将使用定义中设置的代理，即使我们在对构建进行排队时指定了具有“需求”集的其他代理。您可以使用 REST API 检查这一点，下面的屏幕截图供您参考。

并使用 REST API 进行构建，例如：

GET http://SERVER:8080/tfs/CollectionLC/6debd6ea-fa97-4ea2-b0c0-3cbbc4afa802/_apis/build/Builds/1071/

您可以看到，响应中不包含“需求”。它仅出现在构建定义响应中。

实际上，“需求”是在构建定义中设置的，它只是针对构建定义。当使用 REST API 对构建进行排队时，它只会触发构建定义。因此，如果您想使用 REST API 触发特定代理的构建，您需要先更新定义（设置需求），然后触发构建定义。

要更新定义，请使用 REST API：请参阅 Update a build definition

PUT https://{instance}/DefaultCollection/{project}/_apis/build/definitions/{definitionId}?api-version={version}

因此，您可以编写脚本来更新构建定义，然后使用构建定义 ID 触发构建。

Answer 4

我终于在一些帮助下让它工作了。接受 Demands 属性。 由于带有 Json 转换的 powerShell 代码，它似乎无法正常工作。如果我在下面使用并且不将其转换为 Json，它可以工作！

Function queuebuild{ 

      $uri="$($tfsRoot)/_apis/build/builds?api-version=2.0"

      $body='{
                 "definition": {
                 "id": 1061
                 },
                    "sourceBranch": "$/Project/Branch",
                    "demands":["Demand1", "Agent.Name -equals Computer2-E-A2"]
                 }';

        $result=Invoke-RestMethod -Uri $uri -Method Post -ContentType "application/json" -UseDefaultCredentials -Body $body

}