【问题标题】:How to create Build Definitions through VSTS REST API如何通过 VSTS REST API 创建构建定义
【发布时间】:2018-05-14 16:12:23
【问题描述】:

情况:

我目前正在通过 bitbucket -> vsts -> azure 自动化 CI/CD 配置。

我的理想结果是能够将我的配置值复制粘贴(或手动输入)到它们各自的控制台程序中,并让应用程序配置整个 CI/CD 考验,而无需单击所有 Web 界面。现在可以在 Bitbucket 和 Azure 中使用,但通过 REST API 创建 VSTS CI/CD 配置被证明是困难的。

Azure resources 和 Bitbucket 配置当前是通过与 REST API 对话的简单 .NET 控制台应用程序创建的。基本上将所有值(azure input values/bitbucket input values)复制粘贴(或手动输入)到控制台应用程序中,它将在 5 分钟内配置所有内容。


问题:

现在我面临着尝试在 VSTS 中自动化构建配置和发布配置的困难部分。 Microsoft Docs 在documentation of VSTS client libraries 上不是很好。

老实说,我不知道如何通过 API 或客户端库create a build definition

  • BuildHttpClient 有三种我可以使用的方法:

    public virtual Task<BuildDefinition> CreateDefinitionAsync(BuildDefinition definition, Guid project, int? definitionToCloneId = null, int? definitionToCloneRevision = null, object userState = null, CancellationToken cancellationToken = default(CancellationToken));   
    public virtual Task<BuildDefinition> CreateDefinitionAsync(BuildDefinition definition, int? definitionToCloneId = null, int? definitionToCloneRevision = null, object userState = null, CancellationToken cancellationToken = default(CancellationToken));    
    public virtual Task<BuildDefinition> CreateDefinitionAsync(BuildDefinition definition, string project, int? definitionToCloneId = null, int? definitionToCloneRevision = null, object userState = null, CancellationToken cancellationToken = default(CancellationToken));
    
  • BuildDefinition 具有以下属性。

    namespace Microsoft.TeamFoundation.Build.WebApi    
    { 
    [DataContract]    
    public class BuildDefinition : BuildDefinitionReference
        {
            public BuildDefinition();
    
            public List<string> Tags { get; }
            public PropertiesCollection Properties { get; }
            public List<RetentionPolicy> RetentionRules { get; }
            public List<Demand> Demands { get; }
            public IDictionary<string, BuildDefinitionVariable> Variables { get; }
            public List<BuildTrigger> Triggers { get; }
            public ProcessParameters ProcessParameters { get; set; }
            public BuildRepository Repository { get; set; }
            public List<BuildOption> Options { get; }
            public List<BuildDefinitionStep> Steps { get; }
            public bool BadgeEnabled { get; set; }
            public int JobTimeoutInMinutes { get; set; }
            public BuildAuthorizationScope JobAuthorizationScope { get; set; }
            public string DropLocation { get; set; }
            public string Description { get; set; }
            public string Comment { get; set; }
            public string BuildNumberFormat { get; set; }
            public Build LatestBuild { get; }
            public Build LatestCompletedBuild { get; }
        }
     }
    

如您所见,构建定义的最重要属性是只读的。

如何通过 REST API 创建构建定义?是否有更好的 VSTS 替代方案可以让我这样做?


【问题讨论】:

  • 你考虑过使用 YAML 构建吗?那么您的构建定义只是源代码控制的 YAML 文件。
  • YAML 的缺点是目前不支持任务组/模板。而且它只支持TFS Git & GitHub,不支持bitbucket。 :)

标签: c# continuous-integration azure-pipelines build-definition azure-devops-rest-api


【解决方案1】:

create a build definition 的 REST API 格式如下:

POST https://{account}.visualstudio.com/{project}/_apis/build/definitions?api-version=5.0-preview.6

应用程序/json 示例:

{
    "process": {
        "phases": [
            {
                "steps": [

                ],
                "name": "Phase 1",
                "refName": "Phase_1",
                "condition": "succeeded()",
                "target": {
                    "executionOptions": {
                        "type": 0
                    },
                    "allowScriptsAuthAccessOption": false,
                    "type": 1
                },
                "jobAuthorizationScope": "projectCollection",
                "jobCancelTimeoutInMinutes": 1
            }
        ],
        "type": 1
    },
    "repository": {
        "properties": {
            "cleanOptions": "0",
            "labelSources": "0",
            "labelSourcesFormat": "$(build.buildNumber)",
            "reportBuildStatus": "true",
            "gitLfsSupport": "false",
            "skipSyncSource": "false",
            "checkoutNestedSubmodules": "false",
            "fetchDepth": "0"
        },
        "id": "4ba24767-e5a6-4987-80cc-ebaeca01fdbc",
        "type": "TfsGit",
        "name": "product1",
        "url": "https://marinaliu.visualstudio.com/Git2/_git/product1",
        "defaultBranch": "refs/heads/master",
        "clean": "false",
        "checkoutSubmodules": false
    },
    "processParameters": {},
    "drafts": [],
    "queue": {
        "id": 324,
        "name": "ownPC",
        "pool": {
            "id": 23,
            "name": "ownPC"
        }
    },
    "name": "definitionCreatedByRESTAPI",
    "type": "build",
    "queueStatus": "enabled"
}

要在 C# 中使用 REST API,您可以进行如下转换:

var personalaccesstoken = "PAT";
var base64Token = Convert.ToBase64String(Encoding.ASCII.GetBytes($":{personalaccesstoken}"));
HttpClient client = new HttpClient();
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Basic", base64Token);

var requestMessage = new HttpRequestMessage(HttpMethod.Post, "https://account.visualstudio.com/project/_apis/build/definitions?api-version=5.0-preview.6");
requestMessage.Content = new StringContent("{\"process\": {  \"phases\": [{\"steps\": [], \"name\": \"Phase 1\",\"refName\": \"Phase_1\",\"condition\": \"succeeded()\",\"target\": { \"executionOptions\": { \"type\": 0 },\"allowScriptsAuthAccessOption\": false,  \"type\": 1  },  \"jobAuthorizationScope\": \"projectCollection\", \"jobCancelTimeoutInMinutes\": 1 }],\"type\": 1  }, \"repository\": { \"properties\": { \"cleanOptions\": \"0\",\"labelSources\": \"0\",\"labelSourcesFormat\": \"$(build.buildNumber)\", \"reportBuildStatus\": \"true\",\"gitLfsSupport\": \"false\", \"skipSyncSource\": \"false\",\"checkoutNestedSubmodules\": \"false\", \"fetchDepth\": \"0\"},\"id\": \"4ba24767-e5a6-4987-80cc-ebaeca01fdbc\",\"type\": \"TfsGit\",\"name\": \"product1\", \"url\": \"https://marinaliu.visualstudio.com/Git2/_git/product1\", \"defaultBranch\": \"refs/heads/master\",  \"clean\": \"false\",\"checkoutSubmodules\": false },\"processParameters\": {}, \"drafts\": [],\"queue\": { \"id\": 324,  \"name\": \"ownPC\",\"pool\": {\"id\": 23, \"name\": \"ownPC\"}}, \"name\": \"definitionCreatedByRESTAPI\", \"type\": \"build\",\"queueStatus\": \"enabled\"}", Encoding.UTF8, "application/json");

HttpResponseMessage response = client.SendAsync(requestMessage).Result;
response.EnsureSuccessStatusCode();

C# 程序参考博客Accessing TFS/VSTS 2017 programmatically

【讨论】:

  • 是的!有效!也恰好是我的愚蠢超出了自己的预期。我不断收到 203 未授权,因为我只输入了用于读取响应的凭据,而不是与请求一起输入的凭据
  • @Mariana,如果我们想设置默认的 Azure 托管构建代理和队列,Azure DevOps 的这一部分应该是什么? “队列”:{“id”:324,“名称”:“ownPC”,“池”:{“id”:23,“名称”:“ownPC”}},
  • @Marina Liu 步骤信息如何?没有步骤的构建管道几乎毫无用处。你知道有没有办法添加它们?
  • 您可以使用 AzurePipelinePS powershell 模块获取发布定义 Get-APReleaseDefinition 作为 JSON,修改 JSON 并使用 Update-APReleaseDefintion 将其发布回来。 powershellgallery.com/packages/AzurePipelinesPS
  • 我已经在圈子里跑了 4 个小时才发现我使用的是 Git 类型而不是 tfsGit
猜你喜欢
  • 2019-08-24
  • 2020-03-30
  • 2018-05-24
  • 1970-01-01
  • 1970-01-01
  • 2018-08-23
  • 2018-10-28
  • 1970-01-01
  • 1970-01-01
相关资源
最近更新 更多