On this page

Get-JiraIssueAttachmentFile

SYNOPSIS

Save an attachment to disk.

SYNTAX

Get-JiraIssueAttachmentFile [-Attachment] <JiraPS.Attachment> [[-Path] <String>]]
 [[-Credential] <PSCredential>] [<CommonParameters>]

DESCRIPTION

This function downloads an attachment of an issue to the local disk.

EXAMPLES

EXAMPLE 1

Get-JiraIssueAttachmentFile (Get-JiraIssueAttachment -Issue TEST-001)

This example downloads all attachments from issue TEST-001 to the current working directory.

EXAMPLE 2

Get-JiraIssue TEST-002 | Get-JiraIssueAttachment | Get-JiraIssueAttachmentFile

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

EXAMPLE 3

Get-JiraIssue TEST-002 |
    Get-JiraIssueAttachment -FileName "*.png" |
    Get-JiraIssueAttachmentFile -Path "c:\temp

Download all attachments of issue TEST-002 where the filename ends in .png to a specific location.

PARAMETERS

-Attachment

Attachment which will be downloaded.

Type: JiraPS.Attachment
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Path

Path in which to store to attachment.

The name of the file will be appended to the Path provided.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Credential

Credentials to use to connect to JIRA.
If not specified, this function will use anonymous access.

Type: PSCredential
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

[JiraPS.Attachment]

OUTPUTS

[Bool]

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.

Get-JiraAttachment

Add-JiraIssueAttachmentFile

Get-JiraIssue

Remove-JiraIssueAttachmentFile