< Back

Add-JiraIssueAttachment

Thu Jan 16, 2020 7:42 am

NAME Add-JiraIssueAttachment



SYNOPSIS

Adds a file attachment to an existing Jira Issue





SYNTAX

Add-JiraIssueAttachment [-Issue] <Object> [-FilePath] <String[]> [[-Credential] <PSCredential>] [-PassThru]

[-WhatIf] [-Confirm] [<CommonParameters>]





DESCRIPTION

This function adds an Attachment to an existing issue in JIRA.





PARAMETERS

-Issue <Object>

Issue to which to attach the file.



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



Required? true

Position? 1

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-FilePath <String[]>

Path of the file to upload and attach



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



-PassThru [<SwitchParameter>]

Whether output should be provided after invoking this function



Required? false

Position? named

Default value False

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

[JiraPS.Attachment]

This function outputs the results of the attachment add.





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-JiraIssueAttachment -FilePath "Test comment" -Issue "TEST-001"



This example adds a simple comment to the issue TEST-001.

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



Get-JiraIssue "TEST-002" | Add-JiraIssueAttachment -FilePath "Test comment from PowerShell"



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



RELATED LINKS

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

Get-JiraIssueAttachment

Remove-JiraIssueAttachment