扩展点

  • 项目

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

扩展通过贡献新功能来增强 Azure DevOps 用户体验。 在本文中，我们重点介绍扩展可以面向的最常见扩展点。 有关 Azure DevOps 扩展性模型的详细信息，请参阅 贡献模型。

贡献 指南扩展 是一个示例扩展。 将此扩展安装到组织中。 安装后，可以看到可用的扩展点。 建议将此扩展安装到个人或测试组织中。 此 扩展 的源也可用。 此外，请在此处查找存储库创建扩展点的示例。

有关详细信息，请参阅以下参考文献：

中心和中心组

中心和中心组是 Azure DevOps 中的主要导航元素。 文件、 发布、 积压工作和 查询 是中心的示例。 中心属于中心组。 例如，文件中心属于项目级 Azure Repos 中心组。 中心组可以存在于组织或集合级别或项目级别。 大多数扩展都有助于项目级别。

下表介绍了 Azure DevOps 中最常见的中心组，你可以为中心做出贡献。

名称 ID Level 预览图像
Azure Boards ms.vss-work-web.work-hub-group 项目/团队 添加到 Azure Boards 的自定义中心。
Azure Repos ms.vss-code-web.code-hub-group 项目/团队 添加到 Azure Repos 的自定义中心。
Azure Pipelines ms.vss-build-web.build-release-hub-group 项目/团队 已添加到 Azure Pipelines 的自定义中心。
Azure Test Plans ms.vss-test-web.test-hub-group 项目/团队 已添加到 Azure 测试计划的自定义中心。
项目设置 ms.vss-web.project-admin-hub-group 集成 自定义项目管理中心。
组织设置 ms.vss-web.collection-admin-hub-group 组织或集合 自定义组织管理中心。

示例

以下示例演示如何向代码中心组贡献中心：

{
    ...
    "contributions": [
        {
            "id": "my-custom-hub",
            "type": "ms.vss-web.hub",
            "targets": [
                "ms.vss-code-web.code-hub-group"
            ],
            "properties": {
                "name": "Code Hub",
                "order": 30,
                "uri": "/views/code/custom.html"
            }
        }
    ]
}
  • ms.vss-web.hub 是此贡献的类型。 此类型在 vss-web 发布者下发布的扩展中 ms 定义。 此类型声明此类型的贡献所需的可选属性和必需属性（例如，名称、顺序等）。
  • ms.vss-code-web.code-hub-group 是此中心所面向的中心组贡献的完整 ID。 此贡献在发布者下发布的扩展中ms声明vss-code-web
  • my-custom-hub 是此贡献的短 ID; {publisherId}.{extensionId}.my-custom-hub 是完整 ID

向菜单或工具栏添加图标

添加图标属性，以便可以直接按名称使用它。

建议提供自己的图标。 使用自己的图标示例：

           "name": "Sample hub",
           "uri": "dist/Hub/Hub.html",
           "icon": "asset://static/sample-icon.png",
           "supportsMobile": true
       }

使用 办公室 UI 结构图标示例：

            "iconName": "Code",
            "name": "Code Hub",
            "order": 30,
            "uri": "/views/code/custom.html"
        }

菜单和工具栏的设置

名称 目标 ID
组织/集合）概述工具栏 ms.vss-admin-web.collection-overview-toolbar-menu
集合概述项目网格 ms.vss-admin-web.projects-grid-menu
项目概述工具栏 ms.vss-admin-web.project-overview-toolbar-menu
项目概述团队网格 ms.vss-admin-web.teams-grid-menu

Azure Boards 菜单和工具栏

名称 目标 ID 预览图像
工作项查询菜单 ms.vss-work-web.work-item-query-menu 添加到查询菜单的自定义查询操作。
工作项查询结果工具栏菜单 ms.vss-work-web.work-item-query-results-toolbar-menu 查询结果自定义工具栏菜单操作
工作项查询结果菜单项 ms.vss-work-web.query-result-work-item-menu 查询结果项菜单自定义操作。
“工作项查询结果”选项卡 ms.vss-work-web.query-tabs 查询工具栏自定义透视选项卡
上下文菜单的工作项 ms.vss-work-web.work-item-toolbar-menu 自定义工作项工具栏操作。
积压工作项菜单 ms.vss-work-web.backlog-item-menu 积压工作项操作自定义菜单选项。
冲刺板透视筛选器菜单 ms.vss-work-web.sprint-board-pivot-filter-menu 冲刺板透视筛选器操作。
板透视筛选器菜单 ms.vss-work-web.backlog-board-pivot-filter-menu 积压板透视筛选器操作。
卡片菜单 ms.vss-work-web.backlog-board-card-item-menu
产品积压工作选项卡 ms.vss-work-web.product-backlog-tabs 产品积压工作自定义选项卡
“迭代积压工作”选项卡 ms.vss-work-web.iteration-backlog-tabs 迭代积压工作自定义选项卡
项目组合积压工作窗格 ms.vss-work-web.portfolio-backlog-toolpane 项目组合积压工作自定义窗格
产品积压工作窗格 ms.vss-work-web.requirement-backlog-toolpane 产品积压工作自定义窗格
迭代积压工作窗格 ms.vss-work-web.iteration-backlog-toolpane 迭代积压工作自定义窗格

Azure Pipelines 菜单和工具栏

名称 目标 ID 预览
已完成的生成菜单 ms.vss-build-web.completed-build-menu 已完成的生成操作
“生成定义”菜单 ms.vss-build-web.build-definition-menu 生成定义操作
测试结果工具栏操作 ms.vss-test-web.test-results-actions-menu 测试结果工具栏操作
“测试结果详细信息”选项卡 ms.vss-test-web.test-result-details-tab-items “测试结果详细信息”选项卡
发布管道资源管理器上下文菜单 ms.vss-releaseManagement-web.release-definition-explorer-context-menu 定义资源管理器上下文菜单
发布管道资源管理器工具栏菜单 ms.vss-releaseManagement-web.release-definition-explorer-toolbar-menu 定义资源管理器工具栏菜单
“发布摘要”工具栏菜单 ms.vss-releaseManagement-web.release-editor-tool-bar-menu 发布摘要工具栏菜单
“发布摘要”选项卡 ms.vss-releaseManagement-web.release-details-view “发布摘要”选项卡
发布摘要部分 ms.vss-releaseManagement-web.release-details-summary-tab 发布摘要部分

Azure Pipelines 菜单和工具栏

名称 目标 ID 预览
已完成的生成菜单 ms.vss-build-web.completed-build-menu 已完成的生成操作
“生成定义”菜单 ms.vss-build-web.build-definition-menu 生成定义操作
测试结果工具栏操作 ms.vss-test-web.test-results-actions-menu 测试结果工具栏操作
“测试结果详细信息”选项卡 ms.vss-test-web.test-result-details-tab-items “测试结果详细信息”选项卡
发布管道资源管理器上下文菜单 ms.vss-releaseManagement-web.release-definition-explorer-context-menu 定义资源管理器上下文菜单
发布管道资源管理器工具栏菜单 ms.vss-releaseManagement-web.release-definition-explorer-toolbar-menu 定义资源管理器工具栏菜单
“发布摘要”工具栏菜单 ms.vss-releaseManagement-web.release-editor-tool-bar-menu 发布摘要工具栏菜单
“发布摘要”选项卡 ms.vss-releaseManagement-web.release-details-view “发布摘要”选项卡
发布摘要部分 ms.vss-releaseManagement-web.release-details-summary-tab 发布摘要部分
管道详细信息视图，标题按钮 ms.vss-build-web.pipelines-header-menu 管道详细信息视图，标题菜单
管道详细信息视图，文件夹上下文菜单 ms.vss-build-web.pipelines-folder-menu 管道详细信息视图，文件夹上下文菜单

Azure Pipelines 任务

任务在生成或发布中执行工作。 有关详细信息，请了解如何 参与生成或发布任务。

Azure Repos 菜单和工具栏

名称 目标 ID 预览图像
源项（网格）菜单 ms.vss-code-web.source-grid-item-menu 存储库项网格操作
源项（树）菜单 ms.vss-code-web.source-tree-item-menu 存储库项树操作
源项（网格和树）菜单 ms.vss-code-web.source-item-menu
更改列表项菜单 ms.vss-code-web.change-list-item-menu
更改列表摘要项菜单 ms.vss-code-web.change-list-summary-item-menu
Git 分支树菜单 ms.vss-code-web.git-branches-tree-menu Git 分支树
Git 拉取请求操作菜单 ms.vss-code-web.pull-request-action-menu Git 拉取请求操作
Git 拉取请求选项卡（透视表） ms.vss-code-web.pr-tabs Git 拉取请求选项卡
Git 提交列表菜单 ms.vss-code-web.git-commit-list-menu Git 提交列表菜单
Git 提交详细信息菜单 ms.vss-code-web.git-commit-details-menu Git 提交详细信息菜单

Azure 测试计划菜单和工具栏

名称 目标 ID 预览图像
测试运行网格菜单 ms.vss-test-web.test-run-grid-menu
测试计划套件树菜单 ms.vss-test-web.test-plans-suites-context
测试计划中心透视选项卡 ms.vss-test-web.test-plan-pivot-tabs “测试中心透视”选项卡

其他扩展点

  • 仪表板小组件：扩展可以贡献用户可添加到仪表板的新类型的小组件。 了解如何参与仪表板小组件。
  • 工作项窗体：工作项窗体由扩展增强，其中包含新的节、选项卡、操作和自定义字段呈现器。 有关详细信息，请了解如何 扩展工作项窗体。
  • 服务挂钩：“使用者”是事件在服务挂钩中发送到的服务。 扩展可以参与使用者服务。 这些服务由用户（或以编程方式）配置为将事件发送到该服务。 有关详细信息，请参阅 参与服务挂钩使用者。
  • 功能：

名称： 预览功能（仅托管）
目标 ID： ms.vss-web.managed-features

名称： 功能（仅限本地）
目标 ID： ms.vss-web.managed-features-onprem