扩展点

Azure DevOps Services | Azure DevOps Server 2020 | Azure DevOps Server 2019 | TFS 2018

扩展通过贡献新功能来增强Azure DevOps用户体验。 在本文中,我们重点介绍扩展可以面向的最常见扩展点。 若要详细了解Azure DevOps扩展性模型,请参阅“贡献”模型以获取概述。

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

中心和中心组

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

可定向中心组

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

名称 ID Level 预览图像
Azure Boards ms.vss-work-web.work-hub-group Project/团队 Custom hub added to Azure Boards.
Azure Repos ms.vss-code-web.code-hub-group Project/团队 Custom hub added to Azure Repos.
Azure Pipelines ms.vss-build-web.build-release-hub-group Project/团队 Custom hub added to Azure Pipelines.
Azure Test Plans ms.vss-test-web.test-hub-group Project/团队 Custom hub added to Azure Test Plans.
项目设置 ms.vss-web.project-admin-hub-group Project Custom project admin hub.
组织设置 ms.vss-web.collection-admin-hub-group 组织或集合 Custom organization admin hub.
名称 ID Level 预览图像
代码 ms.vss-code-web.code-hub-group Project/团队 Custom code hub, TFS versions
工作 ms.vss-work-web.work-hub-group Project/团队 Custom work hub, TFS versions
生成和发布 ms.vss-build-web.build-release-hub-group Project/团队 Custom build and release hub, TFS versions
测试 ms.vss-test-web.test-hub-group Project/团队 Custom test hub, TFS versions
项目设置 ms.vss-web.project-admin-hub-group Project Custom project admin hub, TFS versions
集合设置 ms.vss-web.collection-admin-hub-group 集合 Custom collection admin hub, TFS versions

示例

此示例演示如何向代码中心组贡献中心:

{
    ...
    "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-webms定义。 此类型声明此类型的贡献所需的可选属性和必需属性, (例如名称、顺序等) 。
  • 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
       }

使用Office UI Fabric图标示例:

            "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
Project概述工具栏 ms.vss-admin-web.project-overview-toolbar-menu
Project概述团队网格 ms.vss-admin-web.teams-grid-menu

Azure Boards

“属性” 目标 ID 预览图像
工作项查询菜单 ms.vss-work-web.work-item-query-menu Custom query action added to query menu.
工作项查询结果工具栏菜单 ms.vss-work-web.work-item-query-results-toolbar-menu Query Results custom toolbar menu action
工作项查询结果菜单项 ms.vss-work-web.query-result-work-item-menu Query Result Item Menu custom action.
“工作项查询结果”选项卡 ms.vss-work-web.query-tabs Query toolbar custom pivot tab
上下文菜单的工作项 ms.vss-work-web.work-item-toolbar-menu Custom work item toolbar actions.
积压工作项菜单 ms.vss-work-web.backlog-item-menu Backlog item actions custom menu options.
冲刺板透视筛选器菜单 ms.vss-work-web.sprint-board-pivot-filter-menu Sprint Board Pivot Filter Actions.
板透视筛选器菜单 ms.vss-work-web.backlog-board-pivot-filter-menu Backlog Board Pivot Filter Actions.
卡片菜单 ms.vss-work-web.backlog-board-card-item-menu
产品积压工作选项卡 ms.vss-work-web.product-backlog-tabs Product Backlog Custom Tab
“迭代积压工作”选项卡 ms.vss-work-web.iteration-backlog-tabs Iterations Backlog Custom Tab
项目组合积压工作窗格 ms.vss-work-web.portfolio-backlog-toolpane Portfolio Backlog Custom Pane
产品积压工作窗格 ms.vss-work-web.requirement-backlog-toolpane Product Backlog Custom Pane
迭代积压工作窗格 ms.vss-work-web.iteration-backlog-toolpane Iteration Backlog Custom Pane

工作

“属性” 目标 ID 预览图像
工作项查询菜单 ms.vss-work-web.work-item-query-menu Custom query action added to query menu, TFS versions
工作项查询结果工具栏菜单 ms.vss-work-web.work-item-query-results-toolbar-menu Query Results custom toolbar menu action, TFS versions
工作项查询结果菜单项 ms.vss-work-web.query-result-work-item-menu Query Result Item Menu custom action, TFS versions
“工作项查询结果”选项卡 ms.vss-work-web.query-tabs Query toolbar custom pivot tab, TFS versions
上下文菜单的工作项 ms.vss-work-web.work-item-toolbar-menu Custom work item toolbar actions, TFS versions
积压工作项菜单 ms.vss-work-web.backlog-item-menu Backlog item actions custom menu options, TFS versions
冲刺板透视筛选器菜单 ms.vss-work-web.sprint-board-pivot-filter-menu Sprint Board Pivot Filter Actions, TFS versions
板透视筛选器菜单 ms.vss-work-web.backlog-board-pivot-filter-menu Backlog Board Pivot Filter Actions, TFS versions
卡片菜单 ms.vss-work-web.backlog-board-card-item-menu
产品积压工作选项卡 ms.vss-work-web.product-backlog-tabs Product Backlog Custom Tab, TFS versions
“迭代积压工作”选项卡 ms.vss-work-web.iteration-backlog-tabs Iterations Backlog Custom Tab, TFS versions
项目组合积压工作窗格 ms.vss-work-web.portfolio-backlog-toolpane Portfolio Backlog Custom Pane, TFS versions
产品积压工作窗格 ms.vss-work-web.requirement-backlog-toolpane Product Backlog Custom Pane, TFS versions
迭代积压工作窗格 ms.vss-work-web.iteration-backlog-toolpane Iteration Backlog Custom Pane, TFS versions

Azure Pipelines

“属性” 目标 ID 预览
已完成生成菜单 ms.vss-build-web.completed-build-menu Completed Build Actions
“生成定义”菜单 ms.vss-build-web.build-definition-menu Build Definition Actions
测试结果工具栏操作 ms.vss-test-web.test-results-actions-menu Test Results Toolbar Action
“测试结果详细信息”选项卡 ms.vss-test-web.test-result-details-tab-items Test Result Details Tab
发布管道资源管理器上下文菜单 ms.vss-releaseManagement-web.release-definition-explorer-context-menu Definition Explorer Context Menu
“发布管道资源管理器”工具栏菜单 ms.vss-releaseManagement-web.release-definition-explorer-toolbar-menu Definition Explorer Toolbar Menu
“发布摘要”工具栏菜单 ms.vss-releaseManagement-web.release-editor-tool-bar-menu Release Summary Toolbar Menu
“发布摘要”选项卡 ms.vss-releaseManagement-web.release-details-view Release Summary Tab
发布摘要部分 ms.vss-releaseManagement-web.release-details-summary-tab Release Summary Section

Azure Pipelines

“属性” 目标 ID 预览
已完成生成菜单 ms.vss-build-web.completed-build-menu Completed Build Actions
“生成定义”菜单 ms.vss-build-web.build-definition-menu Build Definition Actions
测试结果工具栏操作 ms.vss-test-web.test-results-actions-menu Test Results Toolbar Action
“测试结果详细信息”选项卡 ms.vss-test-web.test-result-details-tab-items Test Result Details Tab
发布管道资源管理器上下文菜单 ms.vss-releaseManagement-web.release-definition-explorer-context-menu Definition Explorer Context Menu
“发布管道资源管理器”工具栏菜单 ms.vss-releaseManagement-web.release-definition-explorer-toolbar-menu Definition Explorer Toolbar Menu
“发布摘要”工具栏菜单 ms.vss-releaseManagement-web.release-editor-tool-bar-menu Release Summary Toolbar Menu
“发布摘要”选项卡 ms.vss-releaseManagement-web.release-details-view Release Summary Tab
发布摘要部分 ms.vss-releaseManagement-web.release-details-summary-tab Release Summary Section
管道详细信息视图,标题按钮 ms.vss-build-web.pipelines-header-menu Pipeline details view, header menu
管道详细信息视图,文件夹上下文菜单 ms.vss-build-web.pipelines-folder-menu Pipeline details view, folder context menu

生成

“属性” 目标 ID 预览图像
已完成生成菜单 ms.vss-build-web.completed-build-menu Completed Build Actions, TFS versions
“生成定义”菜单 ms.vss-build-web.build-definition-menu Build Definition Actions, TFS versions
测试结果工具栏操作 ms.vss-test-web.test-results-actions-menu Test Results Toolbar Action, TFS versions
“测试结果详细信息”选项卡 ms.vss-test-web.test-result-details-tab-items Test Result Details Tab, TFS versions

发布

“属性” 目标 ID 预览
发布管道资源管理器上下文菜单 ms.vss-releaseManagement-web.release-definition-explorer-context-menu Definition Explorer Context Menu, TFS versions
“发布管道资源管理器”工具栏菜单 ms.vss-releaseManagement-web.release-definition-explorer-toolbar-menu Definition Explorer Toolbar Menu, TFS versions
“发布摘要”工具栏菜单 ms.vss-releaseManagement-web.release-editor-tool-bar-menu Release Summary Toolbar Menu, TFS versions
“发布摘要”选项卡 ms.vss-releaseManagement-web.release-details-view Release Summary Tab, TFS versions
发布摘要部分 ms.vss-releaseManagement-web.release-details-summary-tab Release Summary Section, TFS versions

Azure Repos

“属性” 目标 ID 预览图像
源项 (网格) 菜单 ms.vss-code-web.source-grid-item-menu Repos Item Grid Actions
源项 (树) 菜单 ms.vss-code-web.source-tree-item-menu Repos Item Tree Actions
源项 (网格和树) 菜单 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 Branches Tree
Git 拉取请求操作菜单 ms.vss-code-web.pull-request-action-menu Git Pull Request Actions
Git 拉取请求选项卡 (透视) ms.vss-code-web.pr-tabs Git Pull Request Tab
Git 提交列表菜单 ms.vss-code-web.git-commit-list-menu Git Commit List Menu
Git 提交详细信息菜单 ms.vss-code-web.git-commit-details-menu Git Commit Detail Menu

代码

名称 目标 ID 预览图像
源项 (网格) 菜单 ms.vss-code-web.source-grid-item-menu Source Item Grid Actions, TFS versions
源项 (树) 菜单 ms.vss-code-web.source-tree-item-menu Source Item Tree Actions, TFS versions
源项 (网格和树) 菜单 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 Branches Tree, TFS versions
Git 拉取请求操作菜单 ms.vss-code-web.pull-request-action-menu Git Pull Request Actions, TFS versions
Git 拉取请求选项卡 (透视) ms.vss-code-web.pr-tabs Git Pull Request Tab, TFS versions
Git 提交列表菜单 ms.vss-code-web.git-commit-list-menu Git Commit List Menu, TFS versions
Git 提交详细信息菜单 ms.vss-code-web.git-commit-details-menu Git Commit Detail Menu, TFS versions

Azure Test Plans

“属性” 目标 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 Test Hub Pivot Tab

测试

“属性” 目标 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 Test Hub Pivot Tab, TFS versions

仪表板

扩展可以贡献用户可添加到 仪表板的新小组件类型。 了解如何 贡献仪表板小组件

工作项窗体

工作项窗体由具有新节、选项卡、操作和自定义字段呈现器的扩展增强。 有关详细信息,请了解如何 扩展工作项窗体

Azure Pipelines任务

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

服务挂钩

“使用者”是事件在服务挂钩中发送到的服务。 扩展可以参与使用者服务。 这些服务由用户 (或以编程方式) 配置,以将事件发送到该服务。 有关详细信息,请参阅 参与服务挂钩使用者

功能

名字: 仅托管) 预览功能 (
目标 ID: ms.vss-web.managed-features

名字: 仅本地功能 ()
目标 ID: ms.vss-web.managed-features-onprem