Azure Pipeline中如何持久化更新SerialNumber变量值？

问题原因 #

你之前用PowerShell任务更新变量的方式，仅能修改当前流水线运行时的变量值，并不会同步更新Azure DevOps界面中存储的流水线持久化变量，所以每次重新触发流水线时，变量会回到初始值000000。

解决方案：通过Azure DevOps REST API持久化更新变量 #

要实现变量的持久化递增，必须通过调用Azure DevOps的REST API修改流水线的变量定义，以下是具体步骤：

1. 准备个人访问令牌（PAT） #

• 登录Azure DevOps，进入用户设置→个人访问令牌（Personal Access Tokens）。
• 新建令牌，勾选Build权限下的Edit选项，生成后保存好令牌内容（仅显示一次）。
• 在流水线的「变量」界面，添加一个秘密变量（比如命名为AZURE_DEVOPS_PAT），将刚才生成的PAT填入，确保变量勾选「保密」选项。

2. YAML流水线配置示例 #

在你的流水线YAML中添加如下任务，实现变量递增并持久化更新：

steps:
  # 步骤1：获取当前SerialNumber变量值并计算递增后的值
  - task: PowerShell@2
    name: UpdateSerialNumber
    inputs:
      targetType: 'inline'
      script: |
        # 提取组织、项目、流水线ID信息
        $orgName = "$(System.CollectionUri)" -replace 'https://dev.azure.com/',''
        $projectName = "$(System.TeamProject)"
        $pipelineId = "$(System.DefinitionId)"
        $pat = "$(AZURE_DEVOPS_PAT)"
        $base64AuthInfo = [Convert]::ToBase64String([Text.Encoding]::ASCII.GetBytes(":$($pat)"))
        
        # 调用API获取当前流水线的变量定义
        $apiUrl = "$(System.CollectionUri)$projectName/_apis/build/definitions/$pipelineId?api-version=7.1-preview.7"
        $pipelineDef = Invoke-RestMethod -Uri $apiUrl -Headers @{Authorization=("Basic {0}" -f $base64AuthInfo)} -Method Get
        
        # 定位SerialNumber变量并计算新值
        $serialVar = $pipelineDef.variables | Where-Object { $_.name -eq "SerialNumber" }
        $currentValue = $serialVar.value
        $newValue = [int]$currentValue + 1
        # 格式化新值为6位补零格式（如000001）
        $newValueFormatted = $newValue.ToString("D6")
        
        # 更新变量值并提交到流水线定义
        $serialVar.value = $newValueFormatted
        $updateResponse = Invoke-RestMethod -Uri $apiUrl -Headers @{Authorization=("Basic {0}" -f $base64AuthInfo)} -Method Put -Body ($pipelineDef | ConvertTo-Json -Depth 100) -ContentType "application/json"
        
        # 设置当前运行时变量供后续任务使用
        Write-Host "##vso[task.setvariable variable=SerialNumber;]$newValueFormatted"
        Write-Host "已更新SerialNumber为: $newValueFormatted"

  # 步骤2：验证更新后的变量（可选）
  - task: PowerShell@2
    name: ShowUpdatedVariable
    inputs:
      targetType: 'inline'
      script: |
        Write-Host "当前运行时SerialNumber值: $(SerialNumber)"

3. 关键说明 #

• API版本：示例中使用的7.1-preview.7为稳定预览版，可根据Azure DevOps版本调整为最新稳定版API。
• 变量格式化：通过ToString("D6")确保递增后的值始终保持6位数字，不足位数时自动补零。
• 权限控制：确保PAT拥有Build Edit权限，否则API调用会返回权限错误。
• 安全规范：PAT必须存储为秘密变量，禁止明文写在YAML中。

验证效果 #

触发流水线后，查看Azure DevOps流水线的「变量」界面，SerialNumber的值会自动递增；下次触发流水线时，会基于更新后的值继续累加，实现持久化的自动递增逻辑。

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