从 api 将参数传递给 devops 构建管道

Question

我无法理解我需要做什么...但我有一个构建管道...下面是我用于测试的基本脚本。
我希望能够通过 api 和 powershell 添加/更新参数。我不确定这是否是实现此目的的最佳方法，但当我手动添加参数时，它似乎运行良好。当我传递参数时，它不会粘住。任何帮助将不胜感激......即使我应该在其他地方发布我的查询。谢谢

1. 管道脚本

    variables:
       patchgroup: test
   
    jobs: 
    - template: patch-template.yml  
   
      parameters:    
        patchgroup: $(patchgroup)    
        sqlservers:      
          - sqlserver: name: ""
   

2. 补丁模板文件

   parameters:
     sqlservers: {}
     patchgroup: ''
   
   jobs:
   - ${{ each sqlserver in parameters.sqlservers }}:
     - template: patch-tasks.yml
       parameters:
         sqlserver: ${{ sqlserver.name }}
         patchgroup: ${{ parameters.patchgroup }}
   

3. 补丁任务参数：sqlserver: '' patchgroup: ''

    jobs:
      - job: 
        displayName: '${{ parameters.sqlserver }}--set-up-stuff'
        steps:
        - task: PowerShell@2
          inputs:
            targetType: 'inline'
            script: |
              Write-Host "Patchgroup '${{ parameters.patchgroup }}'"
              Write-Host "sqlserver '${{ parameters.sqlserver }}'"
   

4. powershell脚本

    $defurl = "$collectionurl/$project/_apis/build/builds?api-version=5.0"
    $json = '{"variables":  "{\"patchgroup\":  \"xyxyxyxyx\"}","definition":  {"id":  "194"}}'
    #$json = '{"parameters":"{\"sqlservers\": \"\"{\"sqlserver\":  \"servername\"}\"\"}","definition":{"id":"194"}}'
    $updatedef = Invoke-RestMethod -Uri $defurl -Method POST -Body $json -ContentType "application/json" -Headers @{Authorization=("Basic {0}" -f $base64AuthInfo)}
   

Answer 1

根据你的代码，我做了一些测试。

我注意到，运行管道时，参数的值并未设置，而是需要直接硬编码到 Yaml 文件中。

因此，当您运行管道时，您无法通过Rest API将参数传递给yaml源代码。

为了解决这个问题，可以尝试使用parameter来传递参数值。

更新：

你可以检查我的新例子：

补丁任务.yml

 jobs:
   - job: 
     displayName: '${{ parameters.sqlserver }}--set-up-stuff'
     steps:
     - task: PowerShell@2
       inputs:
         targetType: 'inline'
         script: |
           Write-Host "Patchgroup '${{ parameters.patchgroup }}'"
           Write-Host "sqlserver '${{ parameters.sqlserver }}'"

补丁模板.yml

parameters:
- name: sqlservers 
  type: object
  default: [] 

- name: patchgroup 
  type: string
  default: ''


jobs:
- ${{ each sqlserver in parameters.sqlservers }}:
  - template: patch-tasks.yml
    parameters:
      sqlserver: ${{ sqlserver }}
      patchgroup: ${{ parameters.patchgroup }}

管道脚本

trigger: none

parameters:
- name: InstanceArgs 
  type: object
  default: [] 
    
variables:
    patchgroup: test
    


jobs: 
 - template: patch-template.yml  

   parameters:    
     patchgroup: $(patchgroup)    
     sqlservers:  ${{ parameters.InstanceArgs }} 
  

当您运行管道时，您可以看到输入框。

此时，您可以在运行管道时使用Rest api传入参数值。您可以更改为使用此 Rest API：运行 - 运行管道

PowerShell 脚本示例：

$token = "PAT"

$url="https://dev.azure.com/{OrganizationNmae}/{ProjectName}/_apis/pipelines/{PipelineId}/runs?api-version=5.1-preview"

$token = [System.Convert]::ToBase64String([System.Text.Encoding]::ASCII.GetBytes(":$($token)"))

$JSON = @'
{
  


  "resources": {
    "repositories": {
      "self": {
        "refName": "refs/heads/BranchName"
      }
    }
  },
  "templateParameters": {
    "InstanceArgs":"[1,2,3]"
   },



}
'@

$response = Invoke-RestMethod -Uri $url -Headers @{Authorization = "Basic $token"} -Method Post -Body $JSON -ContentType application/json