< Back

Remove-JiraRemoteLink

Thu Jan 16, 2020 8:15 am

NAME Remove-JiraRemoteLink



SYNOPSIS

Removes a remote link from a JIRA issue





SYNTAX

Remove-JiraRemoteLink [-Issue] <Object[]> [-LinkId] <Int32[]> [[-Credential] <PSCredential>] [-Force] [-WhatIf]

[-Confirm] [<CommonParameters>]





DESCRIPTION

This function removes a remote link from a JIRA issue.





PARAMETERS

-Issue <Object[]>

Issue from which to delete a remote 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[]>

Id of the remote link to delete.



Required? true

Position? 2

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

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Force [<SwitchParameter>]

Suppress user confirmation.



Required? false

Position? named

Default value False

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







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



Remove-JiraRemoteLink TEST-001 10000, 20000



Removes two remote link from issue "TEST-001"

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



Get-JiraIssue -Query "project = TEST" | Remove-JiraRemoteLink 10000



Removes a specific remote link from all issues in project "TEST"



RELATED LINKS

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

Get-JiraIssue

Get-JiraRemoteLink