在PowerShell中使用Azure DevOps REST API更新构建定义

Question

我试图通过PowerShell脚本使用REST API更新我在Azure DevOps中的构建定义...

$header = @{Authorization = 'Basic ' + [Convert]::ToBase64String([Text.Encoding]::ASCII.GetBytes(":$($personalAccessToken)"))}
$definitions = Invoke-RestMethod -Uri "https://devops.domain.com/Collection/Project/_apis/build/definitions" -Method GET -Header $header
$branchNames = 'master', 'feature'

ForEach ($definition in $definitions.value) {
    $definition | Add-Member -NotePropertyName triggers -NotePropertyValue (@{ triggerType = 'continuousIntegration'; branchFilters = $branchNames | % {"+refs/heads/$_/*"} }) -Force

    $body = $definition | ConvertTo-Json
    Write-Host $body

    Invoke-RestMethod -Uri "https://devops.domain.com/Collection/Project/_apis/build/definitions/$($definition.id)?api-version=5.0" -Method PUT -ContentType application/json -Body $body -Header $header
}

如何使用PowerShell和REST API实现这一点？

Answer 1

triggers是数组，所以您不能只编辑它，您需要编辑triggers[0]，就像编辑branchfilters一样，您需要编辑branchfilters[0]。此外，您不需要在triggertype中进行触摸。

以上所有这些都是假设构建中已经有一个触发器，并且您想要编辑它，而不是添加一个新的触发器部分。

在BranchFilters数组中还有一个棘手的问题，如果只有1个分支（例如master)，并且要添加另一个分支，则需要将其添加到数组中，而不仅仅是编辑BranchFilters[0]值。

最后应该修正的是分支的值，它应该是+refs/heads/branchname，而不仅仅是分支名。

因此，我有一个带有test分支触发器的管道，并成功地使用以下脚本将触发器编辑为master和feature/*：

# I get only one definition and update him, not iterate all my definitions
$definition = Invoke-RestMethod -Uri $url -Method Get

# Change the branch trigger from "test" to "master"
$definition.triggers[0].branchFilters[0] = "+refs/heads/master"

# Add another branch trigger - "feature/*"
$definition.triggers[0].branchFilters[0] += "+refs/heads/feature/*"

$body = $definition | ConvertTo-Json -Depth 10
Write-Host $body

Invoke-RestMethod -Uri $url -Method Put -ContentType application/json -Body $body