Skip to main content

Preview Run

Simulate the execution of a pipeline run without actually running it. This can be useful for testing and validation purposes, allowing you to identify and resolve issues in your pipeline configuration before deploying it to a production environment.

External Documentation

To learn more, visit the Azure DevOps documentation.

Basic Parameters

ParameterDescription
OrganizationThe Azure DevOps Organization. You can view the Organizations list in the Azure DevOps Organizations page.
Pipeline IDThe unique identifier of the pipeline. You can find the Pipeline ID by navigating to the Pipelines tab of the project where the pipeline is defined.
You can find the desired project by navigating to the Azure DevOps Projects page.
ProjectThe Project ID or Project name. You can view the Projects list in the Azure DevOps Projects page.

Advanced Parameters

ParameterDescription
Pipeline VersionThe version of the pipeline configuration. You can find the Pipeline version by navigating to the Pipelines tab of the project where the pipeline is defined.
You can find the desired project by navigating to the Azure DevOps Projects page.
Preview RunIf true, don't actually create a new run. Instead, return the final YAML document after parsing templates.
Stages To SkipAllows to specify one or more stages of the pipeline to skip during a preview run.
Template ParametersAllows to pass parameters to a pipeline template during a preview run.
Here are some examples of template parameters:

environment - specifies the environment that the pipeline will be run in. For example Environment=production.
branchName - specifies the branch of the code repository that the pipeline will be run against. For example branchName=test.
* debug - Enable or disable debug mode during the pipeline run. For example debug=true.
VariablesPass custom configuration settings, such as database connection strings, API keys, or other runtime settings that are required for the pipeline to execute successfully.
The syntax will look like the following:

<variable_name>=<variable_value>

For example:
databaseConnectionString=myserver
database=mydatabase.
Yaml OverrideOverride the pipeline configuration defined in the repository.

Example Output

{
"finalYaml": "string"
}

Workflow Library Example

Preview Run with Azure Devops and Send Results Via Email

Workflow LibraryPreview this Workflow on desktop