> ## Documentation Index
> Fetch the complete documentation index at: https://docs.blinkops.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 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.

<Note>
  External Documentation

  To learn more, visit the [Azure DevOps documentation](https://learn.microsoft.com/en-us/rest/api/azure/devops/pipelines/preview/preview?view=azure-devops-rest-7.1).
</Note>

## Basic Parameters

<div className="integrations-table">
  | Parameter    | Description                                                                                                                                                                                                                                                                                                                                            |
  | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
  | Organization | The Azure DevOps Organization. You can view the Organizations list in the [Azure DevOps Organizations page](https://portal.azure.com/#blade/AzureTfsExtension/OrganizationsTemplateBlade).                                                                                                                                                             |
  | Pipeline ID  | The 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.<br />You can find the desired project by navigating to the [Azure DevOps Projects page](https://portal.azure.com/#view/HubsExtension/BrowseResource/resourceType/Microsoft.DevCenter%2Fprojects). |
  | Project      | The Project ID or Project name. You can view the Projects list in the [Azure DevOps Projects page](https://portal.azure.com/#view/HubsExtension/BrowseResource/resourceType/Microsoft.DevCenter%2Fprojects).                                                                                                                                           |
</div>

## Advanced Parameters

<div className="integrations-table">
  | Parameter           | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
  | ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | Pipeline Version    | The 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.<br />You can find the desired project by navigating to the [Azure DevOps Projects page](https://portal.azure.com/#view/HubsExtension/BrowseResource/resourceType/Microsoft.DevCenter%2Fprojects).                                                                                                                           |
  | Preview Run         | If true, don't actually create a new run. Instead, return the final YAML document after parsing templates.                                                                                                                                                                                                                                                                                                                                                                                |
  | Stages To Skip      | Allows to specify one or more stages of the pipeline to skip during a preview run.                                                                                                                                                                                                                                                                                                                                                                                                        |
  | Template Parameters | Allows to pass parameters to a pipeline template during a preview run.<br />Here are some examples of template parameters:<br /><br />\* environment - specifies the environment that the pipeline will be run in. For example Environment=production.<br />\* branchName - specifies the branch of the code repository that the pipeline will be run against. For example branchName=test.<br />\* debug - Enable or disable debug mode during the pipeline run. For example debug=true. |
  | Variables           | Pass custom configuration settings, such as database connection strings, API keys, or other runtime settings that are required for the pipeline to execute successfully.<br />The syntax will look like the following:<br /><br />`<variable_name>=<variable_value>`<br /><br />For example:<br />databaseConnectionString=myserver<br />database=mydatabase.                                                                                                                             |
  | Yaml Override       | Override the pipeline configuration defined in the repository.                                                                                                                                                                                                                                                                                                                                                                                                                            |
</div>

## Example Output

```json theme={"dark"}
{
	"finalYaml": "string"
}
```

## Workflow Library Example

[Preview Run with Azure Devops and Send Results Via Email](https://library.blinkops.com/workflows/preview-run-with-azure-devops-and-send-results-via-email)

<div className="iframe-wrapper">
  <div className="iframe-media">
    <img src="https://mintcdn.com/blinkops-2/ojHYuDeYX5FWuN8a/img/Icons/play-box.svg?fit=max&auto=format&n=ojHYuDeYX5FWuN8a&q=85&s=b8af968e71438a9499c3223c9bd29fb2" alt="Workflow Library" width="16" height="16" data-path="img/Icons/play-box.svg" />

    Preview this Workflow on desktop
  </div>

  <iframe className="iframe" src="https://library.blinkops.com/workflows/preview-run-with-azure-devops-and-send-results-via-email/canvas" />
</div>