Getting the complete list of Repository names and details in Azure DevOps Project and Publishing as a CSV file using ADO Pipeline

 Author: Akhil M Anil || DevOps Engineer

Getting the complete list of Repository names in Azure DevOps Project using REST Api and Publishing as a CSV file

Representational State Transfer (REST) APIs are service endpoints that support sets of HTTP operations (methods), which provide create, retrieve, update, or delete access to the service's resources.

This article covers creating a REST API call pipeline in Azure DevOps to access the Repos and retrieve the list of all Repositories created and publish the list as a csv file.


Full code can be found in GitHub: Azure-DevOps/Repos-List

Nb: For authenticating to ADO, we are using PAT token. Ref: Use personal access tokens - Azure DevOps | Microsoft Learn 

Steps:

  • Push the developed pipeline (azure-pipelines-repos.yml) code and python (repos.py) code to Azure Repos.
    • If you have an existing PAT token use the PAT and make sure the PAT token has access to list the Repository list, if not create a PAT token and use the PAT token.
    • Create a Variable Group for storing PAT token as secret

    • We are using Repositories - List - REST API to fetch the repository list using python. For that we need to authorize to access the resources in ADO by using PAT token.
    • The above code can be used to authorize and access the resources/services in ADO
  • Create an ADO pipeline using the azure-pipelines-repos.yml. 
    • Navigate to 'Pipelines' in Azure DevOps. Select 'Create Pipeline' or 'New Pipeline' to create a new pipeline.





  • Run the pipeline
    • Pipeline will authenticate with ADO using PAT token and fetch the API results and publish as an artifact.



Perfect! We got the list of Repositories in our ADO project!



Comments

Post a Comment

Popular posts from this blog

Install Java silently using powershell in Azure Windows VM

Image
Written by Akhil M Anil . To install Java silently using PowerShell in Windows VM, follow the following steps: Downloading Java can be done in two ways:   Download your required Java version ( Java Downloads | Oracle ) to a folder in your Windows VM.     Use PowerShell to Download Java to a folder.  Follow the below steps for downloading Java through PowerShell : Initially copy the Download link for your required Java version, Java file name, and Location where you want to download Java in your VM to a notepad Open PowerShell  Run the following command in PowerShell $url = "<your-copied url>" $filename = "<file_name>" $dest = "<outputfile-location\$filename>" Invoke-WebRequest -Uri $url -OutFile $dest For Example:  $url = "https://download.oracle.com/java/18/latest/jdk-18_windows-x64_bin.exe" $filename = "jdk-18_windows-x64_bin.exe"  $dest = "C:\Users\akhilanil\Desktop\Java\$filename" Invoke-WebRequest -Uri
Read more

Usage of Variable Template in Azure DevOps Pipelines

Image
  Author: Akhil M Anil || DevOps Engineer Let's understand what variables in Azure DevOps are:  Variables give us a convenient way to get key bits of data into various parts of the pipeline. The most common use of variables is to define a value that we can then use in our pipeline. The value of a variable can change from run to run or job to job in your pipeline. Different types of variables are: User-defined variables System variables Environment variables User-defined Variables The variables defined by the user are called user-defined variables. In YAML pipelines, we can set variables at the root, stage, and job levels. We can use a variable group to make variables available across multiple pipelines or we can use templates to define variables that are used in multiple pipelines in one file. In this blog, we will discuss variables defined in a template file and create a simple pipeline for getting variables from the variable template.  Advantages of using Variable Templates over
Read more

List of Repositories - Authorize Rest API calls using Job Access Token

Image
  Author: Akhil M Anil || DevOps Engineer Getting the complete list of Repository names  in Azure DevOps Project using REST Api and Publishing as a CSV file. In the last blog I have talked about Authorizing REST API call using Job Access Tokens. If missed, please find that blog here:  Job Access Tokens . In this blog we will use Job Access Token to Authorize Rest API call and retrieve the list of repositories.  Full code can be found in GitHub:  Repository-List Steps: Push the developed pipeline code  (azure-pipelines-repos.yml) and python code  (repos.py) to Azure Repos. We are using  Repositories - List - REST API  to fetch the repository list using python. Job Authorization Scope for Job Access token. In order to access repositories using system access token, we need to change our default job authorization scope. In my last blog I have already mentioned about Job Authorization Scopes, feel free to take a look.  To set job authorization scope at the organization level for all projec
Read more