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

[アーティクル]
04/04/2024

Azure DevOps Services | Azure DevOps Server 2022 - Azure DevOps Server 2019

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

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

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

Note

この記事では、プロジェクトのホームディレクトリを "home" と参照します。

サンプルコンシューマーサービス

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

ヒント

Azure DevOps 拡張機能 SDK を使用した拡張機能開発に関する最新のドキュメントをご覧ください。

サービスフックのしくみ

サービスフック パブリッシャーは、 一連の イベントを定義します。 サブスクリプションはイベントを リッスンして待機し、 イベント がトリガーされるタイミングの アクション を定義します。

サービスフックの図

これは、すべてのサービスフックの実装のしくみの一般的な説明です。ここでは、拡張機能で定義されたコンシューマーと、イベントが発生したときの指定されたアクションを指定します。

拡張機能を作成する

拡張機能を最初から作成する方法を参照してください。
カスタムコンシューマー実装の特定のコントリビューションを基本マニフェストファイルに追加します。コントリビューションを追加した後のマニフェストの外観の例を次に示します。

{
    "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"
                        }
                    }
                ]
            }
        }
    ]
}

Note

プロパティは必ず更新してください publisher 。

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

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

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

プロパティ	説明
id	コンシューマーサービスの一意の ID。
name	サービスフックサブスクリプションの作成時に表示されるカスタムコンシューマーの名前。
description	コンシューマーサービスについて説明します。
informationUrl	拡張機能の詳細を確認します。
inputDescriptors	コンシューマーサービスでサブスクリプションを作成しているユーザーが使用する入力。
actions	実行するアクションと、それらのアクションをトリガーするイベントについて説明します。

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

プロパティ	説明
id	アクションサービスの ID。
name	アクションの名前。
description	アクションの詳細な説明。
supportedEventTypes	このアクションを使用できるトリガーの種類の配列。詳細については、「イベントの種類の一覧」を参照してください。
publishEvent.url	HTTP メッセージが送信される URL。 inputDescriptors によって提供される値によってテンプレート化できます。実際の値は、サブスクリプションの作成時にユーザーによって定義されます。

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

次の手順

拡張機能のパッケージ化、発行、インストール

次の方法で共有

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

サービスフックのしくみ

拡張機能を作成する

次の手順

フィードバック

フィードバック

その他のリソース

次の方法で共有

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

サービス フックのしくみ

拡張機能を作成する

次の手順

関連記事

フィードバック

フィードバック

その他のリソース

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

サービスフックのしくみ