< Back

Add-JiraIssueWatcher

Thu Jan 16, 2020 7:44 am

NAME Add-JiraIssueWatcher



SYNOPSIS

Adds a watcher to an existing JIRA issue





SYNTAX

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

[<CommonParameters>]





DESCRIPTION

This function adds a watcher to an existing issue in JIRA.





PARAMETERS

-Watcher <String[]>

Watcher that should be added to JIRA



Required? true

Position? 1

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Issue <Object>

Issue that should be watched.



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

This function can accept JiraPS.Issue objects via pipeline.







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



Add-JiraIssueWatcher -Watcher "fred" -Issue "TEST-001"



This example adds a watcher to the issue TEST-001.

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



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



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

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



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

Add-JiraIssueWatcher "fred"



This example illustrates adding 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/

Get-JiraIssue

Get-JiraUser

Get-JiraIssueWatcher

Remove-JiraIssueWatcher