Skip to main content

Azure DevOps REST API with Python

Working within the UI on Azure DevOps is great, but I prefer some code to get the job done. Working with a REST API allows you the ability to interact with Azure DevOps within your application.

At the time of writing, the Azure DevOps REST API is on version 5.1.

Pre-requisites:

1. Pycharm or VSCode.
2. An Azure DevOps account.
3. A PAT token (admin rights to Azure DevOps required).


The first thing we want to do is take a look at the REST API itself. Head over to https://docs.microsoft.com/en-us/rest/api/azure/devops/?view=azure-devops-rest-5.1



If you take a look on the left side, you'll see multiple pieces of documentation. You can interact with Azure DevOps via any of those API's. Today we're going to focus on the Build API.


If you click on the link above, you'll see a few different operations. The first piece of code we're going to write is for retrieving the builds. This would be a GET request. 

Open up Pycharm or VSCode and lets write some code! 

The first thing we'll need to do is import some libraries;

import requests
from requests.auth import HTTPBasicAuth
import logging
import getpass

Let's go over each of these;

requests = A library for API calls (GET, POST, DELETE, etc.)
requests.auth = Authentication for your API call
logging = Logger for specifying errors, warnings, info, etc.
getpass = A secure way to pass in your password (in our case the PAT token). It will not show as plain text.

Now we can start taking a look at our core code. Let's build a function called buildAPI.

def buildAPI(uri, username):



Within our function we'll create a variable for calling our PAT token.

p = getpass.getpass(prompt='Please enter PAT token: ')

Next we'll create our try/except blocks (For more info on error handling, please visit: https://realpython.com/python-exceptions/)

try:
    resp = requests.get(uri, auth=HTTPBasicAuth(username, p))
    print(resp.text)

except Exception as e:
    logging.error(e)

Let's talk about what we're doing above;

1. The first line is starting out try block for error handling purposes
2. The second line is our variable to call our requests library and the get() method. We're passing in our uri and auth. The uri we're getting from our params and the same goes for our username.
3. The third line is to print the response. In our case it's the JSON output of our builds.
4. The forth and fifth line is if any errors occur, print our the errors to our console.



You have successfully used a GET request to retrieve your builds!

Comments

Popular posts from this blog

Run PowerShell code with Ansible on a Windows Host

Ansible is one of the Configuration Manager kings in the game. With it's easy-to-understand syntax and even easier to use modules, Ansible is certainly a go-to when you're picking what Configuration Management you want to use for your organization. Your question may be "but Ansible is typically on Linux and what happens when I'm in a Windows environment?". Luckily I'm here to tell you that Ansible will still work! I was pleasantly surprised with how easy it is to use Ansible on Windows with a little WinRM magic. Let's get started.

Pre-requisites for this post:
1) WinRM set up to connect to your Windows host from Ansible
2) Ansible set up for Windows Remote Management
3) SSH access to the Ansible host
4) Proper firewall rules to allow WinRM (port 5985) access from your Ansible host to your Windows host
5) Hosts file set up in Ansible that has your IP or hostname of your Windows Server.
6) At least one Linux host running Ansible and one Windows Server host …

Running PowerShell commands in a Dockerfile

As Docker continues to grow we are starting to see the containerization engine more and more on Windows. With the need for containers on Windows, we also need the same automation we get in Linux with Dockerfiles. Today we're going to create a Dockerfile that runs PowerShell cmdlets.
Prerequisites; 1. Docker for Windows
2. A code editor (VSCode preferred)

Let's go ahead and get our Dockerfile set up. Below is the Dockerfile I used for this post.

from mcr.microsoft.com/windows/servercore:1903 MAINTAINER Michael Levan RUN powershell -Command Install-WindowsFeature -Name Web-Server RUN powershell -Command New-Item -Type File -Path C:\ -Name config
As you can see from the above, this is a tiny Dockerfile. What this will do is install the IIS Windows 

Feature and create a new file in C:\ called "config".
You should see something very similar to the below screenshot;

Next let's create a running container out of our image. First we'll need to run docker container ls to

 get o…

DevOps tooling in the Microsoft realm

When I really started to dive into automation and practicing DevOps with specific tooling, there were a few key players. At the time Microsoft was not one of them. They were just starting to embrace the open source world, including the art and practice of DevOps. Since then Microsoft has went all in and the tech giant has made some incredible tooling. Recently I switched to a Microsoft-heavy environment and I love it. I went from AWS/Python/Ansible/Jenkins to Azure/PowerShell/ARM/Azure DevOps. My first programming language was PowerShell so being back in the saddle allowed me to do a full circle between all of the different types of tooling in both worlds. Today I want to share some of that tooling with you.

The first thing I want to talk about is ARM. What is ARM? ARM is a configuration management tool that allows you to perform software-defined-infrastructure. Much like Ansible and Terraform, ARM allows you to define what you want your environment to look like at scale. With ARM, yo…