< Back

Get-JiraIssueComment

Thu Jan 16, 2020 7:54 am

NAME Get-JiraIssueComment



SYNOPSIS

Returns comments on an issue in JIRA.





SYNTAX

Get-JiraIssueComment [-Issue] <Object> [[-Credential] <PSCredential>] [<CommonParameters>]





DESCRIPTION

This function obtains comments from existing issues in JIRA.





PARAMETERS

-Issue <Object>

JIRA issue to check for comments.



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



-Credential <PSCredential>

Credentials to use to connect to JIRA.

If not specified, this function will use anonymous access.



Required? false

Position? 2

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







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-JiraIssueComment -Key TEST-001



This example returns all comments posted to issue TEST-001.

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



Get-JiraIssue TEST-002 | Get-JiraIssueComment



This example illustrates use of the pipeline to return all comments on issue TEST-002.



RELATED LINKS

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

Add-JiraIssueComment

Get-JiraIssue