Azure Devops で REST API をコールする方法

• 概要
• 環境
• curl
• python
• 最後に
• 参考サイト

概要

Azure Devops の REST API をコールしてみました
今回はプロジェクトの一覧を取得しています
公式のリファレンスはこちらです

環境

• Azure Devops (2024/03/08 時点)
• macOS 11.7.10
• Ubuntu 22.04 (Agent)
• azure-pipelines-agent 3.234.0

curl

user には Azure Devops で使用しているユーザ名を pta には個人用アクセストークンを入力しましょう
また organization_name の部分も組織名を適宜入力してください

• curl -u "user:pta" "https://dev.azure.com/organization_name/_apis/projects?api-version=2.0"

レスポンスのサンプルは以下のとおりです

{
  "count": 1,
  "value": [
    {
      "id": "1dd3f062-ec15-4065-9401-bf2266c1fc97",
      "name": "test",
      "url": "https://dev.azure.com/organization_name/_apis/projects/9e67f2f0-9f0b-4be9-8084-42426920a786",
      "state": "wellFormed",
      "revision": 11,
      "visibility": "private",
      "lastUpdateTime": "2024-02-20T02:38:46.713Z"
    }
  ]
}

python

• pipenv install azure-devops

from azure.devops.connection import Connection
from msrest.authentication import BasicAuthentication

# トークンとAzure DevopsのURLを設定
personal_access_token = "pta"
organization_url = "https://dev.azure.com/xxx"

# コネクションの作成
credentials = BasicAuthentication("", personal_access_token)
connection = Connection(base_url=organization_url, creds=credentials)

# クライアントの作成
core_client = connection.clients.get_core_client()

# プロジェクトの一覧の取得
projects = core_client.get_projects()
for project in projects:
    print(project.name)

ページネイト用の continuation_token というのがあるらしいが取得方法がわからなかったです

最後に

Azure Devops の API を使ってみました
Extension など作る場合や自動化するようなときに使う感じになるかなと思います

参考サイト

• https://github.com/microsoft/azure-devops-python-api