< Back

Add-JiraIssueLink

Thu Jan 16, 2020 7:44 am

NAME Add-JiraIssueLink



SYNOPSIS

Adds a link between two Issues on Jira





SYNTAX

Add-JiraIssueLink [-Issue] <Object[]> [-IssueLink] <Object[]> [[-Comment] <String>] [[-Credential] <PSCredential>]

[-WhatIf] [-Confirm] [<CommonParameters>]





DESCRIPTION

Creates a new link of the specified type between two Issue.





PARAMETERS

-Issue <Object[]>

Issue which should be linked.



Can be a `JiraPS.Issue` object, issue key, or internal issue ID.



Required? true

Position? 1

Default value None

Accept pipeline input? True (ByPropertyName, ByValue)

Accept wildcard characters? false



-IssueLink <Object[]>

Issue Link to be created.



Required? true

Position? 2

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Comment <String>

Write a comment to the issue



Required? false

Position? 3

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Credential <PSCredential>

Credentials to use to connect to JIRA.

If not specified, this function will use anonymous access.



Required? false

Position? 4

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

Shows what would happen if the cmdlet runs. The cmdlet is not run.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-Confirm [<SwitchParameter>]

Prompts you for confirmation before running the cmdlet.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

[JiraPS.Issue[]]

The JIRA issue that should be linked The JIRA issue link that should be used





OUTPUTS



NOTES





This function requires either the `-Credential` parameter to be passed or a persistent JIRA session. See

`New-JiraSession` for more details. If neither are supplied, this function will run with anonymous access to

JIRA.



-------------------------- EXAMPLE 1 --------------------------



$_issueLink = [PSCustomObject]@{

outwardIssue = [PSCustomObject]@{key = "TEST-10"}

type = [PSCustomObject]@{name = "Composition"}

}

Add-JiraIssueLink -Issue TEST-01 -IssueLink $_issueLink



Creates a link "is part of" between TEST-01 and TEST-10



RELATED LINKS

Online Version: https://atlassianps.org/docs/JiraPS/com ... IssueLink/

Get-JiraIssue

Get-JiraIssueLink

Get-JiraIssueLinkType

Remove-JiraIssueLink