如何使用Azure DevOps REST API创建新的构建流水线？

Question

我正试图通过编程创建新的构建流水线。我正在寻找Azure DevOps REST API来执行此操作，但我没有找到使用REST API创建流水线的合适示例。请给予建议。

- Kumaresh Babu N S

Answer 1

如何使用Azure DevOps REST API创建新的构建流水线？

要创建新的构建流水线，我们可以使用REST API Definitions - Create：

POST https://dev.azure.com/{organization}/{project}/_apis/build/definitions?api-version=5.0

但是我们需要在请求体中提供太多信息，这将是一个庞大的项目且容易出错。这也是文档没有提供示例请求体的原因。

为了解决这个问题，通常我们会使用REST API Definitions - Get 从模板管道获取响应主体。

GET https://dev.azure.com/{organization}/{project}/_apis/build/definitions/{definitionId}?api-version=5.0

然后，我们只需要通过修改响应正文来更新相应的属性。

现在，我们获取了新管道的新请求正文，我们可以使用 REST API Definitions - Create 来创建一个新管道。

您可以查看 this thread 以获取更多详细信息。 更新：

创建构建定义后，它会像 Azure Repos 一样创建 azure-pipelines.yml 文件并存储在存储库中吗？

不，如果您想使用REST API创建一个YAML类型的构建定义，它将不会在我们的代码库中创建相应的YAML文件，因为此API“Definitions - Create”仅将请求主体发送到流水线而不操作我们的代码库。目前，它支持创建链接到Git存储库中YAML文件的构建定义。如果您想自动创建yaml，可以查看REST API Pushes - Create。

这就是REST API“Definitions - Create”需要改进以支持YAML流水线的地方。您可以在我们的UserVoice网站（https://developercommunity.visualstudio.com/content/idea/post.html?space=21）上添加您对此功能的请求，该网站是我们的主要产品建议论坛。感谢您帮助我们构建更好的Azure DevOps。

希望这有所帮助。

- Leo Liu

---

谢谢！有没有REST API来运行管道？ - Kumaresh Babu N S

请问您能否提供创建新构建流水线所必需的属性？ - Kumaresh Babu N S

@KumareshBabuNS，是的，我们可以通过这个REST API排队管道：https://learn.microsoft.com/zh-cn/rest/api/azure/devops/build/Builds/Queue?view=azure-devops-rest-5.0&viewFallbackFrom=vsts-rest-4.1，您可以查看此线程以获取一些详细信息：https://dev59.com/3FUL5IYBdhLWcg3wWG1I。 - Leo Liu

创建构建定义后，它是否会像Azure Repos一样创建azure-pipelines.yml文件并存储在代码库中？ - Kumaresh Babu N S

在创建 YAML 管道时，为什么必须使用构建定义端点而不是管道端点？ - Rye bread

Answer 2

我知道这个问题很老了，但我想分享一下我在2023年使用PowerShell自动将DevOps从本地迁移到Azure DevOps（云）时是如何做的。我们的代码库中有基于yaml的构建文件（azure-pipelines.yml）。

我发现创建基于yaml的构建（流水线）所需提交的正文应该是以下JSON：

{
"configuration": {
    "path": "azure-pipelines.yml",
    "repository": {
        "id": "YourRepoGUID",
        "type": "azureReposGit"
    },
    "type": "yaml"
},
"name": "WHATEVER_YOU_WANT_HERE"

}

我正在使用VSTeam PS Module来帮助在PowerShell中很好地封装API调用。

首先，我们使用Set-VSTeamAccount、Set-VSTeamApiVersion和Set-VSTeamDefaultProject设置团队、API和项目。我使用Get-VSTeamGitRepository获取存储库ID，更新JSON片段中的名称和存储库ID，然后使用InvokeVSTeamRequest提交一个POST请求来创建。我找不到Add-VSTeamPipeline，也无法让Add-VSTeamBuildDefinition工作，而且它需要一个文件。我已经为经典构建（基于GUI/非YAML）使用了Add-VSTeamBuildDefinition，所以我知道它对这些构建有效。

Set-VSTeamAccount <your settings>
Set-VSTeamApiVersion AzD2019U1
Set-VSTeamDefaultProject <your project>

$repoId = Get-VSTeamGitRepository -Name <yourreponame> | select -ExpandProperty id

$buildJson = '{"configuration": {"path": "azure-pipelines.yml","repository": {"id": "","type": "azureReposGit"},"type": "yaml"},"name": ""}'

$jsonObj = ConvertFrom-Json $buildJson
$jsonObj.configuration.repository.id = $repoId
$jsonObj.name = "<YourNamingConvention>"
$jsonRaw = $jsonObj | ConvertTo-Json -Compress

$buildDefMeta = Invoke-VSTeamRequest -resource pipelines -version '7.0' -method Post -body $jsonRaw -JSON | ConvertFrom-Json

- Kevin LaBranche