< Back

Remove-JiraIssueWatcher

Thu Jan 16, 2020 8:14 am

NAME Remove-JiraIssueWatcher



SYNOPSIS

Removes a watcher from an existing JIRA issue





SYNTAX

Remove-JiraIssueWatcher [-Watcher] <String[]> [-Issue] <Object> [[-Credential] <PSCredential>] [-WhatIf]

[-Confirm] [<CommonParameters>]





DESCRIPTION

This function removes a watcher from an existing issue in JIRA.





PARAMETERS

-Watcher <String[]>

Watcher that should be removed from JIRA



Required? true

Position? 1

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Issue <Object>

Issue that should be updated.



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



Required? true

Position? 2

Default value None

Accept pipeline input? True (ByPropertyName, ByValue)

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



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







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-JiraIssueWatcher -Watcher "fred" -Issue "TEST-001"



This example removes a watcher from the issue TEST-001.

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



Get-JiraIssue "TEST-002" | Remove-JiraIssueWatcher "fred"



This example illustrates pipeline use from Get-JiraIssue to Remove-JiraIssueWatcher.

-------------------------- EXAMPLE 3 --------------------------



Get-JiraIssue -Query 'project = "TEST" AND created >= -5d' | Remove-JiraIssueWatcher "fred"



This example illustrates removing watcher on all projects which match a given JQL query.



It would be best to validate the query first to make sure the query returns the expected issues!



RELATED LINKS

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

Add-JiraIssueWatcher

Get-JiraIssue

Get-JiraUser

Get-JiraIssueWatcher