Link

Add-TfsWorkItemLink

Adds a link between two work items.


Table of Contents

  1. Syntax
  2. Parameters
  3. Inputs
  4. Related Links

Syntax

Add-TfsWorkItemLink
    [-WorkItem] <object>
    [-TargetWorkItem] <object>
    [-LinkType] <WorkItemLinkType>
    [-BypassRules]
    [-Collection <object>]
    [-Comment <string>]
    [-Passthru]
    [-Server <object>]
    [-SuppressNotifications]

[Go to top]

Parameters

-BypassRules

Bypasses any rule validation when saving the work item. Use it with caution, as this may leave the work item in an invalid state.

Type SwitchParameter
Position (Named)
Default Value (N/A)
Accept pipeline input False
Accept wildcard characters False

-Collection (Aliases: Organization)

Specifies the URL to the Team Project Collection or Azure DevOps Organization to connect to, a TfsTeamProjectCollection object (Windows PowerShell only), or a VssConnection object. You can also connect to an Azure DevOps Services organizations by simply providing its name instead of the full URL. For more details, see the Get-TfsTeamProjectCollection cmdlet. When omitted, it defaults to the connection set by Connect-TfsTeamProjectCollection (if any).

Type object
Position (Named)
Default Value (N/A)
Accept pipeline input False
Accept wildcard characters False

-Comment

Defines a comment to add to the link.

Type string
Position (Named)
Default Value (N/A)
Accept pipeline input False
Accept wildcard characters False

-LinkType (Aliases: EndLinkType, Type)

Specifies the type of the link to create. Possible values: All, Parent, Child, Related, Predecessor, Successor, Duplicate, DuplicateOf, Tests, TestedBy, TestCase, SharedSteps, References, ReferencedBy, ProducesFor, ConsumesFrom, RemoteRelated, AttachedFile, Hyperlink, ArtifactLink

Type WorkItemLinkType
Position 2
Default Value All
Accept pipeline input False
Accept wildcard characters False

-Passthru

Returns the results of the command. By default, this cmdlet does not generate any output.

Type SwitchParameter
Position (Named)
Default Value (N/A)
Accept pipeline input False
Accept wildcard characters False

-Server

Specifies the URL to the Team Foundation Server to connect to, a TfsConfigurationServer object (Windows PowerShell only), or a VssConnection object. When omitted, it defaults to the connection set by Connect-TfsConfiguration (if any). For more details, see the Get-TfsConfigurationServer cmdlet.

Type object
Position (Named)
Default Value (N/A)
Accept pipeline input False
Accept wildcard characters False

-SuppressNotifications

Do not fire any notifications for this change. Useful for bulk operations and automated processes.

Type SwitchParameter
Position (Named)
Default Value (N/A)
Accept pipeline input False
Accept wildcard characters False

-TargetWorkItem (Aliases: To)

Specifies the work item to link to.

Type object
Position 1
Default Value (N/A)
Accept pipeline input False
Accept wildcard characters False

-WorkItem (Aliases: Id, From)

Specifies the work item to link from.

Type object
Position 0
Default Value (N/A)
Accept pipeline input True (byvalue)
Accept wildcard characters False

Inputs

System.Object

Specifies the work item to link from.