Azure DevOps Services |Azure DevOps Server |Azure DevOps Server 2022 |Azure DevOps Server 2020
扩展将功能添加到 Azure DevOps UI 和 REST 图面。 本文列出了您可以针对的最常见扩展点,并显示您在扩展清单中使用的 ID。 有关扩展模型和贡献模式的概述,请参阅 贡献模型。
小窍门
如果要启动新的 Azure DevOps 扩展,请先尝试这些维护的示例集合 -- 它们适用于当前产品版本并涵盖新式方案(例如,在拉取请求页上添加选项卡)。
- Azure DevOps 扩展示例 (GitHub)-一个演示常见扩展模式的紧凑初学者示例: https://github.com/microsoft/azure-devops-extension-sample
- Azure DevOps 扩展样例(旧版集合和贡献指南),安装以检查用户界面目标或查看源:https://marketplace.visualstudio.com/items/ms-samples.samples-contributions-guide 和 https://github.com/Microsoft/vso-extension-samples/tree/master/contributions-guide
- Microsoft Learn 示例(浏览 Azure DevOps 示例)- 跨 Microsoft 文档的精选、最新的示例:/samples/browse/?terms=azure%20devops%20extension
如果某个示例在组织中不起作用,请将其安装到个人或测试组织中,并将扩展清单的目标 ID 和 API 版本与当前文档进行比较。有关参考和 API,请参阅:
中心和中心组
中心和中心组在 Azure DevOps 中提供主要导航(例如 文件、 发布、 积压工作、 查询)。 中心属于中心组;例如, 文件 中心属于项目级 Azure Repos 中心组。 中心组可以存在于组织/集合级别或项目级别。 大多数扩展在项目级别作出贡献。
下表列出了常见中心组及其贡献 ID。
| 名称 | ID | 级别 | 预览图像 |
|---|---|---|---|
| Azure Boards | ms.vss-work-web.work-hub-group |
项目/团队 |
|
| Azure Repos | ms.vss-code-web.code-hub-group |
项目/团队 |
|
| Azure Pipelines | ms.vss-build-web.build-release-hub-group |
项目/团队 |
|
| Azure Test Plans | ms.vss-test-web.test-hub-group |
项目/团队 |
|
| 项目设置 | 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是此 Hub 所针对的 Hub 组贡献的完整 ID。 此贡献在发布者下vss-code-web发布的扩展中ms声明。 -
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
}
"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-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-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 拉取请求操作菜单 | ms.vss-code-web.pull-request-action-menu |
|
| Git 拉取请求选项卡(透视表) | ms.vss-code-web.pr-tabs |
|
| Git 提交列表菜单 | ms.vss-code-web.git-commit-list-menu |
|
| Git 提交详细信息菜单 | ms.vss-code-web.git-commit-details-menu |
|
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 |
|
其他扩展性点
- 仪表板小组件:扩展可以贡献用户 可添加到仪表板的新类型的小组件。 了解如何 参与仪表板小组件。
- 工作项窗体:工作项窗体由扩展增强,其中包含新的节、选项卡、操作和自定义字段呈现器。 有关详细信息,请了解如何 扩展工作项窗体。
- Service hooks: 使用者 是在 Service Hook 中将事件发送到的服务。 扩展可以参与使用者服务。 这些服务由用户(或以编程方式)配置为将事件发送到该服务。 有关更多信息,请参阅 为服务挂钩创建自定义使用者。
-
功能: 名称: 预览功能(仅限托管)
目标 ID: ms.vss-web.managed-features
-
功能: 名称: 功能(仅限本地)
目标 ID: ms.vss-web.managed-features-onprem