Get-ConfluenceAttachmentFile

NAME Get-ConfluenceAttachmentFile



SYNOPSIS

Retrieves the binary Attachment for a given Attachment object.





SYNTAX

Get-AttachmentFile [-Attachment] <Attachment[]> -ApiUri <Uri> [-Credential <PSCredential>] [-Certificate

<X509Certificate>] [-Path <String>] [<CommonParameters>]





DESCRIPTION

Retrieves the binary Attachment for a given Attachment object.



As the files are stored in a location of the server that requires authentication, this functions allows the

download of the Attachment in the same way as the rest of the module authenticates with the server.





PARAMETERS

-ApiUri <Uri>

The URi of the API interface. Value can be set persistently with Set-ConfluenceInfo.



Required? true

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Credential <PSCredential>

Confluence's credentials for authentication. Value can be set persistently with Set-ConfluenceInfo.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Certificate <X509Certificate>

Certificate for authentication.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Attachment <Attachment[]>

Attachment object to download.



Required? true

Position? 1

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? false



-Path <String>

Override the path used to save the files.



Required? false

Position? named

Default value Use current directory

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



OUTPUTS

ConfluencePS.Attachment







NOTES





Confluence uses hierarchy to help organize content. This command is meant to help provide the intended context

from the command line.



-------------------------- EXAMPLE 1 --------------------------



Get-ConfluenceAttachment -PageID 123456 | Get-ConfluenceAttachmentFile



Save any attachments of page 123456 to the current directory with each filename constructed with the page ID and

the attachment filename.

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



Get-ConfluenceAttachment -PageID 123456 | Get-ConfluenceAttachmentFile -Path "c:\\temp_dir"



Save any attachments of page 123456 to a specific directory with each filename constructed with the page ID and

the attachment filename.



RELATED LINKS

Online Version: https://atlassianps.org/docs/Confluence ... hmentFile/

https://github.com/AtlassianPS/ConfluencePS https://github.com/AtlassianPS/ConfluencePS