通过Azure DevOps Rest API启动构建并传递变量

Question

通过Azure DevOps Rest API启动构建并传递变量

azure-devopsazure-pipelinesazure-devops-rest-api

15

我想通过REST API启动Azure Pipelines构建。有一个API用于排队构建，但是我找不到定义变量的方法。

- Pascal Berger

5个回答

3

变量包含在定义中，您可以通过构建定义API更新构建定义以设置变量，然后排队构建。

以下是通过构建定义API获取的变量部分：

  "variables": {
    "system.debug": {
      "value": "false",
      "allowOverride": true
    },
    "BuildConfiguration": {
      "value": "release",
      "allowOverride": true
    },
    "BuildPlatform": {
      "value": "any cpu",
      "allowOverride": true
    }
  },

- Eddie Chen - MSFT

2

谢谢，先设置变量然后再排队可能是一个可行的解决方案。但这会在每次运行时更改构建定义并且混乱历史记录。由于可以在UI中排队构建时设置变量，如果REST API也具有相同的功能将是很好的。 - Pascal Berger

传递变量对我来说似乎并没有像广告中宣传的那样有效。 - Jeff Patton

如果您想连续调用此API多次，使用此选项可能效果不佳，因为在调用队列构建之前，您可能无法将其保存。我需要连续调用它50次，并每次使用不同的参数。因此，即使它不太美观，我也会使用被接受的答案。 - PHPGuru

1

对于任何寻找此内容的人，我能够使用'templateParameters'使其在7.1版本中工作，它允许您发送一个Object而不是String。

方法：POST
网址：https://dev.azure.com/{organization}/{project}/_apis/build/builds?api-version=7.1-preview.7

请求体：JSON 示例：

{
  "sourceBranch":"Development",
  "definition": {
    "id": 5
  }
  "templateParameters": {
    "PARAMETER1": "value1",
    "parameter2": "valuex"
  }
}

文档：https://learn.microsoft.com/zh-cn/rest/api/azure/devops/build/builds/queue?view=azure-devops-rest-7.1

- Mauro

我们如何在Shell脚本中访问参数？ - Jerin Joy

这对我也起作用。我之前遇到了一个问题，无法直接通过参数实现这个功能。但是通过使用TemplateParamaters，我能够通过Azure DevOps的REST API版本7.0将参数传递给另一个流水线，并将其排队。 - Sowmya

1

对于那些遇到问题的人（我就是），自接受答案以来使用的API有所不同（对我来说根本不起作用）。但是按照Cyprien Autexier的建议，我看了一下底层代码（Firefox开发工具），我注意到该门户网站不再使用Builds API。它使用了Pipelines API (https://learn.microsoft.com/en-us/rest/api/azure/devops/pipelines/runs/run-pipeline?view=azure-devops-rest-6.1)。使用这个API后，一切都运行得很顺畅。

- Tiago Veiga Lázaro

0

看起来它可以在5.1版本中使用。您需要做的就是将传递给管道的变量定义为管道变量中的参数，并确保选中“可在队列时间设置”复选框。如果您在任何库中具有相同的变量，请确保删除这些引用，因为库变量被视为覆盖通过API设置的变量。

请注意，我使用的是Azure Devops Server 2019

API: https://learn.microsoft.com/en-us/rest/api/azure/devops/build/builds/queue?view=azure-devops-rest-5.1

导航到设置变量：编辑YAML管道-->单击“运行”按钮附近的3个点-->变量-->变量选项卡

希望对某人有所帮助

- Sibi JV

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- Cyprien Autexier · Accepted Answer

当您需要在队列时间设置值时，被接受的答案并没有真正回答问题。解决方案实际上非常简单，您只需向json有效负载添加一个parameters字段即可。内容应该是一个JSON字符串（不是直接的对象），其中包含参数。例如：

{
    "parameters":  "{\"ReleaseNumber\":  \"1.0.50\", \"AnotherParameter\":  \"a value\"}",
    "definition":  {
                       "id":  2
                   }
}

编辑：该功能现已被明确记录为“可选的字符串化字典”。请参见https://www.visualstudio.com/fr-fr/docs/integrate/api/build/builds#queue-a-build