< Back

Get-JiraIssueAttachment

Thu Jan 16, 2020 7:53 am

NAME Get-JiraIssueAttachment



SYNOPSIS

Returns attachments of an issue in JIRA.





SYNTAX

Get-JiraIssueAttachment [-Issue] <Object> [[-FileName] <String>] [[-Credential] <PSCredential>]

[<CommonParameters>]





DESCRIPTION

This function obtains attachments from existing issues in JIRA.





PARAMETERS

-Issue <Object>

JIRA issue to check for attachments.



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



-FileName <String>

Name of the file(s) to filter.



This parameter supports wildcards.



Required? false

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



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







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-JiraIssueAttachment -Issue TEST-001



This example returns all attachments from issue TEST-001.

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



Get-JiraIssue TEST-002 | Get-JiraIssueAttachment



This example illustrates use of the pipeline to return all attachments from issue TEST-002.

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



Get-JiraIssue TEST-002 | Get-JiraIssueAttachment -FileName "*.png"



Returns all attachments of issue TEST-002 where the filename ends in `.png`



RELATED LINKS

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

Get-JiraAttachmentFile

Add-JiraIssueAttachment

Get-JiraIssue

Remove-JiraIssueAttachment