アクションフローでのMicrosoft Azure DevOpsアクションの使い方

外部アクションをアクションフローで使用するには、アクションビルダーを外部システムへ接続する必要があります。

現在のプランを確認

Suite、すべてのバージョン

Team、Growth、Professional、EnterpriseまたはEnterprise Plus

Support

Team、ProfessionalまたはEnterprise

要約：◀▼

アクションビルダーをMicrosoft Azure DevOpsに接続することで、作業項目、プルリクエスト、プロジェクト、パイプラインの作成、更新、管理を行うワークフローを自動化できます。作業項目の作成、コメントの追加、パイプラインの実行のトリガ、ステータスの取得といった外部アクションを活用することで、プラットフォームをまたぐコラボレーションを強化し、タスク管理を効率化できます。安全な認証と適切な権限管理のために、専用のサービスアカウントを使用してください。

アクションビルダーをMicrosoft Azure DevOpsなどの外部システムに接続することで、管理者はZendeskを外部システムと統合し、自動化されたワークフローを構築できます。これにより、コラボレーションが向上し、複数のプラットフォームにわたってシームレスな体験を維持できます。

メモ：アクションフロー内の外部システムに関わるステップは、総称して「外部アクション」と呼ばれます。

この記事では、以下のトピックについて説明します。

• アクションビルダーをMicrosoft Azure DevOpsに接続する
• アクションフローでMicrosoft Azure DevOpsアクションを使用する

アクションビルダーをMicrosoft Azure DevOpsに接続する

外部アクションをアクションフローで使用するには、アクションビルダーを外部システムへ接続する必要があります。

外部システムに接続してアクションフローで外部アクションを使用する場合は、以下のベストプラクティスをお勧めします。

• アクションフローによって実行される外部アクションは、すべて外部システムを接続したユーザーに帰属します。したがって、各外部システムに接続する場合、個人の資格情報ではなく専用のサービスアカウントを使用することが推奨されます。
• すべてのインテグレーションでは、必要なスコープへのアクセスが要求されます。ただし、外部システムへの接続を承認する前に、スコープを確認し、妥当性を検証することが重要です。
• OpenAIなどのAPIキーベースのツールの認証情報を管理する場合は、キーを安全な保管庫または認証情報マネージャーに保存することをお勧めします。

アクションビルダーをMicrosoft Azure DevOpsに接続するには

1. 管理センターで、サイドバーにある「 アプリおよびインテグレーション」をクリックし、「アクション」>「アクションフロー」を選択します。
2. アクションフローを新規作成するか、既存のアクションフローを編集します。
3. ステップサイドバーを開きます。
4. 「外部アクション」で、「Microsoft Azure DevOps」をクリックします。
5. 「接続」をクリックします。
6. Microsoft Azure DevOpsの指示に従って認証を行い、コネクションを完了します。

   Microsoft Azure DevOpsコネクションは、安全な認証のためにOAuth 2.0を使用します。Azure DevOps組織へのアクセスを承認するために、Microsoftのサイトにリダイレクトされます。コネクタは、必要に応じてトークンの更新を自動的に処理します。

   アクションフローを通じた実行を計画する操作について、認証を行うユーザーがAzure DevOps組織内で適切な権限を持っていることを確認してください。

   メモ：アクションフローによって実行される外部アクションは、すべて外部システムを接続したユーザーに帰属します。したがって、各外部システムに接続する場合、個人の資格情報ではなく専用のサービスアカウントを使用することが推奨されます。

接続が完了すると、接続していることを示すインジケーター、接続したインスタンスの詳細、およびMicrosoft Azure DevOpsで利用可能なアクションが表示されます。

アクションフローでMicrosoft Azure DevOpsアクションを使用する

以下のMicrosoft Azure DevOpsアクションを選択できます。

• 作業項目を作成
• 作業項目を更新
• 作業項目を参照
• 作業項目にコメントを追加
• 作業項目をリスト
• プルリクエストを作成
• プルリクエストを更新
• プルリクエストを参照
• プルリクエストをリスト
• プロジェクトを参照
• プロジェクトをリスト
• パイプラインをリスト
• パイプラインの実行をトリガ
• パイプラインのステータスを取得
• パイプラインの実行をリスト

作業項目を作成する

「作業項目を作成」アクションを使用して、Azure DevOpsプロジェクトに作業項目を新規作成します。

このアクションには以下の入力と出力が含まれます。

	変数
入力	必須：Organization、Project、Work item type、Title 「Work item type」フィールドの値はプロジェクトの設定に基づいて動的に決定され、「バグ」、「タスク」、「ユーザーストーリー」、「エピック」、「機能」などのタイプやカスタムタイプが含まれる。 オプション：Description、Assigned to、State、Priority、Tags、Area path、Iteration path、Repro steps、Acceptance criteria、Story points、Original estimate、Remaining work、Severity、Activity、Parent ID、Reason オプションフィールドの値は作業項目のタイプによって異なる（たとえば、「バグ」の場合は「Repro steps」、「ユーザーストーリー」の場合は「Acceptance criteria」など）。
出力	作業項目オブジェクト：ID、rev、work_item_type、title、description、state、assigned_to、created_date、changed_date、url、およびすべてのフィールドの詳細など。

作業項目を更新する

「作業項目を更新」アクションを使用して、既存の作業項目のフィールドを変更します。

このアクションには以下の入力と出力が含まれます。

	変数
入力	必須：Organization、Work item ID オプション：Project、Title、Description、Assigned to、State、Priority、Tags、Reason、Area path、Iteration path、Remaining work、Completed work、Story points、Severity、Activity 指定されたフィールドのみが変更され、指定しなかったフィールドの既存の値は変更されない。 プロジェクトを選択すると、そのプロジェクト固有のステータス、エリアパス、およびイテレーションパスのオプションが有効になる。
出力	更新された作業項目オブジェクト：ID、rev、work_item_type、title、changed_date、url、および更新されたすべてのフィールドの詳細など。

作業項目を参照する

「作業項目を参照する」アクションを使用して、特定の作業項目に関する詳細情報を取得します。

このアクションには以下の入力と出力が含まれます。

	変数
入力	必須：Organization、Work item ID オプション：Expand relations、Expand comments 「Expand relations」を Yesに設定すると、リンクや添付ファイルに加え、親、子、および関連する作業項目も含まれるようになる。 「Expand comments」を Yesに設定すると、すべてのコメントとディスカッションの履歴が表示される。
出力	作業項目オブジェクト：すべてのフィールド、およびオプションで親、子、related_work_items、添付ファイル、comments配列など。

作業項目にコメントを追加する

「作業項目にコメントを追加」アクションを使用して、作業項目にコメントを投稿します。

このアクションには以下の入力と出力が含まれます。

	変数
入力	必須：Organization、Project、Work item ID、Comment text
出力	コメントオブジェクト：comment_id、work_item_id、text、created_by, created_date、modified_date、url、およびcomment_versionなど。

作業項目をリストする

「作業項目をリスト」アクションを使用して、WIQL（作業項目クエリ言語）やフィルターフィールドを用いて作業項目を検索します。

このアクションには以下の入力と出力が含まれます。

	変数
入力	必須：Organization、Project オプション：Query、Title contains、Work item type、State、Assigned to、Tags contain、Area path、Max results、Sort field、Sort order 「Query」フィールドを使用して、高度なフィルタリングのためのカスタムWIQLクエリを記述することも、空白のままにして下の簡易フィルタフィールドを使用することもできる。 結果の最大数はデフォルトで50件。200件を超えることはできない。 「Sort field」には、「変更日」、「作成日」、「タイトル」、または「優先度」を指定できる。
出力	作業項目の結果配列：total_countおよびhas_moreページネーションフラグを含む。

プルリクエストを作成する

「プルリクエストを作成」アクションを使用して、Gitリポジトリにプルリクエストを新規作成します。

このアクションには以下の入力と出力が含まれます。

	変数
入力	必須：Organization、Project、Repository、Source branch、Target branch、Title オプション：Description、Reviewers、Work item IDs、Is draft、Auto complete、Labels、Merge strategy、Delete source branch ブランチ名にはfeature/branch-nameまたはrefs/heads/feature/branch-nameという形式を使用すること。 複数のレビュー担当者のメールアドレスは、コンマで区切って指定する。 作業項目IDは、カンマ区切りの数値IDである必要がある。 「Is draft」をYesに設定すると、下書きのプルリクエストとして作成できる。
出力	プルリクエストオブジェクト：pull_request_id、title、description、status、created_date、created_by、repository、source_branch、target_branch、reviewers 配列、work_item_refs 配列、url、および web_urlを含む。

プルリクエストを更新する

「プルリクエストを更新」アクションを使用して、既存のプルリクエストを変更します。

このアクションには以下の入力と出力が含まれます。

	変数
入力	必須：Organization、Project、Repository、Pull request ID オプション：Title、Description、Status、Is draft、Auto complete enabled、Merge strategy 指定されたフィールドのみが変更され、 「Status」には、「アクティブ」、「完了」、または「中断」が指定可能。 「Auto complete enabled」をYesに設定すると、すべてのポリシーの条件を満たした時点で自動的にマージされる。
出力	更新されたプルリクエストオブジェクト：pull_request_id、title、status、merge details、last_merge_commit、closed_date、url、およびweb_urlなど。

プルリクエストを参照する

「プルリクエストを参照」アクションを使用して、特定のプルリクエストに関する詳細情報を取得します。

このアクションには以下の入力と出力が含まれます。

	変数
入力	必須：Organization、Project、Repository、Pull request ID オプション：Include commits、Include work items 「Include commits」をYesに設定すると、プルリクエスト内のすべてのコミットを取得できる。 「Include work items」をYesに設定すると、リンクされたすべての作業項目を取得できる。
出力	詳細なプルリクエストオブジェクト：すべてのフィールド、reviewers配列、labels配列、オプションのcommitsおよびwork_item_refs配列、completion_options、url、web_urlなど。

プルリクエストをリストする

「プルリクエストをリスト」アクションを使用して、Gitリポジトリからプルリクエストを取得します。

このアクションには以下の入力と出力が含まれます。

	変数
入力	必須：Organization、Project、Repository オプション：Status、Creator ID、Reviewer ID、Source branch、Target branch、Max results、Skip 「Status」には、active、completed、abandonedが指定可能。 「Max results」の値は 1～100 の範囲（デフォルト：50）。 ページネーションに「Skip」を使用して、最初の N 件の結果をスキップする。
出力	プルリクエストの配列：プルリクエストオブジェクトに加え、total_count および has_more フラグを含むページネーションの詳細。

プロジェクトを参照する

「プロジェクトを参照」アクションを使用して、特定のAzure DevOpsプロジェクトに関する詳細情報を取得します。

このアクションには以下の入力と出力が含まれます。

	変数
入力	必須：Organization、Project オプション：Include capabilities、Include history 「Include capabilities」をYesに設定すると、バージョン管理およびプロセステンプレートの詳細を取得できる。 「Include history」をYesに設定すると、プロジェクトの変更履歴を取得できる。
出力	プロジェクトオブジェクト：ID、名前、説明、状態、可視性、default_team、URLを含む。オプションで機能や履歴を含めることもできる。

プロジェクトをリストする

「プロジェクトをリスト」アクションを使用して、組織内のすべてのプロジェクトを取得できます。

このアクションには以下の入力と出力が含まれます。

	変数
入力	必須：Organization オプション：State filter、Continuation token、Max results 「State filter」には、All、WellFormed（アクティブなプロジェクト、デフォルト）、Deleting、または New を指定できる。 「Max results」の値は 1～100 の範囲（デフォルト：100）。
出力	プロジェクト配列（各プロジェクトオブジェクトにid、name、description、state、visibility、urlを含む）と、total_countおよびcontinuation_token。

パイプラインをリストする

「パイプラインをリスト」アクションを使用して、プロジェクト内のビルドパイプラインとリリースパイプラインを取得します。

このアクションには以下の入力と出力が含まれます。

	変数
入力	必須：Organization、Project オプション：Pipeline name、Folder path、Continuation token 「Pipeline name」は部分一致をサポート。「Folder path」は \Production または \CI\Builds のフォーマット。
出力	パイプラインオブジェクト（id、name、folder、revision、url、web_urlを含む）の配列、およびtotal_countとcontinuation_token。

パイプラインの実行をトリガする

「パイプラインの実行をトリガ」アクションを使用して、パイプラインの実行を手動でトリガします。

このアクションには以下の入力と出力が含まれます。

	変数
入力	必須：Organization、Project、Pipeline ID オプション：Branch、Variables、Resources repositories、Stages to skip 「Branch」は main または refs/heads/feature/branch-name のフォーマット。 変数はJSONオブジェクトであること（例：{"Environment": "Production"}）。
出力	実行オブジェクト：run_id、run_number、パイプラインの詳細、state、result、created_date、finished_date、url、web_urlなど。

パイプラインの実行ステータスを取得する

「パイプラインの実行ステータスを取得」アクションを使用して、パイプラインの実行ステータスと詳細情報を取得します。

このアクションには以下の入力と出力が含まれます。

	変数
入力	必須：Organization、Project、Pipeline ID、Run ID
出力	詳細な実行オブジェクト：run_id、run_number、name、state、result、パイプラインの詳細、created_date、finished_dateなど。 「State」は現在のステータス（進行中、完了、キャンセル中、キャンセル済み）を示す。「Result」は結果（成功、失敗、キャンセル済みなど）を示す。

パイプラインの実行をリスト

「パイプラインの実行をリスト」アクションを使用して、特定のパイプラインの最近の実行を取得します。

このアクションには以下の入力と出力が含まれます。

	変数
入力	必須：Organization、Project、Pipeline ID オプション：Result filter、State filter、Max results、Continuation token 「Result filter」には、all、succeeded、failedなどを指定可能。「Max results」の値は 1～100 の範囲（デフォルト：50）。
出力	実行オブジェクト（run_id、run_number、state、result、urlsを含む）の配列と、total_countおよびcontinuation_token。