この記事は Qiita Advent Calender - Azure DevOps の 8 日目の記事です。
Azure DevOps CLI とは
Azure DevOps CLI は、クラウド (SaaS) 版である Azure DevOps Services とオンプレミス版である Azure DevOps Server 2020 で使用することができるコマンドライン ツールです。
Azure CLI 拡張機能として実装されているため、Azure CLI をインスト-ルした状態で以下のコマンドを実行して導入する必要があります。
az extension add --name azure-devops
Azure DevOps CLI は、Web UI 経由で設定が必要だった管理項目をコマンドラインから実行可能にするだけでなく、パイプライン成果物 (Pipeline Artifacts) のダウンロードなどユーザー向けにも便利な機能を提供します。
また、ユニバーサル パッケージの管理や利用者向けの案内(バナー)表示など Azure DevOps CLI からのみ可能な機能も存在します。
Azure DevOps CLI の概要については、Microsoft Docs に記載があります。
docs.microsoft.com
しかし、残念ながら Azure DevOps CLI が提供するコマンド一覧が俯瞰できるドキュメントがないため、「何ができて、何ができないのかが分かりにくい」という課題がありました。
そこで、本記事では記事投稿 (2020/12/8 ) 時点で実装されているグループとコマンドの一覧を記載し、各コマンドの説明も日本語に翻訳しました。*1
各コマンドの実行方法については、サブグループ単位で対応する公式ドキュメントのリンクを貼り付けていますので、そちらを参照ください。
Azure DevOps CLI コマンド一覧
Azure DevOps CLI 拡張機能をインストールすると Azure CLI のサブ グループとして以下が追加されます。 *2
- az repos (Azure Repos 向け)
- az boards (Azure Boards 向け)
- az pipelines (Azure Pipelines 向け)
- az artifacts (Azure Artifacts 向け)
- az devops (Azure DevOps 全般)
az repos コマンド
Azure Repos を管理します。
グループ名 |
概要 |
import |
Git リポジトリのインポートを管理します。 |
policy |
ブランチポリシーを管理します。 |
pr |
プル リクエスト (PR) 管理します。 |
ref |
Git リファレンスを管理します。 |
コマンド名 |
概要 |
create |
チーム プロジェクトに Git リポジトリを作成します。 |
delete |
チーム プロジェクト内の Git リポジトリを削除します。 |
list |
チーム プロジェクトの Git リポジトリを一覧表示します。 |
show |
チーム プロジェクトの Git リポジトリの詳細を表示します。 |
update |
Git リポジトリを更新します。 |
docs.microsoft.com
az repos import コマンド
Git リポジトリのインポートを管理します。
コマンド名 |
概要 |
create |
Git インポート要求を作成します。 |
docs.microsoft.com
az repos policy コマンド
ブランチ ポリシーを管理します。
グループ名 |
概要 |
approver-count |
承認者数ポリシーを管理します。 |
build |
ビルド ポリシーを管理します。 |
case-enforcement |
大文字/小文字強制ポリシーを管理します。 |
comment-required |
コメント必須ポリシーを管理します。 |
file-size |
ファイル サイズ ポリシーを管理します。 |
merge-strategy |
マージ戦略ポリシーを管理します。 |
required-reviewer |
必須レビューアー ポリシーを管理します。 |
work-item-linking |
作業項目リンク ポリシーを管理します。 |
コマンド名 |
概要 |
create |
構成ファイルを使用してポリシーを作成します。 |
delete |
ポリシーを削除します。 |
list |
プロジェクト内のすべてのポリシーを一覧表示します。 |
show |
ポリシーの詳細を表示します。 |
update |
構成ファイルを使用してポリシーを更新します。 |
docs.microsoft.com
az repos policy approver-count コマンド
承認者数ポリシーを管理します。
コマンド名 |
概要 |
create |
承認者数ポリシーを作成します。 |
update |
承認者数のポリシーを更新します。 |
docs.microsoft.com
az repos policy build コマンド
ビルド ポリシーを管理します。
コマンド名 |
概要 |
create |
ビルド ポリシーを作成します。 |
update |
ビルド ポリシーを更新します。 |
docs.microsoft.com
az repos policy case-enforcement コマンド
大文字/小文字強制ポリシーを管理します。
コマンド名 |
概要 |
create |
大文字/小文字強制ポリシーを作成します。 |
update |
大文字/小文字強制ポリシーを更新します。 |
docs.microsoft.com
コメント必須ポリシーを管理します。
コマンド名 |
概要 |
create |
コメント必須ポリシーを作成します。 |
update |
コメント必須ポリシーを更新します。 |
docs.microsoft.com
az repos policy file-size コマンド
ファイル サイズ ポリシーを管理します。
コマンド名 |
概要 |
create |
ファイル サイズ ポリシーを作成します。 |
update |
ファイル サイズ ポリシーを更新します。 |
docs.microsoft.com
az repos policy merge-strategy コマンド
マージ戦略ポリシーを管理します。
コマンド名 |
概要 |
create |
マージ戦略ポリシーを作成します。 |
update |
マージ戦略ポリシーを更新します。 |
docs.microsoft.com
az repos policy required-reviewer コマンド
必須レビューアー ポリシーを管理します。
コマンド名 |
概要 |
create |
必須レビューアー ポリシーを作成します。 |
update |
必須レビューアー ポリシーを更新します。 |
docs.microsoft.com
az repos policy work-item-linking コマンド
作業項目リンク ポリシーを管理します。
コマンド名 |
概要 |
create |
作業項目リンク ポリシーを作成します。 |
update |
作業項目リンク ポリシーを更新します。 |
docs.microsoft.com
az repos pr コマンド
プル リクエスト (PR) を管理します。
コマンド名 |
概要 |
policy |
プル リクエスト (PR) のポリシーを管理します。 |
reviewer |
プル リクエスト (PR) のレビュー担当者を管理します。 |
work-item |
プル リクエスト (PR) に関連付けられている作業項目を管理します。 |
コマンド名 |
概要 |
checkout |
ローカルに変更がない場合は、PR 元のブランチをローカルでチェックアウトします。 |
create |
プル リクエストを作成します。 |
list |
プル リクエストを一覧表示します。 |
set-vote |
プル リクエストに投票します。 |
show |
プル リクエストの詳細を取得します。 |
update |
プル リクエストを更新します。 |
docs.microsoft.com
az repos pr policy コマンド
プル リクエスト (PR) のポリシーを管理します。
コマンド名 |
概要 |
list |
プル リクエストのポリシーを一覧表示します。 |
queue |
プルリクエストのポリシー評価をキューに配置します。 |
docs.microsoft.com
az repos pr reviewer コマンド
プル リクエスト (PR) のレビュー担当者を管理します。
コマンド名 |
概要 |
add |
1 人以上のレビュー担当者をプル リクエストに追加します。 |
list |
プル リクエストのレビュー担当者を一覧表示します。 |
remove |
1人以上のレビュー担当者をプル リクエストから削除します。 |
docs.microsoft.com
az repos pr work-item コマンド
プル リクエスト (PR) に関連付けられている作業項目を管理します。
コマンド名 |
概要 |
add |
1つ以上の作業項目をプル リクエストにリンクします。 |
list |
プル リクエストのリンクされた作業項目を一覧表示します。 |
remove |
1つ以上の作業項目をプル リクエストからリンク解除します。 |
docs.microsoft.com
az repos ref コマンド
Git リファレンスを管理します。
コマンド名 |
概要 |
create |
参照を作成します。 |
delete |
参照を削除します。 |
list |
参照を一覧表示します。 |
lock |
参照をロックします。 |
unlock |
参照のロックを解除します。 |
docs.microsoft.com
az boards コマンド
Azure Boards を管理します。
グループ名 |
概要 |
area |
エリア パスを管理します。 |
iteration |
イテレーションを管理します。 |
work-item |
作業項目を管理します。 |
コマンド名 |
概要 |
query |
作業項目の一覧を照会します。 |
docs.microsoft.com
az boards area コマンド
エリア パス (区分パス) を管理します。
コマンド名 |
概要 |
project |
プロジェクトの区分を管理します。 |
team |
チームの区分を管理します。 |
docs.microsoft.com
az boards area project コマンド
プロジェクトの区分を管理します。
コマンド名 |
概要 |
create |
プロジェクトの区分を作成します。 |
delete |
プロジェクトの区分を削除します。 |
list |
プロジェクトの区分を一覧表示します。 |
show |
プロジェクトの区分の詳細を表示します。 |
update |
プロジェクトの区分を更新します。 |
docs.microsoft.com
az boards area team コマンド
チームの区分を管理します。
コマンド名 |
概要 |
add |
チームの区分を追加します。 |
list |
チームの区分を一覧表示します。 |
remove |
チームの区分を削除します。 |
update |
チームの区分を更新します。 |
docs.microsoft.com
az boards iteration コマンド
イテレーションを管理します。
docs.microsoft.com
az boards iteration project コマンド
プロジェクトのイテレーションを管理します。
docs.microsoft.com
az boards iteration team コマンド
チームのイテレーションを管理します。
docs.microsoft.com
az boards work-item コマンド
作業項目を管理します。
グループ名 |
概要 |
relation |
作業項目のリレーションシップを管理します。 |
コマンド名 |
概要 |
create |
作業項目を作成します。 |
delete |
作業項目を削除します。 |
show |
作業項目の詳細を表示します。 |
update |
作業項目を更新します。 |
docs.microsoft.com
az boards work-item relation コマンド
作業項目のリレーションシップを管理します。
コマンド名 |
概要 |
add |
作業項目にリレーションシップを追加します。 |
list-type |
組織でサポートされている作業項目のリレーションシップの一覧を表示します。 |
remove |
作業項目からリレーションシップを削除します。 |
show |
作業項目を取得し、わかりやすい名前を設定します。 |
docs.microsoft.com
az pipelines コマンド
Azure Pipelines を管理します。
グループ名 |
概要 |
agent |
エージェントを管理します。 |
build |
ビルドを管理します。 |
folder |
パイプラインを整理するためのフォルダーを管理します。 |
pool |
エージェント プールを管理します。 |
queue |
エージェント キューを管理します。 |
release |
リリースを管理します。 |
runs |
パイプライン実行を管理します。 |
variable |
パイプライン変数を管理します。 |
variable-group |
変数グループを管理します。 |
コマンド名 |
概要 |
create |
新しい Azure Pipeline (YAML ベース) を作成します。 |
delete |
パイプラインを削除します。 |
list |
パイプラインを一覧表示します。 |
run |
パイプラインをキューに配置 (実行) します。 |
show |
パイプラインの詳細を取得します。 |
update |
パイプラインを更新します。 |
docs.microsoft.com
az pipelines agent コマンド
エージェントを管理します。
コマンド名 |
概要 |
list |
プール内のエージェントの一覧を取得します。 |
show |
エージェントの詳細を表示します。 |
docs.microsoft.com
az pipelines build コマンド
ビルドを管理します。
グループ名 |
概要 |
definition |
ビルド定義を管理します。 |
tag |
ビルド タグを管理します。 |
コマンド名 |
概要 |
list |
ビルド結果を一覧表示します。 |
queue |
ビルドを要求 (キュー) します。 |
show |
ビルドの詳細を取得します。 |
docs.microsoft.com
az pipelines build definition コマンド
ビルド定義を管理します。
コマンド名 |
概要 |
list |
ビルド定義を一覧表示します。 |
show |
ビルド定義の詳細を取得します。 |
docs.microsoft.com
az pipelines build tag コマンド
ビルド タグを管理します。
コマンド名 |
概要 |
add |
ビルドのタグを追加します。 |
delete |
ビルド タグを削除します。 |
list |
ビルドのタグを取得します。 |
docs.microsoft.com
az pipelines folder コマンド
パイプラインを整理するためのフォルダーを管理します。
コマンド名 |
概要 |
create |
フォルダーを作成します。 |
delete |
フォルダーを削除します。 |
list |
すべてのフォルダーを一覧表示します。 |
update |
フォルダー名または説明を更新します。 |
docs.microsoft.com
az pipelines pool コマンド
エージェント プールを管理します。
コマンド名 |
概要 |
list |
エージェント プールを一覧表示します。 |
show |
エージェント プールの詳細を表示します。 |
docs.microsoft.com
az pipelines queue コマンド
エージェント キューを管理します。
コマンド名 |
概要 |
list |
エージェント キューを一覧表示します。 |
show |
エージェント キューの詳細を表示します。 |
docs.microsoft.com
az pipelines release コマンド
リリースを管理します。
グループ名 |
概要 |
definition |
リリース定義を管理します。 |
コマンド名 |
概要 |
create |
リリースを要求 (作成) します。 |
list |
リリース結果を一覧表示します。 |
show |
リリースの詳細を取得します。 |
docs.microsoft.com
az pipelines release definition コマンド
リリース定義を管理します。
コマンド名 |
概要 |
list |
リリース定義を一覧表示します。 |
show |
リリース定義の詳細を取得します。 |
docs.microsoft.com
az pipelines runs コマンド
パイプライン実行を管理します。
グループ名 |
概要 |
artifact |
Manage pipeline run artifacts. |
tag |
Manage pipeline run tags. |
コマンド名 |
概要 |
list |
List the pipeline runs in a project. |
show |
Show details of a pipeline run. |
docs.microsoft.com
az pipelines runs artifact コマンド
パイプライン実行の成果物を管理します。
コマンド名 |
概要 |
download |
パイプライン成果物をダウンロードします。 |
list |
実行に関連付けられている成果物の一覧を表示します。 |
upload |
パイプライン成果物をアップロードします。 |
docs.microsoft.com
az pipelines runs tag コマンド
パイプライン実行のタグを管理します。
コマンド名 |
概要 |
add |
パイプライン実行のタグを追加します。 |
delete |
パイプライン実行タグを削除します。 |
list |
パイプライン実行のタグを取得します。 |
docs.microsoft.com
az pipelines variable コマンド
パイプライン変数を管理します。
コマンド名 |
概要 |
create |
パイプラインに変数を追加します。 |
delete |
パイプラインから変数を削除します。 |
list |
パイプライン内の変数の一覧を表示します。 |
update |
パイプラインの変数を更新します。 |
docs.microsoft.com
az pipelines variable-group コマンド
変数グループを管理します。
グループ名 |
概要 |
variable |
変数グループ内の変数を管理します。 |
コマンド名 |
概要 |
create |
変数グループを作成します。 |
delete |
変数グループを削除します。 |
list |
変数グループを一覧表示します。 |
show |
変数グループの詳細を表示します。 |
update |
変数グループを更新します。 |
docs.microsoft.com
az pipelines variable-group variable コマンド
変数グループ内の変数を管理します。
コマンド名 |
概要 |
create |
変数グループに変数を追加します。 |
delete |
変数グループから変数を削除します。 |
list |
変数グループ内の変数の一覧を表示します。 |
update |
変数グループ内の変数を更新します。 |
docs.microsoft.com
az artifacts コマンド
Azure Artifacts を管理します。
グループ名 |
概要 |
universal |
ユニバーサル パッケージを管理します。 |
docs.microsoft.com
az artifacts universal コマンド
ユニバーサル パッケージを管理します。
コマンド名 |
概要 |
download |
パッケージをダウンロードします。 |
publish |
パッケージをフィードに発行します。 |
docs.microsoft.com
az devops コマンド
Azure DevOps の組織を管理します。
グループ名 |
概要 |
admin |
管理操作を管理します。 |
extension |
拡張機能を管理します。 |
project |
チーム プロジェクトを管理します。 |
security |
セキュリティ関連の操作を管理します。 |
service-endpoint |
サービス エンドポイント/接続を管理します。 |
team |
チームを管理します。 |
user |
ユーザーを管理します。 |
wiki |
Wiki を管理します。 |
コマンド名 |
概要 |
configure |
Azure DevOps CLIを構成するか、構成を表示します。 |
invoke |
任意の DevOps エリアとリソースの REST API を呼び出します。 |
login |
特定の組織に使用する資格情報 (PAT) を設定します。 |
logout |
すべての組織または特定の組織の資格情報をクリアします。 |
docs.microsoft.com
az devops admin コマンド
管理操作を管理します。
グループ名 |
概要 |
banner |
組織のバナーを管理します。 |
docs.microsoft.com
az devops admin banner コマンド
組織のバナーを管理します。
コマンド名 |
概要 |
add |
新しいバナーを追加し、すぐに表示します。 |
list |
バナーを一覧表示します。 |
remove |
バナーを削除します。 |
show |
バナーの詳細を表示します。 |
update |
バナーのメッセージ、レベル、または有効期限を更新します。 |
docs.microsoft.com
az devops extension コマンド
拡張機能を管理します。
コマンド名 |
概要 |
disable |
拡張機能を無効にします。 |
enable |
拡張機能を有効にします。 |
install |
拡張機能をインストールします。 |
list |
組織にインストールされている拡張機能を一覧表示します。 |
search |
Marketplace から拡張機能を検索します。 |
show |
1つの拡張機能の詳細を取得します。 |
uninstall |
拡張機能をアンインストールします。 |
docs.microsoft.com
az devops project コマンド
チーム プロジェクトを管理します。
コマンド名 |
概要 |
create |
チーム プロジェクトを作成します。 |
delete |
チーム プロジェクトを削除します。 |
list |
チーム プロジェクトを一覧表示します。 |
show |
チーム プロジェクトを表示します。 |
docs.microsoft.com
az devops security コマンド
セキュリティ関連の操作を管理します。
グループ名 |
概要 |
group |
セキュリティ グループを管理します。 |
permission |
セキュリティ アクセス許可を管理します。 |
docs.microsoft.com
az devops security group コマンド
セキュリティ グループを管理します。
グループ名 |
概要 |
membership |
セキュリティ グループのメンバーシップを管理します。 |
コマンド名 |
概要 |
create |
新しい Azure DevOps グループを作成します。 |
delete |
Azure DevOps グループを削除します。 |
list |
プロジェクトまたは組織内のすべてのグループを一覧表示します。 |
show |
グループの詳細を表示します。 |
update |
Azure DevOps グループの名前と説明を更新します。 |
docs.microsoft.com
az devops security group membership コマンド
セキュリティ グループのメンバーシップを管理します。
グループ名 |
概要 |
add |
メンバーシップを追加します。 |
list |
グループまたはユーザーのメンバーシップを一覧表示します。 |
remove |
メンバーシップを削除します。 |
docs.microsoft.com
az devops security permission コマンド
セキュリティ アクセス許可を管理します。
グループ名 |
概要 |
namespace |
セキュリティ名前空間を管理します。 |
コマンド名 |
概要 |
list |
特定のユーザー/グループと名前空間のトークンを一覧表示します。 |
reset |
特定のアクセス許可ビットのアクセス許可をリセットします。 |
reset-all |
ユーザー/グループに対するこのトークンのすべてのアクセス許可をクリアします。 |
show |
特定のトークン、名前空間、およびユーザー/グループのアクセス許可を表示します。 |
update |
特定のユーザーまたはグループに許可または拒否アクセス許可を割り当てる。 |
docs.microsoft.com
az devops security permission namespace コマンド
セキュリティ名前空間を管理します。
コマンド名 |
概要 |
list |
組織で使用可能なすべての名前空間を一覧表示します。 |
show |
各名前空間で使用できるアクセス許可の詳細を表示します。 |
docs.microsoft.com
az devops service-endpoint コマンド
サービス エンドポイント/接続を管理します。
グループ名 |
概要 |
azurerm |
Azure RM サービス エンドポイント/接続を管理します。 |
github |
GitHub サービス エンドポイント/接続を管理します。 |
コマンド名 |
概要 |
create |
構成ファイルを使用してサービス エンドポイントを作成します。 |
delete |
サービス エンドポイントを削除します。 |
list |
プロジェクト内のサービス エンドポイントを一覧表示します。 |
show |
サービス エンドポイントの詳細を取得します。 |
update |
サービス エンドポイントを更新します。 |
docs.microsoft.com
az devops service-endpoint azurerm コマンド
Azure RM サービス エンドポイント/接続を管理します。
コマンド名 |
概要 |
create |
Azure RM サービス エンドポイントを作成します。 |
docs.microsoft.com
az devops service-endpoint github コマンド
GitHub サービス エンドポイント/接続を管理します。
コマンド名 |
概要 |
create |
GitHub サービス エンドポイントを作成します。 |
docs.microsoft.com
az devops team コマンド
チームを管理します。
コマンド名 |
概要 |
create |
チームを作成します。 |
delete |
チームを削除します。 |
list |
プロジェクト内のすべてのチームを一覧表示します。 |
list-member |
チームのメンバーを一覧表示します。 |
show |
チームの詳細を表示します。 |
update |
チームの名前や説明を更新します。 |
docs.microsoft.com
az devops user コマンド
コマンド名 |
概要 |
add |
Add user. |
list |
List users in an organization [except for users which are added via AAD groups]. |
remove |
Remove user from an organization. |
show |
Show user details. |
update |
Update license type for a user. |
docs.microsoft.com
az devops wiki コマンド
Wiki を管理します。
グループ名 |
概要 |
page |
Wiki のページを管理する |
コマンド名 |
概要 |
create |
Wiki を作成します。 |
delete |
Wiki を削除します。 |
list |
プロジェクトまたは組織内のすべての wiki を一覧表示します。 |
show |
wiki ページを管理します。 |
docs.microsoft.com
az devops wiki page コマンド
Wiki ページを管理します。
コマンド名 |
概要 |
create |
新しいページを追加します。 |
delete |
ページを削除します。 |
show |
ページの内容を取得するか、ページを開きます。 |
update |
ページを編集します。 |
docs.microsoft.com