Справочник по типам ссылок

Azure DevOps Services | Azure DevOps Server 2022 — Azure DevOps Server 2019

Вы можете использовать различные типы ссылок для управления различными связями между рабочими элементами и другими артефактами, такими как сборки, фиксации, запросы на вытягивание и многое другое. В этой статье описаны следующие типы ссылок.

  • Тип рабочей ссылки: ссылки на рабочие элементы, включая выбор рабочих элементов управления тестовых случаев
  • Гиперссылка: Подключение рабочий элемент в любой URL-адрес или сетевую папку
  • Тип внешней ссылки: Подключение рабочий элемент во внешний объект, например объект кода, сборка или вики-страница
  • Тип канала удаленной работы: Подключение рабочие элементы, определенные в разных организациях
  • Тип ссылки GitHub: Подключение рабочий элемент в фиксацию, ошибку или запрос на вытягивание репозитория GitHub.

Определенное поле поддерживает количество ссылок для первых четырех типов ссылок, таких как число связанных ссылок, количество гиперссылок, число внешних ссылок и число удаленных ссылок.

  • Тип рабочей ссылки: ссылки на рабочие элементы, включая выбор рабочих элементов управления тестом
  • Гиперссылка: подключает рабочий элемент к любому URL-адресу или сетевому ресурсу
  • Тип внешней ссылки: подключает рабочий элемент к внешнему объекту, например объекту кода, сборке или вики-странице
  • Тип ссылки GitHub: подключает рабочий элемент к фиксации или запросу на вытягивание репозитория GitHub.

Определенное поле поддерживает количество ссылок для первых трех типов ссылок, таких как число связанных ссылок, число гиперссылок и число внешних ссылок.

Типы ссылок подвергаются определенным ограничениям на основе их топологии. Используйте инструкции, приведенные в следующих таблицах, чтобы выбрать тип ссылки, используемый на основе типов запросов и отчетов, которые вы хотите создать. Дополнительные сведения о различных топологиях см. в статье "Топологии типов ссылок" и "Ограничения".

Типы рабочих ссылок — это системные, определяемые процессом или определяемые пользователем (пользовательские). Ссылки, перечисленные в следующей таблице, определяются системой.

Каждый тип рабочей ссылки определяет метки ссылок, тип топологии и ограничения, используемые при создании связей между рабочими элементами. Например, тип ссылки "родительский-дочерний" определяет две метки: "Родительский" и "Дочерний". Тип ссылки также поддерживает иерархическую топологию или топологию дерева и предотвращает создание циклических ссылок между рабочими элементами.

Концептуальное изображение типа ссылки

Число связанных ссылок рабочего элемента соответствует сумме всех ссылок, определенных с типом рабочей ссылки.

В следующей таблице описаны типы ссылок рабочего элемента, которые можно указать, чтобы область элемент управления ссылками с помощью XML-элемента WorkItemLinksFilter.

Имя

Имя ссылки

Использование


Затронутые (только CMMI) Концептуальное изображение типа ссылки Концептуальное изображение затронутого типа ссылки.

Microsoft.VSTS.Common.Affects-Forward
Microsoft.VSTS.Common.Affects-Reverse
Тип топологии: зависимость
Категория ссылок: определяемая процессом

Используйте эту направленную ссылку для создания связей между любым набором рабочих элементов, но не теми, которые будут создавать закрытые циклы. Обычно используется для отслеживания запросов на изменение, внесенных в требования.

Ограничения и рекомендации:

  • Запрос на изменение можно связать только с одним требованием с помощью "Влияет". Требования можно связать с количеством запросов на изменение ребенка по мере необходимости с помощью затронутых.
  • Для связывания рабочих элементов в одном проекте используйте только затронутые последствия. Мы рекомендуем это действие, если вы планируете использовать Excel для изменения или обновления данных рабочего элемента.

Дочерний родитель
Концептуальное изображение типа дочерней ссылки.
Концептуальное изображение типа родительской ссылки.

System.LinkTypes.Hierarchy-Forward
System.LinkTypes.Hierarchy-Reverse
Тип топологии: дерево
Категория ссылок: определяемая системой

Используйте эту направленную ссылку для создания связей "один ко многим" между одним родительским элементом или несколькими дочерними элементами. Используется для упорядочивания рабочего элемента в иерархии. Эту иерархию можно быстро создать среди элементов невыполненной работы с помощью функции сопоставления или между элементами и задачами невыполненной работы с помощью невыполненной работы или области задач спринта.

Типичные варианты использования включают:

  • Обслуживание связей сводки задач. Ссылки на родительские дочерние элементы создаются для суммарных задач и их подчиненных задач.
  • Связывание задач с PBIs, историями пользователей или требованиями. Поддерживает отчеты "Обзор невыполненных работ", "Обзор историй" и "Общие сведения о требованиях".

Ограничения и рекомендации:

  • Используйте Excel для массового редактирования рабочих элементов и ссылок родительского дочернего элемента. См. статью "Массовое добавление или изменение рабочих элементов" в Excel.
  • Рабочий элемент может иметь только один родительский элемент. Родительский рабочий элемент может иметь много дочерних элементов.
  • Для связывания рабочих элементов в одном проекте используйте только ссылки на родительские дочерние элементы. Это действие рекомендуется, если вы планируете использовать Excel для изменения или обновления данных рабочего элемента.

Дублирование дубликатаКонцептуальное изображение дубликата дерева вперед.Концептуальное изображение дубликата дерева обратно.

System.LinkTypes.Duplicate-Forward
System.LinkTypes.Duplicate-Reverse
Тип топологии: дерево
Категория ссылок: определяемая системой

Используйте эту направленную ссылку для создания связей "один ко многим" между одним родительским элементом или несколькими дочерними элементами. Используется для отслеживания задач, ошибок или других рабочих элементов, повторяющихся друг друга.

Ограничения и рекомендации:

  • Рабочий элемент может иметь только один дубликат.
  • Для связывания рабочих элементов в одном проекте используйте только повторяющиеся или повторяющиеся ссылки. Это действие рекомендуется, если вы планируете использовать Excel для изменения или обновления данных рабочего элемента.

Ссылки на ссылки
Концептуальное изображение протестированного по типу ссылки.Концептуальное изображение типа ссылки Test.

Microsoft.VSTS.TestCase.
SharedParameterReferencedBy
Тип топологии: зависимость
Категория ссылок: определяемая процессом

Используется для связывания тестовых вариантов с общими параметрами. Используется для связывания тестовых вариантов с общими параметрами для поддержки возможности повторения теста с различными данными. Как правило, вы не добавите этот тип ссылки в элемент управления область ссылок.

Связанным с
Концептуальное изображение типа связанной ссылки.

System.LinkTypes.Related
Тип топологии: сеть
Категория ссылок: определяемая системой

Используйте эту ненаправленную ссылку для создания связей между любым набором рабочих элементов. Используется для связывания рабочих элементов, которые находятся на одном уровне, например двух пользовательских историй, определяющих функции, перекрывающие друг друга. Тип связанной ссылки создает простые связи с небольшими ограничениями.

  • Связаны рабочие элементы, которые находятся на одном уровне, например две пользовательские истории, определяющие функции, перекрывающие друг друга.
  • Связывание рабочих элементов, определенных в разных проектах и управляемых различными командами.
  • Поиск и просмотр рабочих элементов и связанных рабочих элементов в двухуровневом представлении.
  • Создание простых связей с небольшими ограничениями.

Преемник-предшественник
Концептуальное изображение зависимости преемника, переадресация.Концептуальное изображение зависимости предшественника, обратное.

System.LinkTypes.Dependency

Тип топологии: зависимость
Категория ссылок: определяемая системой
Выберите тип ссылки "Предшественник " при связывании с рабочим элементом, который должен быть завершен перед связыванием рабочего элемента. Выберите тип ссылки "Преемник" при связывании с рабочим элементом, который должен быть завершен после связывания рабочего элемента.

Используйте эту направленную ссылку для создания связей между любым набором рабочих элементов, но не теми, которые будут создавать закрытые циклы. Используйте для отслеживания задач, которые должны быть завершены до запуска других пользователей. Связанные задачи представлены в виде ссылок на предшественников в Azure Boards.

  • Отслеживайте задачи, которые необходимо выполнить до запуска других пользователей.
  • Поддерживает связи "один ко многим".
  • Поиск и просмотр предыдущих рабочих элементов и их преемников в двухуровневом представлении запросов прямых ссылок.

Ограничения и рекомендации:

  • При попытке создать ссылки, определяющие циклические связи, возникает ошибка.
  • Создание ссылок предшественника-преемника только на рабочие элементы, находящиеся в одном проекте. Вы можете создавать связи предшественников-преемников между рабочими элементами, определенными в разных проектах. Но если вы экспортируете запрос в Excel, импортируются только те рабочие элементы, определенные для проекта, для которого определен запрос.

Тесты, проверенные путем тестирования
Концептуальное изображение протестированного по типу ссылки.Концептуальное изображение типа ссылки Test.

Microsoft.VSTS.Common.TestedBy-Forward
Microsoft.VSTS.Common.TestedBy-Reverse
Тип топологии: зависимость
Категория ссылок: определяемая процессом

Связывание тестовых вариантов с рабочими элементами, такими как ошибки, истории пользователей, требования и элементы невыполненной работы продукта. Используйте для отслеживания тестовых случаев, которые тестируют истории пользователей (Agile), элементы невыполненной работы продукта (Scrum) или требования (CMMI). Также может ссылаться на другие типы рабочих элементов, такие как ошибки, проблемы или задачи. Для локальной среды Azure DevOps существует несколько отчетов SQL, зависящих от этих ссылок. Ознакомьтесь с действиями группы для поддержки полезных отчетов.

Тестовые действия, используемые для общего обращения
Концептуальное изображение протестированного по типу ссылки.Концептуальное изображение типа ссылки Test.

Microsoft.VSTS.TestCase.
SharedStepReferencedBy
Тип топологии: зависимость
Категория ссылок: определяемая процессом

Используйте для связывания тестовых вариантов с общими шагами. Совместное использование шагов между тестами , чтобы избежать необходимости создавать несколько записей одной последовательности шагов.

Гиперссылка может связать рабочий элемент с любым URL-адресом. Счетчик гиперссылок отслеживает количество гиперссылок к рабочему элементу.

Концептуальное изображение гиперссылки.

Имя ссылки

Поддерживаемый инструмент

Тип артефакта

Использование


Гиперссылка

Отслеживание рабочих элементов

Гиперссылка

Используется для связывания рабочего элемента с URL-адресом. Гиперссылка рабочего элемента — это имя этого типа ссылки в API типов ссылок артефактов.

Типы внешних ссылок — это системные типы ссылок, поддерживающие связывание рабочих элементов с другими объектами, хранящимися в Azure DevOps, как показано на следующем рисунке. Число внешних ссылок рабочего элемента соответствует сумме всех ссылок, определенных с типом внешней ссылки.

Концептуальное изображение типа внешней ссылки.

Примечание.

Для ссылки на объект Azure DevOps можно использовать только внешний тип ссылки. Чтобы связать рабочие элементы с другими объектами за пределами Azure DevOps, используйте гиперссылку.

В следующей таблице описаны типы внешних ссылок, которые можно выбрать при добавлении типа ссылки из рабочего элемента или тестового случая.

В следующей таблице описаны типы внешних ссылок, которые можно выбрать при добавлении типа ссылки из рабочего элемента или тестового случая. Кроме того, можно указать один из этих типов ссылок, чтобы область элемент управления ссылками с помощью XML-элемента ExternalLinksFilter.

Имя ссылки

Поддерживаемый инструмент

Тип артефакта

Использование


Ветвь

Git

Ветвь

Используется для связывания рабочего элемента с ветвью.

Конвейеры и сборка

Сборка

Сборка

Используется для связывания рабочего элемента со сборкой.

Набор изменений (или исправлен в наборе изменений)

VersionControl

Изменений

Используется для связывания рабочего элемента с набором изменений.

Фиксация (или исправлена в фиксации)

Git

Commit

Используется для связывания рабочего элемента с фиксацией.

Найдено в сборке

Конвейеры и сборка

Сборка

Используется для связывания рабочего элемента со сборкой.

Интегрированная в сборку

Сборка

Создание конвейера

Используется для связывания рабочего элемента со сборкой.

Интегрированная в среду выпуска

Выпуск

Конвейер выпуска

Используется для связывания выпуска с рабочим элементом. Система создает ссылку этого типа, когда пользователь включает состояние развертывания отчета в Work для определения выпуска.

Запрос на вытягивание

Git

PullRequestId

Используется для связывания рабочего элемента с запросом на вытягивание.

Вложение результатов

Управление тестированием

TcmResultAttachment

Используется для связывания рабочего элемента с вложением, связанным с результатом теста. Эти ссылки отображаются при связывании рабочего элемента с результатом теста из Test или Microsoft Test Manager.

Файл исходного кода<

VersionControl

LatestItemVersion

Используется для связывания рабочего элемента с файлом в элементе управления версиями Team Foundation (TFVC).

Раскадровка

Требования

Раскадровка

Используется для связывания рабочего элемента с файлом PowerPoint или другим файлом, содержащим сведения о раскадрование в сети.

Тег

Git

Тег

Используется для связывания рабочего элемента с тегом, определенным для фиксации или репозитория Git. Дополнительные сведения см. в разделе "Работа" из командной строки Git.

Результат теста

Управление тестированием

TcmResult

Используется для связывания рабочего элемента с результатом теста. Эти ссылки отображаются при связывании рабочего элемента с результатом теста из Test или Microsoft Test Manager.

Элемент с версиями

VersionControl

LatestItemVersion

Используется для связывания рабочего элемента с файлом или набором изменений, определенным в репозитории TFVC. Файл исходного кода — это имя этого типа ссылки в API типов ссылок артефактов.

Вики

Вики

Вики

Используется для связывания рабочего элемента с вики-страницей. Поддерживается для TFS 2018.2 и более поздних версий.

Типы ссылок GitHub определяются системой и поддерживают связывание рабочих элементов с объектами GitHub, как показано на следующем рисунке.

Концептуальное изображение типа ссылки GitHub.

Концептуальное изображение типа ссылки GitHub.

Внимание

Вы можете ссылаться только на артефакты GitHub с репозиториями, подключенными к Azure Boards.

В следующей таблице описаны типы ссылок GitHub, которые можно выбрать при добавлении типа ссылки из рабочего элемента.

Имя ссылки

Тип артефакта

Использование


Фиксация GitHub

Фиксация репозитория GitHub

Используется для связывания рабочего элемента с фиксацией GitHub.

Проблема с GitHub

Проблема с репозиторием GitHub

Используется для связывания рабочего элемента с проблемой GitHub.

Запрос на вытягивание GitHub

Запрос на вытягивание репозитория GitHub

Используется для связывания рабочего элемента с запросом на вытягивание GitHub.

Типы ссылок удаленной работы — это системные типы ссылок, поддерживающие связывание рабочих элементов, определенных в разных организациях, если тот же идентификатор Microsoft Entra ID управляет ими, как описано в Подключение организации с идентификатором Microsoft Entra.

Число удаленных ссылок рабочего элемента соответствует сумме всех ссылок, определенных с типом удаленной рабочей ссылки.

Имя

Имя ссылки

Использование


Используется из производства для
(топология зависимостей) Концептуальное изображение использования из топологии.Концептуальное изображение создаваемой топологии.

System.LinkTypes.Remote.Dependency-Forward
System.LinkTypes.Remote.Dependency-Reverse
Тип топологии: зависимость
Категория ссылок: определяемая системой

Используйте эту направленную ссылку для создания связей между рабочими элементами с зависимостями и определенными в разных организациях, если один и тот же идентификатор Microsoft Entra управляет ими. Обычно используется для отслеживания запросов на изменение, внесенных в требования.

Удаленные связи
Концептуальное изображение топологии удаленных связей.

System.LinkTypes.Remote.Related
Тип топологии: сеть
Категория ссылок: определяемая системой

Используйте эту ненаправленную ссылку для создания связей между рабочими элементами, определенными в разных организациях, если им управляет тот же идентификатор Microsoft Entra.

Можно создать пользовательский тип ссылки; экспорт и импорт определений типов ссылок; и удаление, активация, деактивация и повторная активация типов ссылок. См. следующие статьи:

Чтобы получить список типов ссылок, можно использовать один из поддерживаемых средств командной строки.

az boards work-item relation list-type

Вы можете перечислить типы ссылок, поддерживаемые вашей организацией, с помощью команды az boards work-item relation-type list или work Item Relation Types — List REST API. Сведения о начале работы см. в статье "Начало работы с Azure DevOps CLI".

az boards work-item relation list-type [--org]

Необязательные параметры

  • org: URL-адрес организации Azure DevOps. Вы можете настроить организацию по умолчанию с помощью az devops configure -d organization=ORG_URL. Требуется, если не настроено как по умолчанию или выбрано с помощью git config. Пример: --org https://dev.azure.com/MyOrganizationName/.

Пример

Следующая команда содержит типы ссылок рабочего элемента в формате таблицы, определенные для организации fabrikam.

az boards work-item relation list-type --org fabrikam --output table
Name                  ReferenceName                                                Enabled    Usage
--------------------  -----------------------------------------------------------  ---------  ------------
Produces For          System.LinkTypes.Remote.Dependency-Forward                   True       workItemLink
Consumes From         System.LinkTypes.Remote.Dependency-Reverse                   True       workItemLink
Duplicate             System.LinkTypes.Duplicate-Forward                           True       workItemLink
Duplicate Of          System.LinkTypes.Duplicate-Reverse                           True       workItemLink
Referenced By         Microsoft.VSTS.TestCase.SharedParameterReferencedBy-Forward  True       workItemLink
References            Microsoft.VSTS.TestCase.SharedParameterReferencedBy-Reverse  True       workItemLink
Tested By             Microsoft.VSTS.Common.TestedBy-Forward                       True       workItemLink
Tests                 Microsoft.VSTS.Common.TestedBy-Reverse                       True       workItemLink
Test Case             Microsoft.VSTS.TestCase.SharedStepReferencedBy-Forward       True       workItemLink
Shared Steps          Microsoft.VSTS.TestCase.SharedStepReferencedBy-Reverse       True       workItemLink
Successor             System.LinkTypes.Dependency-Forward                          True       workItemLink
Predecessor           System.LinkTypes.Dependency-Reverse                          True       workItemLink
Child                 System.LinkTypes.Hierarchy-Forward                           True       workItemLink
Parent                System.LinkTypes.Hierarchy-Reverse                           True       workItemLink
Related               System.LinkTypes.Related                                     True       workItemLink
Remote Related        System.LinkTypes.Remote.Related                              True       workItemLink
Attached File         AttachedFile                                                 True       resourceLink
Hyperlink             Hyperlink                                                    True       resourceLink
Artifact Link         ArtifactLink                                                 True       resourceLink

Формат JSON по умолчанию предоставляет дополнительные сведения об атрибутах, определенных для типов ссылок. Например, сведения о типах ссылок "Создание и использование из " перечислены следующим образом.

  {
    "attributes": {
      "acyclic": true,
      "directional": true,
      "editable": false,
      "enabled": true,
      "isForward": true,
      "oppositeEndReferenceName": "System.LinkTypes.Remote.Dependency-Reverse",
      "remote": true,
      "singleTarget": true,
      "topology": "dependency",
      "usage": "workItemLink"
    },
    "name": "Produces For",
    "referenceName": "System.LinkTypes.Remote.Dependency-Forward",
    "url": "https://dev.azure.com/mseng/_apis/wit/workItemRelationTypes/System.LinkTypes.Remote.Dependency-Forward"
  },
  {
    "attributes": {
      "acyclic": true,
      "directional": true,
      "editable": false,
      "enabled": true,
      "isForward": false,
      "oppositeEndReferenceName": "System.LinkTypes.Remote.Dependency-Forward",
      "remote": true,
      "singleTarget": true,
      "topology": "dependency",
      "usage": "workItemLink"
    },
    "name": "Consumes From",
    "referenceName": "System.LinkTypes.Remote.Dependency-Reverse",
    "url": "https://dev.azure.com/mseng/_apis/wit/workItemRelationTypes/System.LinkTypes.Remote.Dependency-Reverse"
  },

witadmin listlinktypes

Вы можете перечислить типы ссылок, поддерживаемые для коллекции проектов, с помощью witadmin listlinktypes средства командной строки или команды "Типы отношений рабочих элементов" — команда REST API списка .

Ниже перечислены типы ссылок для коллекции fabrikam-sever по умолчанию:

C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\Common7\IDE\CommonExtensions\Microsoft\TeamFoundation\Team Explorer>witadmin listlinktypes /collection:http://fabrikam-server/DefaultCollection

Reference Name: Microsoft.VSTS.TestCase.SharedParameterReferencedBy
Names: Referenced By, References
Topology: Dependency
Is Active: True

Reference Name: Microsoft.VSTS.Common.TestedBy
Names: Tested By, Tests
Topology: Dependency
Is Active: True

Reference Name: Microsoft.VSTS.TestCase.SharedStepReferencedBy
Names: Test Case, Shared Steps
Topology: Dependency
Is Active: True

Reference Name: System.LinkTypes.Duplicate
Names: Duplicate, Duplicate Of
Topology: Tree
Is Active: True

Reference Name: System.LinkTypes.Dependency
Names: Successor, Predecessor
Topology: Dependency
Is Active: True

Reference Name: System.LinkTypes.Hierarchy
Names: Child, Parent
Topology: Tree
Is Active: True

Reference Name: System.LinkTypes.Related
Name: Related
Topology: Network
Is Active: True

В следующей таблице приведены описания для каждого атрибута типа ссылки, возвращаемого интерфейсом командной строки Azure Boards или REST API.

Attribute

Description


Имена name

Указывает понятное имя, назначенное типам ссылок. Направления ссылок определяются в парах, поэтому включают в себя имя пересылки и обратного.

Имя ссылки, referenceName

Указывает имя, назначенное паре типов ссылок или типа ссылок.

acyclic

Указывает, разрешен ли тип ссылки (true) или ограничивает (false) циклические связи. Например, ссылки типа дерева ограничивают циклические связи. Дополнительные сведения см . в справочнике по элементам LinkTypes.

directional

Указывает, является ли тип ссылки направленным (true) или нет (false). Типы связей направления определяются в парах с компонентом пересылки и обратного. Дополнительные сведения см . в справочнике по элементам LinkTypes.

editable

Указывает, является ли тип ссылки редактируемым (true) или нет (false). Вы можете добавлять и изменять пользовательские типы ссылок для локальных развертываний с помощью witadmin средства командной строки "Управление типом ссылки". Типы системных ссылок всегда имеются editable=false.

Активен, enabled

Указывает, является ли тип ссылки активным (true) или нет (false). Пользовательские типы ссылок можно использовать только для локальных развертываний с помощью средства командной строки "Управление типом witadmin ссылки".

isForward

Указывает, указывает ли тип ссылки переадресацию (true) или нет (False) в паре типов ссылок.

oppositeEndReferenceName

Указывает имя ссылки типа ссылки, определяющего ссылку в противоположном направлении пары типов ссылок.

remote

Указывает, поддерживает ли тип ссылки привязку к удаленному рабочему элементу () илиtrue нет (False). Типы ссылок с remote=false требованием, что целевой рабочий элемент находится в той же организации или коллекции, что и источник рабочего элемента.

singleTarget

Указывает, разрешен ли тип ссылки для нескольких целевых (false) или ограничен одним целевым объектом (true).

topology

Указывает тип топологии — дерево сети, and зависимостей, . Описание см. в разделе "Топологии типов ссылок" и "Ограничения".

usage

Указывает тип использования — resourceLink или workItemLink. Значение workItemLink resourceLinkvalue indicates a link type that links two work items. Theуказывает тип ссылки, используемый для связывания рабочего элемента с ресурсом, например URL-адрес или вложение.

url

Перечисляет атрибуты типа ссылки в формате JSON.