How to Retrieve Pipeline Task Details in Azure DevOps with the REST API

Learn how to extract detailed agent job task information from Azure DevOps pipelines using REST APIs. Get insights into your YAML and classic UI pipelines efficiently.
---
This video is based on the question https://stackoverflow.com/q/66677537/ asked by the user 'Heber Solis' ( https://stackoverflow.com/u/7582111/ ) and on the answer https://stackoverflow.com/a/66684110/ provided by the user 'Jane Ma-MSFT' ( https://stackoverflow.com/u/14026068/ ) at 'Stack Overflow' website. Thanks to these great users and Stackexchange community for their contributions.

Visit these links for original content and any more details, such as alternate solutions, latest updates/developments on topic, comments, revision history etc. For example, the original title of the Question was: Is there a way to get agent job taks of a pipeline?

Also, Content (except music) licensed under CC BY-SA https://meta.stackexchange.com/help/licensing
The original Question post is licensed under the 'CC BY-SA 4.0' ( https://creativecommons.org/licenses/by-sa/4.0/ ) license, and the original Answer post is licensed under the 'CC BY-SA 4.0' ( https://creativecommons.org/licenses/by-sa/4.0/ ) license.

If anything seems off to you, please feel free to write me at vlogize [AT] gmail [DOT] com.
---
How to Retrieve Pipeline Task Details in Azure DevOps with the REST API

If you're working with Azure DevOps, you might have encountered situations where you need to extract detailed information from your pipelines. Specifically, you may want to access the tasks associated with a pipeline, such as PowerShell scripts that run as part of those tasks. The challenge is: Is there a way to retrieve the agent job tasks of a pipeline?

In this post, we'll explore how you can achieve this using Azure DevOps REST APIs, focusing on both YAML pipelines and classic UI pipelines. Let's dive in!

Understanding the Challenge

Many users of Azure DevOps find themselves wanting more insight into their pipelines. This includes details about individual tasks within those pipelines, such as:

Scripts running via PowerShell tasks

Configuration settings of each task

Dependencies among tasks

While the official Azure DevOps documentation does not provide a dedicated REST API endpoint for retrieving tasks directly, there are ways to access this information using the developer console in web browsers.

Accessing Task Details in Azure DevOps

1. Retrieving YAML Pipeline Tasks

To extract information from a YAML pipeline, you can use the following REST API endpoint:

[[See Video to Reveal this Text or Code Snippet]]

How to Use:

Replace {organization} and {project} with your Azure DevOps organization name and project name, respectively.

Substitute {pipeline id} with the ID of your specific pipeline.

Response Handling:
When you hit this endpoint, you will receive a comprehensive response. Here’s where the relevant information can be located:

Navigate through the response object to find your YAML content at this path:

fps->dataProviders->data->ms.vss-build-web.pipeline-editor-data-provider->content

2. Retrieving Classic UI Pipeline Tasks

For classic UI pipelines, you can access task information using this endpoint:

[[See Video to Reveal this Text or Code Snippet]]

Usage Steps:

Similar to the YAML endpoint, replace {organization}, {project}, and {pipeline id} with the appropriate values for your setup.

Where to Find Task Information:
For classic UI pipelines, once you receive the response, locate your task details at this path:

fps->dataProviders->data->ms.vss-ciworkflow.ciworkflow.webpage.data-provider->buildDefinition->process->phases->steps

Conclusion

Extracting task details from Azure DevOps pipelines can initially seem daunting, especially due to the lack of official REST API documentation for such specific queries. However, by leveraging the developer tools in your web browser to inspect network requests, you can effectively get the information you need.

With the provided API endpoints and response handling tips, you can now retrieve details of YAML and classic UI pipeline tasks. This supplemental information can help you better understand and manage your Azure DevOps pipelines, leading to more efficient automation and deployment processes. If you have any more questions about Azure DevOps or need further assistance, feel free to reach out!

Видео How to Retrieve Pipeline Task Details in Azure DevOps with the REST API канала vlogize