Queue a pipeline with parameters

[CDA0]

Environment

Node version: 12.9.1
Npm version: 6.10.2
OS and version: macOS Catalina
azure-devops-node-api version: 10.1.1

Issue Description

When attempting to trigger a build pipeline with paramaters like so:

const build = {
      definition: {
        id,
      },
      sourceBranch: 'refs/heads/my-branch',
      parameters: JSON.stringify({
        requiredParamA: 'paramA',
        requiredParamB: 'paramB',
        requiredParamC: 'paramC',
      }),
    };

    const out = await this.buildApi.queueBuild(build, this.project);
    console.log(out);

I get the following error:

{"statusCode":400,"result":{"$id":"1","customProperties":{"ValidationResults":[{"result":"error","message":"A value for the 'requiredParamA' parameter must be provided."},{"result":"error","message":"A value for the 'requiredParamB' parameter must be provided."},{"result":"error","message":"A value for the 'requiredParamC' 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}}

It seems that the parameters in the Build interface are maybe variables?

azure-devops-node-api/api/interfaces/BuildInterfaces.ts

Line 226 in dcf730b

* The parameters for the build.

For now I am using this which seems to work:

const build = {
      resources: {
        repositories: {
          self: {
            refName: `refs/heads/${refName}`,
          },
        },
      },
      templateParameters,
    };
    const url = `${this.orgUrl}/${this.project}/_apis/pipelines/${definitionId}/runs`;
    const reqOpts = {
      acceptHeader: 'application/json;api-version=5.1-preview.1',
    };
    return this.buildApi.rest.create(url, build, reqOpts);

Expected behaviour

A build pipeline should be queued.

Actual behaviour

Validation errors on the request

Steps to reproduce

See above

Logs

See above

[stephenmichaelf]

Hello! Did you try to inspect the HTTP request you're sending out and make sure the body is formed correctly? You can also try making the HTTP request directly then comparing the two to see the difference.

[CDA0]

my working example, obtained from inspecting ADO hits ${this.orgUrl}/${this.project}/_apis/pipelines/${definitionId}/runs

where the one in buildApi hits ${this.orgUrl}/${this.project}/_apis/pipelines/${definitionId}/builds.

There is also this issue in the cli extension which is similar Azure/azure-devops-cli-extension#972

[stephenmichaelf]

@mjroghelia This likely requires regenerating the library.

[JasonWhall]

+1 would be good to get the library re-generated to include templateParameters in the interface so we can use this in downstream projects as well without having to rely on just calling the REST API directly. Assuming this is an "internal task" to update the code with a new API schema?

[logyball]

+1. I ran into this today as well. I would love to see the templateParameters in the interface so as to not have to use the REST API directly.

[bergmeister]

@stephenmichaelf Can we please get the library updated. This block various consumers, the az CLI issue here has 19 votes and is blocked on this library.

[mjroghelia]

This turned out to be more than just needing the client updated. The build endpoints themselves need support for templateParameters added. I'm doing that now and will update this client once the service changes roll out.

[cveld]

There is also a related question raised on Stack Overflow: https://stackoverflow.com/questions/60852825/azure-devops-yaml-pipeline-parameters-not-working-from-rest-api-trigger

Interestingly recently the pipelines/runs API got added to the documentation: https://docs.microsoft.com/en-us/rest/api/azure/devops/pipelines/runs/run%20pipeline?view=azure-devops-rest-6.0

@mjroghelia If I understand your action correctly, you will be extending the build/queue API. Will you also add the pipelines/runs API to the library? The latter looks low hanging fruit to me. Could you explain when to choose the one over the other?

[wbin666]

+1, and I see it in API 6.1 preview now.
https://docs.microsoft.com/en-us/rest/api/azure/devops/build/builds/queue?view=azure-devops-rest-6.1

[github-actions]

This issue has had no activity in 90 days. Please comment if it is not actually stale