Trigger a YAML pipeline using C# Azure DevOps SDK

Question

I want to trigger a YAML release pipeline via C# code. I am able to achieve this using the below REST API from Postman. However, Azure DevOps provides its own SDK for such purposes. How can I trigger a YAML release pipeline using the .NET SDK instead of calling the plain API from C#?

I need C#/.NET alternative to:

POST https://dev.azure.com/Dev/modernization/_apis/pipelines/30/runs?api-version=7.2-preview.1

BODY:

{
    "previewRun": false,
    "resources": {
        "repositories": {
            "self": {
                "repository": {
                    "id": "PartsUnlimited",
                    "type": "azureReposGit"
                },
                "refName": "refs/heads/feature/branch4",
                "version": "aaaaabbbbbbe6a1b2d7904b110zzzzzaaa400000"
            }
        },
        "pipelines": {
            "source_build" : {
                "pipeline": {
                    "name": "tfvc-build"
                },
                "version": "4972"
            }
        }
    },
    "stagesToSkip": [
        "Stage_Test1"
    ],
    "templateParameters" : {
        "number_A" : "2",
        "number_B" : "4"
    }
}

Yeah, I've really tried to find the appropriate method to run the pipeline that supports passing resources, parameters, and stagesToSkip, similar to how it's done in the above REST API. Tbh, I can't seem to find it. I'm able to find the BuildHttpClient.QueueBuildAsync Method, but I can't see any Resources property where I can provide the artifact pipeline build number — osim_ans
– osim_ans, Commented May 6, 2024 at 18:52

Bright Ran · Accepted Answer · 2024-05-07 07:53:55Z

4

Below is a sample of C# code to run pipeline using .NET client libraries. You can reference it to write your code.

using Microsoft.Azure.Pipelines.WebApi;
using Microsoft.VisualStudio.Services.Common;
using Microsoft.VisualStudio.Services.WebApi;

. . .

public static void runPipeline(string orgName, string projName, int pipID, string pat)
{
    try {
        var orgUrl = new Uri($"https://dev.azure.com/{orgName}");
        VssConnection connection = new VssConnection(orgUrl, new VssBasicCredential(string.Empty, pat));

        RepositoryResourceParameters repoResParam = new RepositoryResourceParameters();
        repoResParam.Version = "xxxxxx";
        repoResParam.RefName = "refs/heads/xxxx";

        PipelineResourceParameters pipeResParam = new PipelineResourceParameters();
        pipeResParam.Version = "xxxx";

        RunPipelineParameters runParam = new RunPipelineParameters();
        runParam.PreviewRun = false;
        runParam.StagesToSkip.Add("Stage_Test1");
        runParam.TemplateParameters.Add("number_A", "2");
        runParam.TemplateParameters.Add("number_B", "4");
        runParam.Resources.Repositories.Add("self", repoResParam);
        runParam.Resources.Pipelines.Add("source_build", pipeResParam);

        PipelinesHttpClient pipClient = connection.GetClient<PipelinesHttpClient>();
        var result = pipClient.RunPipelineAsync(runParam, projName, pipID).Result;
        var runNum = result.Name;
        var runID = result.Id.ToString();
        Console.Write($"Successfully run pipeline! \r\n  Run Name: {runNum} \r\n  Run ID: {runID}");
    }
    catch(Exception ex) { 
        Console.Write(ex.ToString());
    }
}

answered May 7, 2024 at 7:53

Bright Ran

15.2k1 gold badge14 silver badges29 bronze badges

Sign up to request clarification or add additional context in comments.

4 Comments

osim_ans Over a year ago

Thanks, I'll try it.. How did you get it? :) I'm finding it difficult to locate this class in the SDK documentation...

osim_ans Over a year ago

This worked!! Could you please share link to documentation about this method?

Rui Jarimba Over a year ago

@osim_ans search for PipelinesHttpClient

osim_ans Over a year ago

Yep, tried already, It looks like there is no documentation for this method specifically :(

Collectives™ on Stack Overflow

Trigger a YAML pipeline using C# Azure DevOps SDK

1 Answer 1

4 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

4 Comments

Your Answer

Sign up or log in

Post as a guest

Related