< Back
Remove-JiraIssue
Post
NAME Remove-JiraIssue
SYNOPSIS
Removes an existing issue from JIRA.
SYNTAX
Remove-JiraIssue [-InputObject] <Object[]> [-IssueId] <String[]> [[-Credential] <PSCredential>] [-IncludeSubTasks]
[-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
This function will remove an issue from Jira. Deleting an issue removes it permanently from JIRA, including all of
its comments and attachments.
If you have completed an issue, it should usually be resolved or closed - not deleted.
If an issue includes sub-tasks, these are deleted as well.
PARAMETERS
-InputObject <Object[]>
One or more issues to delete, specified as `JiraPS.Issue` objects (e.g. from `Get-JiraIssue`)
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-IssueId <String[]>
One or more issues to delete, either:
* Issue Keys (e.g. "TEST-1234")
* Numerical issue IDs
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-IncludeSubTasks [<SwitchParameter>]
Removes any subtasks associated with the issue(s) to be deleted.
If the issue has no subtasks, this parameter is ignored. If the issue has subtasks and this parameter is
missing, then the issue will not be deleted and an error will be returned.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Credential <PSCredential>
Credentials to use to connect to JIRA.
Required? false
Position? 2
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
Output (if any)
NOTES
If the issue has subtasks you must include the parameter IncludeSubTasks to delete the issue. You cannot
delete an issue without its subtasks also being deleted.
This function requires either the `-Credential` parameter to be passed or a persistent JIRA session. See
`New-JiraSession` for more details.
-------------------------- EXAMPLE 1 --------------------------
Remove-JiraIssue -IssueId ABC-123
Removes issue [ABC-123] from JIRA.
-------------------------- EXAMPLE 2 --------------------------
Remove-JiraIssue -IssueId ABC-124 -IncludeSubTasks
Removes issue [ABC-124] from JIRA, including any subtasks therein.
-------------------------- EXAMPLE 3 --------------------------
Get-JiraIssue -Query "Project = ABC AND label = NeedsDeletion" | Remove-JiraIssue -IncludeSubTasks
Removes all issues from project ABC (including their subtasks) that have the label "NeedsDeletion".
RELATED LINKS
Online Version: https://atlassianps.org/docs/JiraPS/com ... JiraIssue/
SYNOPSIS
Removes an existing issue from JIRA.
SYNTAX
Remove-JiraIssue [-InputObject] <Object[]> [-IssueId] <String[]> [[-Credential] <PSCredential>] [-IncludeSubTasks]
[-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
This function will remove an issue from Jira. Deleting an issue removes it permanently from JIRA, including all of
its comments and attachments.
If you have completed an issue, it should usually be resolved or closed - not deleted.
If an issue includes sub-tasks, these are deleted as well.
PARAMETERS
-InputObject <Object[]>
One or more issues to delete, specified as `JiraPS.Issue` objects (e.g. from `Get-JiraIssue`)
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-IssueId <String[]>
One or more issues to delete, either:
* Issue Keys (e.g. "TEST-1234")
* Numerical issue IDs
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-IncludeSubTasks [<SwitchParameter>]
Removes any subtasks associated with the issue(s) to be deleted.
If the issue has no subtasks, this parameter is ignored. If the issue has subtasks and this parameter is
missing, then the issue will not be deleted and an error will be returned.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Credential <PSCredential>
Credentials to use to connect to JIRA.
Required? false
Position? 2
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
Output (if any)
NOTES
If the issue has subtasks you must include the parameter IncludeSubTasks to delete the issue. You cannot
delete an issue without its subtasks also being deleted.
This function requires either the `-Credential` parameter to be passed or a persistent JIRA session. See
`New-JiraSession` for more details.
-------------------------- EXAMPLE 1 --------------------------
Remove-JiraIssue -IssueId ABC-123
Removes issue [ABC-123] from JIRA.
-------------------------- EXAMPLE 2 --------------------------
Remove-JiraIssue -IssueId ABC-124 -IncludeSubTasks
Removes issue [ABC-124] from JIRA, including any subtasks therein.
-------------------------- EXAMPLE 3 --------------------------
Get-JiraIssue -Query "Project = ABC AND label = NeedsDeletion" | Remove-JiraIssue -IncludeSubTasks
Removes all issues from project ABC (including their subtasks) that have the label "NeedsDeletion".
RELATED LINKS
Online Version: https://atlassianps.org/docs/JiraPS/com ... JiraIssue/