Guia de referência para tipos de link

  • Artigo

Serviços de DevOps do Azure | Azure DevOps Server 2022 - Azure DevOps Server 2019

Você pode usar diferentes tipos de link para gerenciar as várias relações entre itens de trabalho e outros artefatos, como compilações, confirmações, solicitações pull e muito mais. Neste artigo, descrevemos os seguintes tipos de link.

  • Tipo de link de trabalho: vincula itens de trabalho, incluindo itens de trabalho de gerenciamento de casos de teste selecionados
  • Hiperlink: conecta um item de trabalho a qualquer URL ou compartilhamento de rede
  • Tipo de link externo: conecta um item de trabalho a um objeto externo, como um objeto de código, compilação ou página wiki
  • Tipo de link de trabalho remoto: conecta itens de trabalho definidos em diferentes organizações
  • Tipo de link do GitHub: conecta um item de trabalho a uma solicitação de confirmação, emissão ou pull do repositório GitHub.

Um campo específico mantém uma contagem de links para os primeiros quatro tipos de link, como Contagem de Link Relacionado, Contagem de Hiperlinks, Contagem de Links Externos e Contagem de Links Remotos.

  • Tipo de link de trabalho: vincula itens de trabalho, incluindo itens de trabalho de gerenciamento de casos de teste selecionados
  • Hiperlink: conecta um item de trabalho a qualquer URL ou compartilhamento de rede
  • Tipo de link externo: conecta um item de trabalho a um objeto externo, como um objeto de código, compilação ou página wiki
  • Tipo de link do GitHub: conecta um item de trabalho a uma solicitação commit ou pull do repositório GitHub.

Um campo específico mantém uma contagem de links para os três primeiros tipos de links, como Contagem de links relacionados, Contagem de hiperlinks e Contagem de links externos.

Os tipos de link estão sujeitos a certas restrições com base em sua topologia. Use as orientações fornecidas nas tabelas a seguir para escolher qual tipo de link usar com base nos tipos de consultas e relatórios que você deseja criar. Para saber mais sobre as diferentes topologias, consulte Topologias e restrições de tipo de link.

Os tipos de link de trabalho são definidos pelo sistema, pelo processo ou pelo usuário (personalizados). Os links listados na tabela a seguir são definidos pelo sistema.

Cada tipo de link de trabalho define os rótulos de link, o tipo de topologia e as restrições que são usados quando os links entre itens de trabalho são construídos. Por exemplo, o tipo de link pai-filho define dois rótulos: Pai e Filho. O tipo de link também oferece suporte a uma topologia hierárquica ou de árvore e impede que referências circulares sejam criadas entre itens de trabalho.

Imagem conceitual de um tipo de link de item de trabalho.

A Contagem de Link Relacionado de um item de trabalho corresponde à soma de todos os links definidos com um tipo de link de trabalho.

A tabela a seguir descreve os tipos de link de item de trabalho que você pode especificar para definir o escopo de um controle de links usando o elemento XML WorkItemLinksFilter.

Nome

Nome de referência

Utilização

Afeta-Afetado por (somente CMMI) Imagem conceitual do tipo de link Afeta.Imagem conceitual de Afetado pelo tipo de link.

Microsoft.VSTS.Common.Affects-Forward
Microsoft.VSTS.Common.Affects-Reverse
Tipo de topologia: Dependência
Categoria do link: Definido pelo processo

Use esse link direcional para criar links entre qualquer conjunto de itens de trabalho, mas não aqueles que criariam loops fechados. Normalmente usado para controlar solicitações de alteração feitas aos requisitos.

Restrições e recomendações:

  • Você pode vincular uma solicitação de alteração a apenas um requisito usando Afetos. Você pode vincular os requisitos a quantas solicitações de alteração de filho forem necessárias usando Afetado por.
  • Use apenas Affects-Affected by links para vincular itens de trabalho no mesmo projeto. Recomendamos essa ação se você planeja usar o Excel para modificar ou atualizar dados de item de trabalho.

Filho-pai
Imagem conceitual de um tipo de link filho.
Imagem conceitual de um tipo de link pai.

System.LinkTypes.Hierarchy-Forward
System.LinkTypes.Hierarchy-Reverse
Tipo de topologia: Árvore
Categoria do link: Definido pelo sistema

Use este link direcional para criar relações um-para-muitos entre um pai único para um ou mais itens filho. Use para organizar o item de trabalho dentro de uma hierarquia. Você pode criar rapidamente essa hierarquia entre itens da lista de pendências usando a função de mapeamento ou entre itens e tarefas da lista de pendências usando a lista de pendências da sprint ou o Quadro de tarefas.

Os usos típicos incluem:

  • Manter relações de resumo de tarefas. Os links pai-filho são criados para tarefas resumidas e suas tarefas subordinadas.
  • Vincule tarefas a PBIs, histórias de usuários ou requisitos. Suporta relatórios de Visão Geral da Lista de Pendências, Visão Geral de Histórias e Visão Geral de Requisitos.

Restrições e recomendações:

  • Use o Excel para editar em massa itens de trabalho e links pai-filho. Consulte Adicionar ou modificar itens de trabalho em massa com o Excel.
  • Um item de trabalho pode ter apenas um pai. Um item de trabalho dos pais pode ter muitos filhos.
  • Use apenas links pai-filho para vincular itens de trabalho no mesmo projeto. Essa ação é recomendada se você planeja usar o Excel para modificar ou atualizar dados de item de trabalho.

Duplicado-Duplicado deImagem conceptual de Duplicado da árvore para a frente.Imagem conceptual de Duplicado de árvore invertida.

System.LinkTypes.Duplicate-Forward
System.LinkTypes.Duplicado-Reverso
Tipo de topologia: Árvore
Categoria do link: Definido pelo sistema

Use este link direcional para criar relações um-para-muitos entre um pai único para um ou mais itens filho. Use para controlar tarefas, bugs ou outros itens de trabalho que são duplicados uns dos outros.

Restrições e recomendações:

  • Um item de trabalho pode ter apenas uma duplicata.
  • Use apenas links Duplicar ou Duplicar de para vincular itens de trabalho no mesmo projeto. Essa ação é recomendada se você planeja usar o Excel para modificar ou atualizar dados de item de trabalho.

Sub-Referências Referenciadas
Imagem conceitual de Testado por tipo de link.Imagem conceitual do tipo de link Testes.

Microsoft.VSTS.TestCase.
SharedParameterReferencedBy
Tipo de topologia: Dependência
Categoria do link: Definido pelo processo

Use para vincular casos de teste a parâmetros compartilhados. Use para vincular casos de teste a parâmetros compartilhados para dar suporte à capacidade de repetir um teste com dados diferentes. Em geral, você não adicionaria esse tipo de link a um controle de links com escopo.

Relacionados
Imagem conceitual do tipo Link relacionado.

System.LinkTypes.Related
Tipo de topologia: Rede
Categoria do link: Definido pelo sistema

Use esse link não direcional para criar links entre qualquer conjunto de itens de trabalho. Use para vincular itens de trabalho que estão no mesmo nível, como duas histórias de usuário que definem recursos que se sobrepõem. O tipo de link relacionado cria relações simples com poucas restrições.

  • Relacione itens de trabalho que estão no mesmo nível, como duas histórias de usuário que definem recursos que se sobrepõem.
  • Vincule itens de trabalho que são definidos em diferentes projetos e gerenciados por equipes diferentes.
  • Localize e exiba itens de trabalho e seus itens de trabalho relacionados em um modo de exibição de duas camadas.
  • Crie relações simples com poucas restrições.

Sucessor-Antecessor
Imagem conceptual da dependência do sucessor, para a frente.Imagem conceptual da dependência do antecessor, reverso.

System.LinkTypes.Dependency

Tipo de topologia: Dependência
Categoria do link: Definido pelo sistema
Escolha Tipo de link Predecessor ao vincular a um item de trabalho que deve ser concluído antes do item de trabalho do qual você está vinculando. Escolha Tipo de link sucessor ao vincular a um item de trabalho que deve ser concluído depois ao item de trabalho do qual você está vinculando.

Use esse link direcional para criar links entre qualquer conjunto de itens de trabalho, mas não aqueles que criariam loops fechados. Use para controlar tarefas que devem ser concluídas antes que outras possam ser iniciadas. As tarefas vinculadas são representadas como links predecessor-sucessor nos Painéis do Azure.

  • Rastreie tarefas que devem ser concluídas antes que outras possam ser iniciadas.
  • Suporta relações um-para-muitos.
  • Localize e visualize itens de trabalho predecessores e seus itens de trabalho sucessores em uma exibição de consulta de links diretos de duas camadas.

Restrições e recomendações:

  • Um erro aparece quando você tenta criar links que definem relações circulares.
  • Crie links predecessor-sucessor somente para itens de trabalho que estão dentro do mesmo projeto. Você pode criar links predecessor-sucessor entre itens de trabalho que são definidos em projetos diferentes. Mas, se você exportar uma consulta para o Excel, somente os itens de trabalho definidos para o projeto para o qual a consulta está definida serão importados.

Testado por testes
Imagem conceitual de Testado por tipo de link.Imagem conceitual do tipo de link Testes.

Microsoft.VSTS.Common.TestedBy-Forward
Microsoft.VSTS.Common.TestedBy-Reverse
Tipo de topologia: Dependência
Categoria do link: Definido pelo processo

Vincule casos de teste a itens de trabalho, como bugs, histórias de usuários, requisitos e itens da lista de pendências do produto. Use para rastrear casos de teste que testam histórias de usuários (Agile), itens de lista de pendências de produtos (Scrum) ou requisitos (CMMI). Também pode vincular a outros tipos de item de trabalho, como bugs, problemas ou tarefas. Para o Azure DevOps local, há vários relatórios SQL que dependem desses links. Consulte Revisar atividades da equipe para dar suporte a relatórios úteis.

Etapas compartilhadas de caso de teste
Imagem conceitual de Testado por tipo de link.Imagem conceitual do tipo de link Testes.

Microsoft.VSTS.TestCase.
SharedStepReferencedBy
Tipo de topologia: Dependência
Categoria do link: Definido pelo processo

Use para vincular casos de teste com etapas compartilhadas. Compartilhe etapas entre casos de teste para evitar ter que criar várias entradas da mesma sequência de etapas.

Um hiperlink pode vincular um item de trabalho a qualquer URL. A Contagem de Hiperlinks controla o número de hiperlinks para um item de trabalho.

Imagem conceptual de uma hiperligação.

Nome do link

Ferramenta suportada

Tipo de artefato

Utilização

Hiperligação

Acompanhamento de itens de trabalho

Hiperligação

Usado para vincular um item de trabalho a uma URL. Hiperlink de item de trabalho é o nome desse tipo de link na API de Tipos de Link de Artefato.

Os tipos de link externo são tipos de link definidos pelo sistema que dão suporte à vinculação de itens de trabalho a outros objetos armazenados no Azure DevOps, conforme mostrado na imagem a seguir. A Contagem de Link Externo de um item de trabalho corresponde à soma de todos os links definidos com um tipo de link externo.

Imagem conceptual do tipo Link externo.

Nota

Você só pode usar um tipo de link externo para vincular a um objeto DevOps do Azure. Para vincular itens de trabalho a outros objetos fora do Azure DevOps, use um hiperlink.

A tabela a seguir descreve os tipos de link externo que você pode escolher ao adicionar um tipo de link de um item de trabalho ou caso de teste.

A tabela a seguir descreve os tipos de link externo que você pode escolher ao adicionar um tipo de link de um item de trabalho ou caso de teste. Além disso, você pode especificar um desses tipos de link para definir o escopo de um controle de links usando o elemento XML ExternalLinksFilter.

Nome do link

Ferramenta suportada

Tipo de artefato

Utilização

Filial

Git

Filial

Usado para vincular um item de trabalho a uma ramificação.

Pipelines/Construção

Criar

Criar

Usado para vincular um item de trabalho a uma compilação.

Conjunto de alterações (ou Fixo no conjunto de alterações)

VersionControl

Conjunto de alterações

Usado para vincular um item de trabalho a um conjunto de alterações.

Commit (ou Fixed in Commit)

Git

Consolidação

Usado para vincular um item de trabalho a uma confirmação.

Encontrado na compilação

Pipelines/Construção

Criar

Usado para vincular um item de trabalho a uma compilação.

Integrado na construção

Criar

Pipeline de compilação

Usado para vincular um item de trabalho a uma compilação.

Integrado em ambiente de lançamento

Versão

Pipeline de versão

Usado para vincular uma versão a um item de trabalho. O sistema cria um link desse tipo quando um usuário habilita a opção Relatar status de implantação para Trabalhar para uma definição de versão.

Pull Request

Git

PullRequestId

Usado para vincular um item de trabalho a uma solicitação pull.

Anexo de resultados

Gestão de Testes

TcmResultAttachment

Usado para vincular um item de trabalho a um anexo associado a um resultado de teste. Esses links aparecem quando você associa um item de trabalho a um resultado de teste do Test ou Microsoft Test Manager.

Arquivo de código-fonte<

VersionControl

LatestItemVersion

Usado para vincular um item de trabalho a um arquivo em Controle de versão do Team Foundation (TFVC).

Storyboard

Requisitos

Storyboard

Usado para vincular um item de trabalho a um arquivo do PowerPoint ou outro arquivo que contenha informações de storyboard em uma rede.

Etiqueta

Git

Etiqueta

Usado para vincular um item de trabalho a uma tag definida para um repositório git commit ou git. Para obter mais informações, consulte Trabalhar a partir do prompt de comando do Git.

Resultado do teste

Gestão de Testes

TcmResultado

Usado para vincular um item de trabalho a um resultado de teste. Esses links aparecem quando você associa um item de trabalho a um resultado de teste do Test ou Microsoft Test Manager.

Item versionado

VersionControl

LatestItemVersion

Usado para vincular um item de trabalho a um arquivo ou conjunto de alterações definido em um repositório TFVC. Arquivo de código-fonte é o nome desse tipo de link na API de tipos de link de artefato.

Wiki

Wiki

Wiki

Usado para vincular um item de trabalho a uma página wiki. Suporte para TFS 2018.2 e versões posteriores.

Os tipos de link do GitHub são definidos pelo sistema e suportam a vinculação de itens de trabalho a objetos do GitHub, conforme mostrado na imagem a seguir.

Imagem conceitual do tipo de link do GitHub.

Imagem conceitual do tipo de link do GitHub.

Importante

Você só pode vincular a artefatos do GitHub com repositórios conectados aos Painéis do Azure.

A tabela a seguir descreve os tipos de link do GitHub que você pode escolher ao adicionar um tipo de link de um item de trabalho.

Nome do link

Tipo de artefato

Utilização

Confirmação do GitHub

Confirmação do repositório GitHub

Usado para vincular um item de trabalho a uma confirmação do GitHub.

Problema do GitHub

Problema do repositório GitHub

Usado para vincular um item de trabalho a um problema do GitHub.

Solicitação pull do GitHub

Solicitação pull do repositório GitHub

Usado para vincular um item de trabalho a uma solicitação pull do GitHub.

Os tipos de link de trabalho remoto são tipos de link definidos pelo sistema que oferecem suporte à vinculação de itens de trabalho definidos em diferentes organizações, desde que a mesma ID do Microsoft Entra os gerencie conforme descrito em Conectar sua organização à ID do Microsoft Entra.

A Contagem de Link Remoto de um item de trabalho corresponde à soma de todos os links definidos com um tipo de link de trabalho remoto.

Nome

Nome de referência

Utilização

Consome a partir de produzido para
(Topologia de dependência) Imagem conceitual da topologia Consumes From.Imagem conceitual da topologia Produced For.

System.LinkTypes.Remote.Dependency-Forward
System.LinkTypes.Remote.Dependency-Reverse
Tipo de topologia: Dependência
Categoria do link: Definido pelo sistema

Use esse link direcional para criar links entre itens de trabalho que têm dependências e são definidos em organizações diferentes, desde que o mesmo ID do Microsoft Entra os gerencie. Normalmente usado para controlar solicitações de alteração feitas aos requisitos.

Remoto Relacionado
Imagem conceitual da topologia relacionada remotamente.

System.LinkTypes.Remote.Related
Tipo de topologia: Rede
Categoria do link: Definido pelo sistema

Use esse link não direcional para criar links entre itens de trabalho definidos em organizações diferentes, desde que o mesmo ID do Microsoft Entra os gerencie.

Você pode criar um tipo de link personalizado; exportar e importar definições de tipos de links; e excluir, ativar, desativar e reativar tipos de links. Consulte os seguintes artigos:

Para obter uma lista de tipos de link, você pode usar uma das ferramentas de linha de comando suportadas.

az boards work-item relation list-type

Você pode listar os tipos de link suportados pela sua organização com o comando az boards work-item relation list-type ou o comando Work Item Relation Types - List REST API. Para começar, consulte Introdução à CLI do Azure DevOps.

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

Parâmetros opcionais

  • org: URL da organização do Azure DevOps. Você pode configurar a organização padrão usando az devops configure -d organization=ORG_URLo . Obrigatório se não estiver configurado como padrão ou coletado usando git configo . Exemplo: --org https://dev.azure.com/MyOrganizationName/.

Exemplo

O comando a seguir lista os tipos de link de item de trabalho em formato de tabela definidos para a organização 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

O formato json padrão fornece informações adicionais sobre os atributos definidos para os tipos de link. Por exemplo, as informações para os tipos de link Produz Para e Consome De estão listadas a seguir.

  {
    "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

Você pode listar os tipos de link suportados para sua coleção de projetos usando a ferramenta de witadmin listlinktypes linha de comando ou o comando Work Item Relation Types - List REST API.

Aqui listamos os tipos de link para a coleção padrão 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

A tabela a seguir fornece descrições para cada um dos atributos de tipo de link retornados pela CLI do Azure Boards ou pela API REST.

Atributo

Descrição

Nomes, name

Especifica o nome amigável atribuído ao(s) tipo(s) de link. Os links direcionais são definidos em pares, portanto, incluem um nome para frente e para trás.

Nome de referência, referenceName

Especifica o nome atribuído ao tipo de link ou par de tipos de link.

acyclic

Indica se o tipo de link permite ou (true) ou restringe (false) relações circulares. Por exemplo, links de tipo de árvore restringem relações circulares. Para obter mais informações, consulte Referência de elementos LinkTypes.

directional

Indica se o tipo de link é direcional (true) ou não (false). Os tipos de link direcional são definidos em pares com um componente para frente e para trás. Para obter mais informações, consulte Referência de elementos LinkTypes.

editable

Indica se o tipo de link é editável (true) ou não (false). Você só pode adicionar e editar tipos de link personalizados para implantações locais usando witadmin a ferramenta de linha de comando Gerenciar tipo de link. Os tipos de link do sistema sempre têm editable=false.

está ativo, enabled

Indica se o tipo de link está ativo (true) ou não (false). Você só pode usar tipos de link personalizados para implantações locais usando a ferramenta de linha de witadmin comando Gerenciar tipo de link.

isForward

Indica se o tipo de link especifica o link de encaminhamento (true) ou não (False) dentro de um par de tipos de link.

oppositeEndReferenceName

Especifica o nome de referência do tipo de link que define o link na direção oposta de um par de tipos de link.

remote

Indica se o tipo de link oferece suporte à vinculação a um item de trabalho remoto (true) ou não (False). Os tipos de vínculo com remote=false exigem que o item de trabalho de destino resida na mesma organização ou coleção que o item de trabalho de origem.

singleTarget

Indica se o tipo de link permite mais de um destino (false) ou se está restrito a um único destino (true).

topology

Especifica o tipo de topologia — árvore de rede, and de dependência, '. Para obter descrições, consulte Topologias e restrições de tipo de link.

usage

Especifica o tipo de uso — resourceLink ou workItemLink. O valor workItemLinkvalue indicates a link type that links two work items. TheresourceLink' indica um tipo de link usado para vincular um item de trabalho a um recurso, como uma URL ou anexo.

url

Lista os atributos do tipo de link no formato json.