Примечание.
Для доступа к этой странице требуется авторизация. Вы можете попробовать войти или изменить каталоги.
Для доступа к этой странице требуется авторизация. Вы можете попробовать изменить каталоги.
Сервисы Azure DevOps | Azure DevOps Server | Azure DevOps Server 2022
Расширения добавляют возможности в пользовательский интерфейс Azure DevOps и область REST. В этой статье перечислены наиболее распространенные точки расширяемости, которые можно использовать, и отображаются идентификаторы, используемые в манифесте расширения. Полный пример схемы манифеста см. в справочнике по манифесту расширения. Общие сведения о модели расширения и шаблонах вкладов см. в модели вклада.
Подсказка
Если вы создаёте новое расширение Azure DevOps, попробуйте сначала использовать эти поддерживаемые образцы коллекций — они работают с текущими сборками продуктов и охватывают современные сценарии (например, добавление вкладок на страницы pull request).
- Пример расширения Azure DevOps (GitHub) — компактный начальный пример, демонстрирующий распространенные шаблоны расширений: https://github.com/microsoft/azure-devops-extension-sample
- Примеры расширений Azure DevOps (коллекция устаревших версий и руководство по вкладам) — установите, чтобы проверить цели пользовательского интерфейса, или просмотрите исходный код: https://marketplace.visualstudio.com/items/ms-samples.samples-contributions-guidehttps://github.com/Microsoft/vso-extension-samples/tree/master/contributions-guide
- Примеры Microsoft Learn (просмотр примеров Azure DevOps) — подобранные, актуальные примеры в документации Microsoft: /samples/browse/?terms=azure%20devops%20extension
Если пример не работает в вашей организации, установите его в личную или тестовую организацию и сравните целевые идентификаторы манифеста расширения и версии API с текущими документами. Справочные материалы и API см. в статье:
Центры и группы концентраторов
Центры и группы концентраторов предоставляют основную навигацию в Azure DevOps (например, файлы, выпуски, невыполненные операции, запросы). Концентратор принадлежит группе концентраторов; Например, центр файлов принадлежит группе концентратора Azure Repos на уровне проекта. Группы концентраторов могут существовать на уровне организации или коллекции или на уровне проекта. Большинство расширений вносят вклад на уровне проекта.
В следующей таблице перечислены общие группы узлов и их идентификаторы участия.
| Имя. | идентификатор | Уровень | Предпросмотр изображения |
|---|---|---|---|
| Azure Boards | ms.vss-work-web.work-hub-group |
Проект/команда |
|
| Azure Repos | ms.vss-code-web.code-hub-group |
Проект/команда |
|
| Azure Pipelines (система конвейеров Azure) | ms.vss-build-web.build-release-hub-group |
Проект/команда |
|
| Планы тестирования Azure | 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, определяет этот тип и его обязательные и необязательные свойства, такие какnameиorder. -
ms.vss-code-web.code-hub-group— полный идентификатор группы концентраторов, целевой объект центра. -
my-custom-hub— короткий идентификатор этого вклада. Полный идентификатор .{publisherId}.{extensionId}.my-custom-hub
В следующей таблице перечислены свойства, доступные для ms.vss-web.hub вкладов:
| Недвижимость | Тип | Обязательный | Описание |
|---|---|---|---|
name |
струна | Да | Отображаемое имя, отображаемое в навигации концентратора |
order |
число/номер | Нет | Позиция относительно других центров (сначала отображаются более низкие значения) |
uri |
струна | Да | Относительный путь к HTML-странице содержимого центра |
icon |
струна | Нет | Пользовательский значок с помощью asset:// пути |
iconName |
струна | Нет | Имя значка пользовательского интерфейса Fluent |
supportsMobile |
булевый | Нет | Отображается ли концентратор на мобильных устройствах |
Подсказка
Если ваш вклад не отображается, проверьте точное соответствие целевого идентификатора — идентификаторы чувствительны к регистру. Перезагрузите расширение в браузере и проверьте консоль средств разработчика для ошибок загрузки расширений.
Добавление значка в меню или панель инструментов
icon
iconName Используйте свойство или свойство в вашем вкладе для отображения значка. При возможности укажите свой собственный значок.
Пользовательский значок:
"properties": {
"name": "Sample hub",
"uri": "dist/Hub/Hub.html",
"icon": "asset://static/sample-icon.png",
"supportsMobile": true
}
Значок пользовательского интерфейса Fluent:
"properties": {
"iconName": "Code",
"name": "Code Hub",
"order": 30,
"uri": "/views/code/custom.html"
}
Замечание
icon Свойства iconName работают только для центров, меню и панелей инструментов. Они не работают для вкладов табуляции.
Параметры меню и панелей инструментов
Эти целевые объекты применяются к страницам администрирования организации и проектов, а не к центрам, определенным службам, таким как Azure Boards или Azure Repos.
| Имя. | Идентификатор целевого объекта |
|---|---|
| Панель инструментов обзора организации или коллекции | 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
| Имя. | Идентификатор целевого объекта | Предпросмотр изображения |
|---|---|---|
| Меню запроса рабочего задания | 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
| Имя. | Идентификатор целевого объекта | Предварительный просмотр |
|---|---|---|
| Завершенное меню сборки | 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
| Имя. | Идентификатор целевого объекта | Предпросмотр изображения |
|---|---|---|
| Меню исходного элемента (сетки) | 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 |
|
| Меню операций Pull Request в 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" и панель инструментов
| Имя. | Идентификатор целевого объекта | Предпросмотр изображения |
|---|---|---|
| Меню сетки тестового запуска | ms.vss-test-web.test-run-grid-menu |
|
| Меню дерева комплектов тестового плана | ms.vss-test-web.test-plans-suites-context |
|
| Вкладка главного хаба тестового плана | ms.vss-test-web.test-plan-pivot-tabs |
|
Другие точки расширяемости
- Мини-приложение панели мониторинга — участие в новом типе мини-приложения, который пользователи могут добавлять на панель мониторинга. См. сведения о мини-приложении панели мониторинга.
- Форма рабочего элемента — добавление разделов, вкладок, действий или пользовательских отрисовщиков полей в форму рабочего элемента. См. раздел "Расширение формы рабочего элемента".
- Потребитель услуг — вносит вклад в службу потребителей, которая получает события от перехватчиков служб. См. статью "Создание пользовательского потребителя для перехватчиков служб".