< Back

Get-JiraRemoteLink

Thu Jan 16, 2020 8:00 am

NAME Get-JiraRemoteLink



SYNOPSIS

Returns a remote link from a Jira issue





SYNTAX

Get-JiraRemoteLink [-Issue] <Object> [[-LinkId] <Int32>] [[-Credential] <PSCredential>] [<CommonParameters>]





DESCRIPTION

This function returns information on remote links from a JIRA issue.





PARAMETERS

-Issue <Object>

The Issue to search for link.



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



-LinkId <Int32>

Get a single link by it's id.



Required? false

Position? 2

Default value 0

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? 3

Default value None

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] / [String]







OUTPUTS

[JiraPS.Link]







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



Get-JiraRemoteLink -Issue TEST-001 -Credential $cred



Returns information about all remote links from the issue "TEST-001"

-------------------------- EXAMPLE 2 --------------------------



Get-JiraRemoteLink -Issue TEST-001 -LinkId 100000 -Credential $cred



Returns information about a specific remote link from the issue "TEST-001"



RELATED LINKS

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

Remove-JiraRemoteLink