On this page

Remove-JiraIssueAttachment

SYNOPSIS

Removes an attachment from a JIRA issue

SYNTAX

byId (Default)

Remove-JiraIssueAttachment [-AttachmentId] <Int32[]> [-Credential <PSCredential>] [-Force] [-WhatIf] [-Confirm]
 [<CommonParameters>]

byIssue

Remove-JiraIssueAttachment [-Issue] <Object> [-FileName <String[]>] [-Credential <PSCredential>] [-Force]
 [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

This function removes an attachment from a JIRA issue.

EXAMPLES

EXAMPLE 1

Remove-JiraIssueAttachment -AttachmentId 10039

Removes attachment with id of 10039

EXAMPLE 2

Get-JiraIssueAttachment -Issue FOO-1234 | Remove-JiraIssueAttachment

Removes all attachments from issue FOO-1234

EXAMPLE 3

Remove-JiraIssueAttachment -Issue FOO-1234 -FileName '*.png' -force

Removes all *.png attachments from Issue FOO-1234 without prompting for confirmation

PARAMETERS

-AttachmentId

Id of the Attachment to delete

Type: Int32[]
Parameter Sets: byId
Aliases: Id

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

-Issue

Issue from which to delete on or more attachments.

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

Type: Object
Parameter Sets: byIssue
Aliases: Key

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

-FileName

Name of the File to delete

Type: String[]
Parameter Sets: byIssue
Aliases:

Required: False
Position: Named
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: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Force

Suppress user confirmation.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
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.Issue] / [String] / [Int]

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.

Add-JiraIssueAttachment

Get-JiraIssue

Get-JiraIssueAttachment