Sådan bruger du Azure DevOps API til at få den samlede byggetid (i minutter) for en Build Agent Pool. Hvis du har brug for at rulle tilbage fra den købte agent til den gratis version, denne guide vil hjælpe dig.
Azure DevOps er en populær platform til styring af softwareudviklingsprocesser. Med sin REST API, udviklere kan interagere med platformen programmæssigt og automatisere opgaver såsom build og release management. I denne tutorial, vi vil demonstrere, hvordan man bruger Azure DevOps API til at få den samlede byggetid (på minutter) for en byggeagentpulje inden for et angivet datointerval. Vi vil give trin-for-trin instruktioner og bruge Python til at lave API-anmodninger.
Trin:
- Få en Azure DevOps Personligt adgangstoken (KLAPPE) Inden vi starter, vi skal have en Azure DevOps PAT, som vi vil bruge til at autentificere vores API-anmodninger. For at oprette en PAT, gå til dine Azure DevOps-organisationsindstillinger og klik på “Personlige adgangstokens”. Følg instruktionerne for at oprette et nyt token med “Byg (Læs)” omfang.
- Set up a Python environment We will be using Python to make our API requests. If you don’t have Python installed, you can download it from the official website (https://www.python.org/downloads/). We also recommend using a virtual environment to manage your Python dependencies. To set up a virtual environment, run the following commands in your terminal:
pip install virtualenv
virtualenv venv
source venv/bin/activate
- Install the requests library We will be using the
requests
library to make our API requests. To install it, kør følgende kommando:
pip install requests
- Define the API endpoint The API endpoint we will be using is:
https://{username}:{pat}@dev.azure.com/{organization}/{project}/_apis/build/builds?api-version=7.0
Replace {username}
, {pat}
,{organization}
og {project}
with your actual organization and project names.
- Make the API request To get the total build time for a build agent pool within a specified date range, we need to use the
minTime
ogmaxTime
query parameters in our API request. We also need to filter the build results by the build agent pool. Here’s an example Python script that makes the API request and calculates the total build time (på minutter):
pip install python-dateutil requests
import requests
from dateutil.parser import parse
# Set up variables for the API request
organization = "<Organization Name>"
project = "Project Name"
queue_id = "9"
min_time = "2023-04-01"
max_time = "2023-04-05"
# you can leave username as user
username = "user"
pat = "<PAT>"
# Construct the API URL
url = f"https://{username}:{pat}@dev.azure.com/{organization}/{project}/_apis/build/builds?api-version=7.0&minTime={min_time}&maxTime={max_time}&$filter=queue.id eq {queue_id}&$orderby=startTime asc"
# Send the API request
response = requests.get(url)
# Parse the response JSON
json_response = response.json()
# Retrieve the count of build runs
count = json_response["count"]
# Calculate the total build time in seconds
total_build_time = 0
for build in json_response["value"]:
start_time = parse(build["startTime"])
finish_time = parse(build["finishTime"])
duration = finish_time - start_time
total_build_time += duration.total_seconds()
# Convert the total build time to minutes
total_build_time_minutes = total_build_time / 60
print(f"Number of build runs: {count}")
print(f"Total build time: {total_build_time_minutes:.2f} minutes")
Output example:
Number of build runs: 35
Total build time: 122.19 minutes