サービス フック用のカスタム コンシューマーを作成する

Azure DevOps Services |Azure DevOps Server |Azure DevOps Server 2022 |Azure DevOps Server 2020

サービス フックを使用して、プロジェクトで発生したイベントについて Microsoft 以外のシステムに通知します。 カスタム コンシューマーは、拡張機能のマニフェストで定義されているエンドポイントに HTTP メッセージを送信します。

この記事では、次のイベントとアクションを含む サンプル コンシューマー サービスを実装する拡張機能の開発について説明します。

• 次のアクションをトリガーするサポートされているイベント:
  • コードのプッシュ
  • pull request 作成
  • Pull request の更新完了
• イベントが発生したときに実行するアクションがサポートされています。
  • HTTP メッセージを送信する

詳細については、 拡張機能の GitHub リポジトリの例を参照してください。 カスタム コンシューマー拡張機能のトリガーとして使用できるサポートされているすべてのイベントの一覧については、「 イベントの種類の一覧」を参照してください。

サービス フックのしくみ

サービス フック パブリッシャーは、 一連の イベントを定義します。 サブスクリプションは イベントをリッスンし、 イベント がトリガーされたときに実行される アクション を定義します。

次の図は、一般的なサービス フック フローを示しています。パブリッシャーはイベントを出力し、サブスクリプションはイベントに一致し、アクションは一致が発生したときに実行されます。 この記事の例では、拡張機能によってコンシューマーが実装されます。 サポートされているイベントが発生すると、コンシューマーの構成済みアクションは、拡張マニフェストで指定したエンドポイントに HTTP メッセージを送信します。

拡張機能を作成する

1. 最初から拡張機能を作成する方法を確認します。

2. カスタム コンシューマー実装の特定のコントリビューションを基本的な マニフェスト ファイルに追加します。 コントリビューションを追加した後のマニフェストの外観の例を次に示します。

{
    "manifestVersion": 1,
    "id": "samples-service-hooks-consumer",
    "version": "0.1.2",
    "name": "Service Hooks Sample",
    "description": "A simple extension that demonstrates how to contribute a consumer service into service hooks.",
    "publisher": "fabrikam",
    "public": false,
    "icons": {
        "default": "images/logo.png"
    },
    "scopes": [],
    "files": [
        {
            "path": "images",
            "addressable": true
        }
    ],
    "content": {
        "details": {
            "path": "readme.md"
        }
    },
    "categories": [
        "Developer samples"
    ],
    "targets": [
        {
            "id": "Microsoft.VisualStudio.Services"
        }
    ],
    "contributions": [
        {
            "id": "consumer",
            "type": "ms.vss-servicehooks.consumer",
            "targets": [
                "ms.vss-servicehooks.consumers"
            ],
            "properties": {
                "id": "consumer",
                "name": "Sample Consumer",
                "description": "Sample consumer service",
                "informationUrl": "https://aka.ms/vsoextensions",
                "inputDescriptors": [
                    {
                        "id": "url",
                        "isRequired": true,
                        "name": "URL",
                        "description": "URL to post event payload to",
                        "inputMode": "textbox"
                    }
                ],
                "actions": [
                    {
                        "id": "performAction",
                        "name": "Perform action",
                        "description": "Posts a standard event payload",
                        "supportedEventTypes": [
                            "git.push",
                            "git.pullrequest.created",
                            "git.pullrequest.updated"
                        ],
                        "publishEvent": {
                            "url": "{{{url}}}",
                            "resourceDetailsToSend": "all",
                            "messagesToSend": "all",
                            "detailedMessagesToSend": "all"
                        }
                    }
                ]
            }
        }
    ]
}

拡張機能のコントリビューションごとに、マニフェストによって次の項目が定義されます。

• 貢献の種類 - この場合のコンシューマー サービス (ms.vss-servicehooks.consumer)。
• コントリビューション ターゲット - この場合のコンシューマー サービス (ms.vss-servicehooks.consumers)。
• 各種類のコントリビューションに固有のプロパティ。

コンシューマーには、次のプロパティがあります。

コンシューマーのアクションには、次のプロパティがあります。

3. 拡張機能を Azure DevOps 組織にデプロイし、テストします。

次のステップ

関連コンテンツ

• サービス フック コンシューマー
• サービス フックで使用可能なサービス
• プログラムでサービス フック サブスクリプションを作成
• ブラウザーで拡張機能をテストおよびデバッグする
• 拡張機能の GitHub リポジトリの例
• イベントの種類の一覧