Azure DevOps变量组PUT接口PowerShell调用失败问题排查

问题原因分析 #

1. 缺少项目引用信息：项目级变量组更新时，请求体必须包含projectReference字段，否则Azure DevOps无法识别变量组所属项目，触发"Project information name is not valid for variable group"错误。
2. 哈希表遍历方式错误：直接对$variableGroup.variables使用ForEach-Object无法正确遍历哈希表键值对，导致部分变量的Key/Value被误判为null，出现"Skipping variable with null key or value"警告。

修正后的脚本 #

# Parameters
$organization = "nprod"
$project = "APM"
$pat = "shgksdghiddsfgdertwetrweghdhfgkhsd"  # Your PAT token
$variableGroupName = "Test-Variable-group"
$outputValue = "DaaS"

# Headers for API requests
$headers = @{
    "Content-Type"  = "application/json"
    "Authorization" = "Basic " + [Convert]::ToBase64String([Text.Encoding]::ASCII.GetBytes(":$($pat)"))
}

# Get the list of variable groups to find the ID
$uri = "https://dev.azure.com/$organization/$project/_apis/distributedtask/variablegroups?api-version=6.0-preview.2"
$response = Invoke-RestMethod -Uri $uri -Method Get -Headers $headers
$variableGroup = $response.value | Where-Object { $_.name -eq $variableGroupName }

if ($null -eq $variableGroup) {
    Write-Error "Variable group '$variableGroupName' not found."
    exit 1
}

$variableGroupId = $variableGroup.id

# Construct the body for the update
# Fix: Use GetEnumerator() to correctly iterate over the variables hash table
$existingVariables = @{}
$variableGroup.variables.GetEnumerator() | ForEach-Object {
    if ($_.Key -ne $null -and $_.Value -ne $null) {
        $existingVariables[$_.Key] = $_.Value
    } else {
        Write-Warning "Skipping variable with null key or value."
    }
}

# Add or update the specific variable
$existingVariables["stoppedCjobs"] = @{
    value = $outputValue
}

# Fix: Add projectReference from the original variable group to the request body
$body = @{
    id = $variableGroupId
    name = $variableGroupName
    type = "Vsts"
    variables = $existingVariables
    projectReference = $variableGroup.projectReference  # 新增项目引用字段
} | ConvertTo-Json -Depth 10

# Update the variable group
$uri = "https://dev.azure.com/$organization/$project/_apis/distributedtask/variablegroups/$variableGroupId?api-version=7.2-preview.2"
try {
    $response = Invoke-RestMethod -Uri $uri -Method Put -Headers $headers -Body $body
    Write-Output "Variable group updated successfully."
} catch {
    Write-Error "Failed to update variable group: $_"
}

关键修改点说明 #

• 修复变量遍历逻辑：使用GetEnumerator()方法遍历$variableGroup.variables哈希表，确保正确获取每个变量的键和值，消除警告。
• 添加项目引用字段：在请求体中加入projectReference = $variableGroup.projectReference，直接复用原变量组的项目关联信息，解决"Project information name is not valid"错误。
• 新增异常捕获：用try/catch包裹更新请求，便于更清晰地查看错误详情。

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