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

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

使用服务挂钩通知外部系统 Azure DevOps 项目中的事件。 自定义使用者扩展将 HTTP POST 发送到在发生特定事件时配置的终结点。

本文介绍如何生成实现示例使用者服务的扩展。 示例使用者：

• 侦听三个 Git 事件：代码推送、拉取请求创建和拉取请求更新
• 将事件载荷通过 HTTP POST 发送到配置的终结点 URL

有关完整的源码，请见扩展示例 GitHub 存储库。 有关所有可用的事件类型，请参阅 服务挂钩事件类型。

服务挂钩的工作原理

服务挂钩有三个组件：

• 发布者 触发事件，例如“已推送代码”或“已创建拉取请求”。
• 订阅 将特定事件与操作匹配。
• 使用者 定义要运行的操作，例如发送 HTTP POST。

在本文中，扩展实现自定义使用者。 发生匹配事件时，使用者会将包含事件有效负载的 HTTP POST 发送到订阅中配置的终结点 URL。

创建扩展

1.设置项目

创建扩展项目。 有关说明，请参阅 开发 Web 扩展。

2.添加使用者贡献

将使用者贡献添加到 清单文件 （vss-extension.json）。 以下示例显示了具有服务挂钩使用者的完整清单：

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

数组 contributions 是关键部分。 每项贡献都定义了：

• 类型： ms.vss-servicehooks.consumer — 注册使用者服务
• 目标： ms.vss-servicehooks.consumers — 使用者服务集合
• 属性：使用者配置，包括输入和操作（请参阅 属性参考）

3. 打包、发布和测试

打包扩展并将其发布到 Azure DevOps 组织。 然后创建一个服务挂钩订阅，该订阅使用自定义使用者来验证它是否正常工作。

属性参考

使用者属性

操作属性

数组中的每个 actions 操作具有以下属性：

后续步骤

相关内容

• 服务挂钩使用者
• 服务挂钩的可用服务
• 以编程方式创建服务挂钩订阅
• 扩展示例 GitHub 存储库
• 事件类型列表