Azure DevOps: find out which pipelines are using specific yaml template

user_11537922 0
Viewed 74

I am using Azure DevOps pipelines and I am looking for a quick way (e.g. REST API) to find out if certain yaml template is being used by any pipelines or not, and if it does, to get the name of the pipelines.

The only option I am aware of is to go through each pipeline yaml config and search for the template in question, but this is not handy when you have to deal with lots of pipelines and templates.

I couldn't find any solution neither in the documentation nor online, so I was wondering if anybody have any tips for that?

Thanks in advance!

azure-rest-api azure-template azure-pipelines-yaml azure-pipelines azure-devops
3 Answers

I've managed to achieve this using the Azure REST API and python. You will need to create a PAT on Azure DevOps to authenticate the API and replace the {PAT} in the code. You would also need to replace {organization} and {project} with the values of your organisation and project

# import the required python packages
import requests
import base64
import pandas as pd

# Use PAT token to authenticate connection to Azure
pat = '{PAT}'
authorization = str(base64.b64encode(bytes(':'+pat, 'ascii')), 'ascii')

headers = {
    'Accept': 'application/json',
    'Authorization': 'Basic '+authorization
}

# Connect to azure to obtain a full list of pipelines
response = requests.get(
    url="https://dev.azure.com/{organization}/{project}/_apis/pipelines/?api-version=6.0-preview.1", headers=headers)

# Save this list as a JSON variable
json_object = response.json()

# Create a blank df to populate information
df = pd.DataFrame(columns=['pipeline_name','yml_path'])

# iterate over the json object to get full details about the pipeline
for item in json_object['value']:
    url= "https://dev.azure.com/{organization}/{project}/_apis/pipelines/" + str(item['id']) + "?api-version=6.0-preview.1"
    response = requests.get(url=url, headers=headers, verify=False)
    jsonObject = response.json()
    # if pipeline type is yaml then add the pipeline name and yaml path to the dataframe
    if jsonObject['configuration']['type'] == 'yaml':
        df = pd.concat([pd.DataFrame([[jsonObject['name'],jsonObject['configuration']['path']]], columns=df.columns), df], ignore_index=True)

# create a filepath to save the df as a csv file
filepath = r'C:\path\filename.csv'

# Save the df to csv
df.to_csv(filename, index=False)

You can then either use the csv file to analyse if the template is being used and in which pipeline. Or you can use python to perforn similar analysis on the dataframe

user_189092140

Thanks for the tips guys,

I've also figured out that if you just do a simple search for the template name in the Project Search bar, it lists all the pipeline yaml files which are referencing the template.

Project Search bar

user_115379220

You can quickly get a list of pipeline names and their yaml files by running this PowerShell snippet in a terminal:

NOTE: Requires PowerShell, Azure CLI and Azure DevOps extension for Azure CLI

az pipelines list | ConvertFrom-Json | ForEach-Object {
    Write-Host $_.name -ForegroundColor Green
    az pipelines show --id $_.id --query process | ConvertFrom-Json | Format-List
}
user_6110560
Related