为服务挂钩创建自定义使用者

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

使用服务挂钩来通知您的项目中发生的事件至非微软系统。 自定义使用者将 HTTP 消息发送到扩展清单中定义的终结点。

开发扩展以实现 示例使用者服务，本文逐步讲解该过程，其中包括以下事件和动作。

• 触发以下操作的事件受支持：
  • 推送的代码
  • 已创建拉取请求
  • 已更新拉取请求
• 发生事件时支持执行的操作：
  • 发送 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 存储库
• 事件类型列表