advancedgeneral

How do you implement Azure DevOps REST APIs to automate project setup, pipeline creation, and reporting?

⚡

Quick Answer

Azure DevOps exposes a comprehensive REST API covering all services. Teams use it to automate project provisioning, create pipelines programmatically, configure branch policies, generate custom dashboards, and integrate with external tools using PATs or OAuth tokens for authentication.

Detailed Answer

Think of the Azure DevOps REST API like the plumbing behind the walls of a house. The UI (faucets and fixtures) is what most people see, but the pipes (API) are what power everything. When you need to install 50 identical bathrooms (provision 50 projects), you do not turn each faucet by hand — you connect the plumbing programmatically.

The Azure DevOps REST API follows a consistent pattern: https://dev.azure.com/{organization}/{project}/_apis/{area}/{resource}?api-version=7.1. Authentication uses Personal Access Tokens (PATs) for scripts, OAuth2 for web apps, or Managed Identity for Azure-hosted automation. The API covers every Azure DevOps feature: creating projects, managing repos, triggering pipelines, querying work items (WIQL), configuring policies, managing feeds, and reading audit logs.

For project provisioning automation, platform teams build scripts or Azure Functions that respond to events (new team onboarding, new service creation) and configure everything: create the project, set up repos with branch policies, create default pipelines from templates, configure service connections, add team members with appropriate permissions, and create initial work items. This 'project factory' pattern ensures consistency across hundreds of projects.

Reporting is a major API use case. While Azure DevOps provides built-in dashboards and Analytics views (OData), custom reporting often requires the API. Teams build scripts that query pipeline run history (success rates, duration trends), work item cycle times, pull request metrics (time-to-review, reviewer load), and deployment frequency. These feed into tools like Power BI, Datadog, or custom dashboards for engineering metrics.

The gotcha with the REST API is rate limiting and pagination. Azure DevOps limits API calls (varies by authentication method and plan tier) and returns paginated results with continuation tokens. Scripts that naively fetch all work items or all pipeline runs without pagination will get incomplete results or hit rate limits. Another common issue is API version compatibility — always specify the api-version parameter, and test against the preview API before it graduates to stable if you need cutting-edge features.

#!/bin/bash # Automated project setup script using Azure DevOps REST API # Used by platform team to provision new service repositories ORG="https://dev.azure.com/contoso" PROJECT="payments-platform" PAT="$(az keyvault secret show --vault-name kv-platform-automation --name ado-pat --query value -o tsv)" AUTH=$(echo -n ":$PAT" | base64) # Create a new repository for settlements-processor curl -s -X POST "$ORG/$PROJECT/_apis/git/repositories?api-version=7.1" \ -H "Authorization: Basic $AUTH" \ -H "Content-Type: application/json" \ -d '{ "name": "settlements-processor", "project": { "name": "payments-platform" } }' # Configure branch policy: minimum reviewers on main REPO_ID=$(curl -s "$ORG/$PROJECT/_apis/git/repositories/settlements-processor?api-version=7.1" \ -H "Authorization: Basic $AUTH" | jq -r '.id') curl -s -X POST "$ORG/$PROJECT/_apis/policy/configurations?api-version=7.1" \ -H "Authorization: Basic $AUTH" \ -H "Content-Type: application/json" \ -d "{ \"isEnabled\": true, \"isBlocking\": true, \"type\": { \"id\": \"fa4e907d-c16b-4a4c-9dfa-4916e5d171ab\" }, \"settings\": { \"minimumApproverCount\": 2, \"creatorVoteCounts\": false, \"resetOnSourcePush\": true, \"scope\": [{ \"repositoryId\": \"$REPO_ID\", \"refName\": \"refs/heads/main\", \"matchKind\": \"Exact\" }] } }" # Trigger a pipeline run programmatically curl -s -X POST "$ORG/$PROJECT/_apis/pipelines/42/runs?api-version=7.1" \ -H "Authorization: Basic $AUTH" \ -H "Content-Type: application/json" \ -d '{ "resources": { "repositories": { "self": { "refName": "refs/heads/main" } } }, "variables": { "deployEnvironment": { "value": "staging" }, "imageTag": { "value": "2.1.456" } } }' # Query pipeline run history for reporting (with pagination) CONTINUATION_TOKEN="" while true; do RESPONSE=$(curl -s -D - "$ORG/$PROJECT/_apis/pipelines/42/runs?api-version=7.1&\$top=100&continuationToken=$CONTINUATION_TOKEN" \ -H "Authorization: Basic $AUTH") # Extract continuation token from response headers CONTINUATION_TOKEN=$(echo "$RESPONSE" | grep -i 'x-ms-continuationtoken' | tr -d '\r' | awk '{print $2}') # Process results echo "$RESPONSE" | tail -1 | jq '.value[] | {id: .id, result: .result, createdDate: .createdDate}' [ -z "$CONTINUATION_TOKEN" ] && break done # WIQL query: Find all open bugs assigned to payments team curl -s -X POST "$ORG/$PROJECT/_apis/wit/wiql?api-version=7.1" \ -H "Authorization: Basic $AUTH" \ -H "Content-Type: application/json" \ -d '{ "query": "SELECT [System.Id], [System.Title], [System.State] FROM WorkItems WHERE [System.WorkItemType] = '\''Bug'\'' AND [System.State] = '\''Active'\'' AND [System.AreaPath] UNDER '\''payments-platform\\settlements'\'' ORDER BY [Microsoft.VSTS.Common.Priority]" }'

How do you implement Azure DevOps REST APIs to automate project setup, pipeline creation, and reporting?

More Azure questions