Help Center
Choose product document...
Veeam Backup & Replication 9.5 Update 4
Veeam Explorers PowerShell Reference

Save-VEODDocument

Short Description

Saves OneDrive documents.

Applies to Veeam Backup for Microsoft Office 365

Product Edition: Community, Rental, Subscription

Syntax

This cmdlet provides the following parameter sets.

  • To save documents of a specific OneDrive user:

Save-VEODDocument [-User] <VBOOneDriveUser> [-Path] <string> [-AsZip]  [<CommonParameters>]

  • To save a specific OneDrive document:

Save-VEODDocument [-Document] <VBOOneDriveDocument[]> [-Path] <string> [-AsZip]  [<CommonParameters>]

  • To save documents of the multiple OneDrive users:

Save-VEODDocument [-MultipleUsers] <VBOOneDriveUser[]> [-Path] <string> [-AsZip]  [<CommonParameters>]

Detailed Description

This cmdlet saves OneDrive documents.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Document

Specifies the OneDrive document that you want to save.

True

0

True (ByValue)

False

AsZip

Indicates that the cmdlet will save the specified document as ZIP-archive.

False

Named

False

False

Path

Specifies a path to the folder. The cmdlet will save the OneDrive document to the specified path.

True

1

False

False

User

Specifies the OneDrive user that the cmdlet will save documents from.

True

0

True (ByValue)

False

MultipleUsers

Specifies OneDrive users that the cmdlet will save documents from.

True

0

True (ByValue)

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

Example 1

This example shows how to save all OneDrive documents from the userAlpha user.

  1. Run Get-VEODRestoreSession to get an active restore session. Save the result to the $session variable.
  2. Run Get-VEODUser with the $session variable to get the user. Save the result to the $user variable.
  3. Run Save-VEODDocument with the $user variable. Use the Path parameter to specify the path to the folder where you want to keep the selected documents. Use the AsZip parameter to save all documents as a single zip archive.

PS C:\PS> $session = Get-VEODRestoreSession

PS C:\PS> $user = Get-VEODUser -Session $session -Name “userAlpha”

PS C:\PS> Save-VEODDocument -User $user -Path "C:\Save\archive.zip" -AsZip

Example 2

This example shows how to save the document.txt OneDrive document from the userAlpha user.

  1. Run Get-VEODRestoreSession to get an active restore session. Save the result to the $session variable.
  2. Run Get-VEODUser with the $session variable to get the OneDrive user. Save the result to the $user variable.
  3. Run Get-VEODDocument with the $user variable and Name parameter to get the specific OneDrive document. Use the Recurse parameter to also get all of its child versions.
  4. Run Save-VEODDocument with the $user variable. Use the Path parameter to specify the path to the folder where you want to keep the selected documents. Use the AsZip parameter to save all documents as a single zip archive.

PS C:\PS> $session = Get-VEODRestoreSession

PS C:\PS> $user = Get-VEODUser -Session $session -Name “userAlpha”

PS C:\PS> $document = Get-VEODDocument -User $user -Name “document.txt” -Recurse

PS C:\PS> Save-VEODDocument -User $user -Path "C:\Save\archive.zip" -AsZip

Example 3

This example shows how to save OneDrive documents from multiple users:

  1. Run Get-VEODRestoreSession to get an active restore session. Save the result to the $session variable.
  2. Run Get-VEODUser with the $session variable to get the OneDrive users. Save the result to the $users variable.
  3. Run Save-VEODDocument with the $users variable. Use the Path parameter to specify the path to the folder where you want to keep the selected documents. Use the AsZip parameter to save all documents as a single zip archive.

PS C:\PS> $session = Get-VEODRestoreSession

PS C:\PS> $users = Get-VEODUser -Session $session

PS C:\PS> Save-VEODDocument -MultipleUsers $users -Path "C:\Save\archive.zip" -AsZip

Related Commands

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Agent Management Guide

Veeam Explorers User Guide

Backup and Restore of SQL Server Databases

Veeam Plug-ins for Enterprise Applications

PowerShell Reference

Veeam Explorers PowerShell Reference

RESTful API Reference

Required Permissions

Veeam Availability for Nutanix AHV

Veeam Backup for Microsoft Office 365 Documentation

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation