Compartilhar via

Guia de referência para tipos de link

Azure DevOps Services | Servidor Azure DevOps | Azure DevOps Server 2022

Use diferentes tipos de link para gerenciar relações entre itens de trabalho e outros artefatos, como builds, confirmações e solicitações de pull. Este artigo descreve os seguintes tipos de link.

  • Tipo de link de trabalho: Vincula itens de trabalho, incluindo itens específicos de trabalho de gerenciamento de caso de teste
  • 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, build 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, problema ou pull do repositório GitHub.

Um campo específico mantém uma contagem de links para os quatro primeiros tipos de link, como Contagem de Vínculos Relacionados, Contagem de Hiperlinks, Contagem de Link Externo e Contagem de Link Remoto.

  • 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, build ou página wiki
  • Tipo de link do GitHub: conecta um item de trabalho a uma solicitação de confirmação ou pull do repositório GitHub.

Um campo específico mantém uma contagem de links para os três primeiros tipos de link, como Contagem de Links Relacionados, Contagem de Hiperlinks e Contagem de Links Externos.

Os tipos de link têm restrições topológicas. Use as diretrizes nas tabelas a seguir para escolher um tipo de link com base nas consultas e relatórios que você planeja criar. Para saber mais sobre topologias, consulte topologias de tipos de links e suas restrições.

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

Cada tipo de link de trabalho define rótulos, topologia e restrições usadas ao construir links entre itens de trabalho. Por exemplo, o tipo de link pai-filho define dois rótulos: Pai e Filho. O tipo de link usa uma topologia de árvore e impede referências circulares entre itens de trabalho.

Captura de tela que mostra um diagrama conceitual de um tipo de ligação de item de trabalho.

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

A tabela a seguir descreve os tipos de link do 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

Usage

Afeta-Afetado por (somente CMMI) Captura de tela que mostra um diagrama conceitual do tipo de link Afeta.Captura de tela que mostra um diagrama conceitual do tipo de link Afetado por.

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

Use esse link direcional para criar links entre itens de trabalho sem criar loops fechados. Normalmente, as pessoas o usam para controlar solicitações de alteração vinculadas aos requisitos.

Restrições e recomendações:

  • Vincule uma solicitação de alteração a apenas um requisito usando Affects. Vincule os requisitos para quantas solicitações de alteração filho forem necessárias usando Affected by.
  • Use apenas Affects-Affected para links que conectam itens de trabalho no mesmo projeto. Recomendamos isso quando você planeja usar o Excel para modificar ou atualizar dados de item de trabalho.

Pai-filho
Captura de tela que mostra um diagrama conceitual do tipo de link Filho.
Captura de tela que mostra um diagrama conceitual do tipo de link Pai.

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

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

Os usos típicos incluem:

  • Manter as relações de resumo entre tarefas. Os links pai-filho representam tarefas resumidas e suas tarefas subordinadas.
  • Vincule tarefas a PBIs, histórias de usuário ou requisitos. Oferece suporte a 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. Confira Adicionar ou modificar itens de trabalho em massa com o Excel.
  • Um item de trabalho pode ter apenas um Pai. Um item de trabalho pai pode ter muitos filhos.
  • Use apenas links pai-filho para vincular itens de trabalho no mesmo projeto. Recomendamos isso quando você planeja usar o Excel para modificar ou atualizar dados de item de trabalho.

Duplicata-Duplicata da captura detela que mostra um diagrama conceitual do tipo de link Duplicado.Captura de tela que mostra um diagrama conceitual do tipo de link Duplicado De.

System.LinkTypes.Duplicate-Forward
System.LinkTypes.Duplicate-Reverse
Tipo de topologia: Árvore
Categoria de link: definido pelo sistema

Use este link direcional para criar relações de um para muitos para acompanhar tarefas, bugs ou outros itens de trabalho que são duplicados entre si.

Restrições e recomendações:

  • Um item de trabalho pode ter apenas uma Duplicata.
  • Use links do tipo Duplicado ou Duplicado de apenas para vincular itens de trabalho no mesmo projeto. Recomendamos isso quando você planeja usar o Excel para modificar ou atualizar dados de item de trabalho.

Referenciado por referências
Captura de tela que mostra um diagrama conceitual do tipo de link Referenciado por. Captura de tela que mostra um diagrama conceitual do tipo de link Referências.

Microsoft.VSTS.TestCase.
ParâmetroCompartilhadoReferenciadoPor
Tipo de topologia: Dependência
Categoria de link: definido pelo processo

Use isso para vincular casos de teste a parâmetros compartilhados e para dar suporte à repetição de um teste com dados diferentes. Em geral, você não adiciona esse tipo de link a um controle de links delimitado.

Relacionado
Captura de tela que mostra um diagrama conceitual do tipo de link Relacionado.

System.LinkTypes.Related
Tipo de topologia: rede
Categoria de link: definido pelo sistema

Use esse link não direcional para criar relações entre itens de trabalho. Use-o para vincular itens de trabalho no mesmo nível (por exemplo, duas histórias de usuário que se sobrepõem). O tipo de link relacionado cria relações simples com poucas restrições.

  • Relacionar itens de trabalho que estão no mesmo nível.
  • Vincule itens de trabalho definidos em projetos diferentes e gerenciados por equipes diferentes.
  • Encontre e visualize itens de trabalho e seus itens de trabalho relacionados em uma exibição de dois níveis.
  • Crie relações simples com poucas restrições.

Sucessor-Predecessor
Captura de tela que mostra um diagrama conceitual da dependência Sucessora. Captura de tela que mostra um diagrama conceitual da dependência Predecessora.

System.LinkTypes.Dependency
Tipo de topologia: Dependência
Categoria de link: definido pelo sistema
Escolha Predecessor ao vincular a um item de trabalho que deve ser concluído antes do item atual. Escolha Sucessor ao vincular a um item de trabalho que deve ser concluído após o item atual.

Use esse link direcional para acompanhar as tarefas que devem ser concluídas antes que outras pessoas comecem. As tarefas vinculadas aparecem como links predecessor-sucessor no Azure Boards.

  • Acompanhe as tarefas que devem ser concluídas antes que outras pessoas possam começar.
  • Dê suporte a relações um para muitos.
  • Encontre itens de trabalho predecessores e sucessores em uma exibição de consulta de links diretos de duas camadas.

Restrições e recomendações:

  • Um erro é exibido quando você tenta criar relações circulares.
  • Crie links predecessor-sucessor apenas para itens de trabalho no mesmo projeto quando você planeja exportar para o Excel. Você pode criar links predecessor-sucessor entre projetos, mas a exportação/importação do Excel incluirá apenas itens para o projeto que define a consulta.

Testado por Testes
Captura de tela que mostra um diagrama conceitual do tipo Testado por link. Captura de tela que mostra um diagrama conceitual do tipo de link Testes.

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

Vincule casos de teste a itens de trabalho, como bugs, histórias de usuário, requisitos e PBIs. Use isso para acompanhar casos de teste que validam histórias de usuário (Agile), PBIs (Scrum) ou requisitos (CMMI). Para o Azure DevOps local, vários relatórios SQL dependem desses links. Consulte As atividades da equipe de Revisão para dar suporte a relatórios úteis.

Etapas de Teste Case-Shared
Captura de tela que mostra um diagrama conceitual do link Caso de Teste para Etapas Compartilhadas. Captura de tela que mostra um diagrama conceitual do link Etapas Compartilhadas para Caso de Teste.

Microsoft.VSTS.TestCase.
PassoCompartilhadoReferenciadoPor
Tipo de topologia: Dependência
Categoria de link: definido pelo processo

Use isso para vincular casos de teste com etapas compartilhadas. Compartilhe etapas entre casos de teste para evitar duplicar a mesma sequência de etapas.

Um hiperlink vincula um item de trabalho a qualquer URL. A Contagem de Hiperlinks rastreia o número de hiperlinks em um item de trabalho.

Captura de tela que mostra um diagrama conceitual de um Hiperlink.

Nome do link

Ferramenta com suporte

Tipo de artefato

Usage

Hiperlink

Acompanhamento do item de trabalho

Hiperlink

Use isso 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 externos são definidos pelo sistema e vinculam itens de trabalho a outros objetos armazenados no Azure DevOps. A Contagem de Link Externo de um item de trabalho é igual à soma de todos os links definidos com tipos de link externos.

Captura de tela que mostra um diagrama conceitual de tipos de link externos.

Observação

Use um tipo de link externo apenas para vincular a um objeto do Azure DevOps. Para vincular itens de trabalho a objetos fora do Azure DevOps, use um hiperlink.

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

A tabela a seguir descreve os tipos de link externos que você pode escolher ao adicionar um link de um item de trabalho ou caso de teste. Você também 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 com suporte

Tipo de artefato

Usage

Alerta de segurança

Segurança avançada

Segurança avançada

Usado para vincular um item de trabalho a um alerta de Segurança Avançada.

Ramo

Git

Ramo

Usar para vincular um item de trabalho a um ramo.

Pipelines/Build

Construir

Construir

Use para vincular um item de trabalho a um build.

Conjunto de alterações (ou Corrigido no Conjunto de Alterações)

VersionControl

Conjunto de alterações

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

Commit (ou Corrigido no Commit)

Git

Fazer commit

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

Encontrado no build

Pipelines/Build

Construir

Use para vincular um item de trabalho a um build.

Integrado à compilação

Construir

Pipeline de build

Use para vincular um item de trabalho a um build.

Integrado ao ambiente de versionamento

Liberação

Pipeline de lançamento

Use para vincular um lançamento a um item de trabalho. O sistema cria esse tipo quando um usuário habilita o Status de Implantação do Relatório para Work para uma definição de release.

Solicitação de pull

Git

PullRequestId

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

Anexo de resultado

Gerenciamento de testes

TcmResultAttachment

Use 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 do Microsoft Test Manager.

Arquivo de código-fonte

VersionControl

VersãoMaisRecenteDoItem

Use para vincular um item de trabalho a um arquivo no controle de versão do Team Foundation (TFVC).

Storyboard

Requisitos

Storyboard

Use 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

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

Resultado do teste

Gerenciamento de testes

TcmResult

Use 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 do Microsoft Test Manager.

Item versionado

VersionControl

VersãoMaisRecenteDoItem

Use 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

Use para vincular um item de trabalho a uma página wiki. Compatível com o TFS 2018.2 e versões posteriores.

Os tipos de link do GitHub são definidos pelo sistema e vinculam itens de trabalho a objetos do GitHub, conforme mostrado aqui.

Captura de tela que mostra um diagrama conceitual de tipos de link do GitHub.

Importante

Você só pode vincular a artefatos do GitHub para repositórios conectados ao Azure Boards.

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

Nome do link

Tipo de artefato

Usage

Commit do GitHub

Commit do repositório do GitHub

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

Problema do GitHub

Problema do repositório GitHub

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

Solicitação de Pull do GitHub

Solicitação de pull do repositório GitHub

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

Tipos de link de trabalho remoto dão suporte à vinculação de itens de trabalho definidos em organizações diferentes, desde que a mesma ID do Microsoft Entra gerencie essas organizações (consulte Conectar sua organização à ID do Microsoft Entra).

A Contagem de Links Remotos de um item de trabalho é igual à soma de todos os links definidos com um tipo de link remoto.

Nome

Nome de Referência

Usage

Consome de-Produzido para
(Topologia de dependência) Captura de tela que mostra um diagrama conceitual da topologia Captura de tela que mostra um diagrama conceitual da topologia

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

Use esse link direcional para criar dependências entre itens de trabalho definidos em organizações diferentes, desde que a mesma ID do Microsoft Entra as gerencie. As pessoas normalmente usam isso para controlar solicitações de alteração vinculadas a requisitos entre limites da organização.

Relacionado remotamente
Captura de tela que mostra um diagrama conceitual da topologia Relacionada Remota.

System.LinkTypes.Remote.Related
Tipo de topologia: rede
Categoria de link: definido pelo sistema

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

Crie tipos de link personalizados, exporte e importe definições de tipo de link e exclua, ative, desative ou reative tipos de link personalizados. Consulte:

Você pode listar tipos de link usando ferramentas de linha de comando com suporte.

az boards work-item relation list-type

Listar tipos de link suportados pela sua organização com o comando az boards work-item relation list-type ou a API REST Work Item Relation Types - List. Para obter detalhes, consulte Introdução à CLI do Azure DevOps.

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

Parâmetros opcionais

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

Exemplo

O comando a seguir lista os tipos de vínculo de item de trabalho no 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 dos tipos de link Produz para e Consome de são listadas conforme indicado 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 tipos de link com suporte para sua coleção de projetos usando a witadmin listlinktypes ferramenta de linha de comando ou o comando Tipos de Relação de Item de Trabalho – Listar API REST.

Aqui está uma lista dos 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 aos tipos de link. Os links direcionais são definidos em pares, portanto, incluem um nome direto e reverso.

Nome da referência, referenceName

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

acyclic

Indica se o tipo de link permite ou (true) ou restringe relações circulares (false). Por exemplo, links de tipo de árvore restringem relações circulares. Para obter mais informações, consulte a 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 avançado e reverso. Para obter mais informações, consulte a 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 Gerenciar tipo de link de linha de comando. 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 witadmin ferramenta Gerenciar tipo de link de linha de comando.

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 links.

remote

Indica se o tipo de link dá suporte à vinculação a um item de trabalho remoto (true) ou não (False). Os tipos de link 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 é restrito a um único destino (true).

topology

Especifica o tipo de topologia: dependency, networke tree. Para descrições, consulte topologias de tipos de link e restrições.

usage

Especifica o tipo de uso: resourceLink or o valor workItemLink. The workItemLink indica um tipo de link que vincula dois itens de trabalho. O resourceLink valor indica um tipo de link usado para vincular um item de trabalho a um recurso, como uma URL ou um anexo.

url

Lista os atributos do tipo de link no formato json.

Conteúdo relacionado

  • Last updated on