ODBC Driver for Azure DevOps

Build 22.0.8479


Runs a pipeline with the specified configuration.

Stored Procedure Specific Information

Running a Pipeline

Azure DevOps pipelines require a lot of configuration to be run from the REST API. For this reason, the Resources, Variables, StagesToSkip, and TemplateParameters inputs must be provided as JSON inputs. This can be achieved through temporary tables:

INSERT INTO resources#TEMP([resources.repositories.self.refName]) VALUES ('refs/heads/main')
INSERT INTO variables#TEMP([variables.HELLO_WORLD.value], [variables.HELLO_WORLD.isSecret]) VALUES ('HelloWorldValue', false)
EXEC RunPipeline @ProjectId='TestProjectReview', @PipelineId=2, @variables='variables#TEMP', @resources='resources#TEMP'

Or by providing the JSON bodies of each element directly:

EXEC RunPipeline @ProjectId='TestProjectReview', 
				 @variables='{"HELLO_WORLD": {"isSecret": false, "value": "HelloWorldValue"}}', 
				 @resources='{"repositories": {"self": {"refname": "refs/heads/main"}}}', 


Name Type Required Description
ProjectId String True Id or name of the project.
PipelineId Integer True Id of the pipeline.
PipelineVersion Integer False The version of the pipeline to run.
Resources String False The resources the run requires.
Variables String False The list of variables and values for use during pipeline execution.
StagesToSkip String False Array of stage names to skip.
TemplateParameters String False Key-Value map of parameter values for use during pipeline execution.

Result Set Columns

Name Type Description
State String Current state of pipeline execution on server.
RunId String Id of generated Run object.
RunName String Name of generated Run object.
RunHref String Link to generated Run object.
CreatedDate Datetime Creation date of generated Run object.

Copyright (c) 2023 CData Software, Inc. - All rights reserved.
Build 22.0.8479