用于运行构建或管道的 Azure REST API

Question

我正在尝试使用 REST API 为特定分支自动创建 Azure Pipelines。

但是，我很难使用他们的几乎所有 API，因为他们的文档缺乏示例。

像 List 和 Get 这样的东西很简单。

但是，当涉及到对构建进行排队时: https://learn.microsoft.com/en-us/rest/api/azure/devops/build/builds/queue?view=azure-devops-rest-6.0

POST https://dev.azure.com/{organization}/{project}/_apis/build/builds?api-version=6.0
{
    "parameters": <parameters>, // how do i send paramters
    "definition": {
        "id": 1
    },
    "sourceBranch": "refs/heads/feature/my-pipeline",
    "sourceVersion": "d265f01aeb4e677a25725f44f20ceb3ff1d7d767"
}

我目前正在努力发送参数。我尝试过:

简单的 JSON，例如:

"parameters": {
    "appId": "bab",
    "platform": "android",
    "isDemo": true
}

以及 JSON 的字符串化版本，例如:

"parameters": "{\"appId\": \"bab\",\"platform\": \"android\",\"isDemo\": true}"

但似乎都不起作用。

它一直给我错误:

{
    "$id": "1",
    "customProperties": {
        "ValidationResults": [
            {
                "result": "error",
                "message": "A value for the 'appId' parameter must be provided."
            },
            {
                "result": "error",
                "message": "A value for the 'platform' parameter must be provided."
            },
            {
                "result": "error",
                "message": "A value for the 'isDemo' parameter must be provided."
            }
        ]
    },
    "innerException": null,
    "message": "Could not queue the build because there were validation errors or warnings.",
    "typeName": "Microsoft.TeamFoundation.Build.WebApi.BuildRequestValidationFailedException, Microsoft.TeamFoundation.Build2.WebApi",
    "typeKey": "BuildRequestValidationFailedException",
    "errorCode": 0,
    "eventId": 3000
}

文档对于如何发送此数据非常不清楚:https://learn.microsoft.com/en-us/rest/api/azure/devops/build/builds/queue?view=azure-devops-rest-6.1#propertiescollection

非常感谢您的帮助。

Answer 1

我相信您无法通过队列 API 传递运行时参数。相反，使用 Runs API

这样，您的请求正文(使用 Content-type: application/json)应类似于以下内容:

{
    "resources": {
        "repositories": {
            "self": {
                "refName": "refs/heads/feature/my-pipeline"
            }
        }
    },
    "templateParameters": {
        "appId": "bab"
        "platform": "android"
        "isDemo": true
    }
}