Restore-VEODDocument

In this article

    Short Description

    Restores OneDrive documents.

    Applies to Veeam Backup for Microsoft Office 365

    Product Edition: Community, Rental, Subscription

    Syntax

    This cmdlet provides parameter sets that allow you to:

    • Restore a specific OneDrive document.

    Restore-VEODDocument [-Document] <VBOOneDriveDocument[]> [-RestoreChangedItems] [-SkipSharedAccessNotificationSending] [-RestoreDeletedItems] [-RestorePermissions] [-Credential <pscredential>] [-TargetUser <string>] [-TargetFolder <string>] [-Overwrite]  [<CommonParameters>]

    • Restore all documents of a specific OneDrive user.

    Restore-VEODDocument [-User] <VBOOneDriveUser> [-RestoreChangedItems] [-SkipSharedAccessNotificationSending] [-RestoreDeletedItems] [-RestorePermissions] [-Credential <pscredential>] [-TargetUser <string>] [-TargetFolder <string>] [-Overwrite]  [<CommonParameters>]

    • Restore documents of multiple OneDrive users.

    Restore-VEODDocument [-MultipleUsers] <VBOOneDriveUser[]> [-SkipUnresolvedUsers] [-Credential <pscredential>] [-Office365Credential <pscredential>] [-OnPremisesCredential <pscredential>] [-Overwrite]  [<CommonParameters>]

    Detailed Description

    This cmdlet allows you to restore OneDrive documents.

    Restore-VEODDocument Note:

    To perform restore operations, you must first start a restore session. For more information on how to start a restore session, see the Start-VBOExchangeItemRestoreSession cmdlet.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    Document

    Specifies the OneDrive document. This cmdlet will restore specified OneDrive documents.

    Accepts the Document object. To get this object, run the  Get-VEODDocument cmdlet.

    True

    0

    True (ByValue)

    User

    Specifies a OneDrive user. The cmdlet will restore documents of this user.

    Accepts the VBOOneDriveUser object. To get this object, run the  Get-VEODDocument cmdlet.

    True

    0

    True (ByValue)

    MultipleUsers

    Specifies an array of OneDrive users. The cmdlet will restore documents of these users.

    Note: This cmdlet will restore documents to the production versions of the same OneDrive users.

    Accepts the BOOneDriveUser[] object. To get this object, run the  Get-VEODDocument cmdlet.

    True

    0

    True (ByValue)

    RestoreChangedItems

    Defines that the cmdlet will restore all versions of OneDrive documents that were modified by the user.

    SwitchParameter

    False

    Named

    False

    RestoreDeletedItems

    Defines that the cmdlet will restore all document items that were deleted by the user.

    SwitchParameter

    False

    Named

    False

    RestoreSharedAccess

    Defines that the cmdlet will restore shared access permissions with the restored document.

    SwitchParameter

    False

    Named

    False

    SkipSharedAccessNotificationSending

    Defines that the cmdlet will not send shared access notifications.

    SwitchParameter

    False

    Named

    False

    Credential

    Specifies the account credentials you want to use for connecting to the OneDrive server.

    If omitted, the cmdlet will use the current user Windows account credentials to connect to the OneDrive server.

    PSCredential

    False

    Named

    False

    TargetUser

    Specifies the restore target OneDrive user. This cmdlet will restore OneDrive document to the specified user.

    String

    False

    Named

    False

    TargetFolder

    Specifies the restore target OneDrive folder. This cmdlet will restore OneDrive document to the specified folder.

    String

    False

    Named

    False

    Overwrite

    Defines that the cmdlet will overwrite the items in the target directory with the restored items if these items have the same name.

    SwitchParameter

    False

    Named

    False

    SkipUnresolvedUsers

    Defines that the cmdlet will not restore items of the users that are not resolving.

    SwitchParameter

    False

    Named

    False

    Office365Credential

    Specifies the credentials that the cmdlet will use to authenticate to Microsoft Office 365 organization.

    Note: Specify the organization user name in the domain\account format.

    PSCredential

    False

    Named

    False

    OnPremisesCredential

    Specifies the credentials that the cmdlet will use to authenticate to On-Premises SharePoint organization.

    Note: Specify the organization user name in the domain\account format.

    PSCredential

    False

    Named

    False

    <CommonParameters>

    This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About Common Parameters section of Microsoft Docs.

    Examples

    Restore-VEODDocumentExample 1. Restoring Specific OneDrive Document

    This example shows how to restore the document.txt OneDrive document of the userAlpha user with the following settings:

    • The cmdlet will restore the document to the userBeta user.
    • The cmdlet will restore the document to the UserBetaFolder folder.
    • The cmdlet will restore all versions of OneDrive documents that were modified by the user.
    • The cmdlet will restore all document items that were deleted by the user.
    • The cmdlet will restore all child items.
    • The cmdlet will overwrite the items in the target directory with the restored items if these items have the same name.

    $credentials = Get-Credential

    $session = Get-VEODRestoreSession

    $user = Get-VEODUser -Session $session -Name “userAlpha”

    $document = Get-VEODDocument -User $user -Name “document.txt” -Recurse

    Restore-VEODDocument -Document $document -RestoreChangedItems -RestoreDeletedItems -Credential $credentials -TargetUser “userBeta” -TargetFolder "UserBetaFolder" -Overwrite

    Perform the following steps:

    1. Run the Get-Credential cmdlet to create a credential object. Type Windows credentials to connect to the OneDrive organization. Save the result to the $credentials variable
    2. Run the Get-VEODRestoreSession cmdlet. Save the result to the $session variable.
    3. Run the Get-VEODUser cmdlet. Set the $session variable as the Session parameter value. Specify the Name parameters value. Save the result to the $user variable.
    4. Run the Get-VEODDocument cmdlet. Set the $user variable as the User parameter value. Specify the Name and Recurse parameters. Save the result to the $user variable.
    5. Run the Restore-VEODDocument cmdlet. Specify the following settings:
    • Set the $document variable as the Document parameter value.
    • Provide the RestoreChangedItems parameter.
    • Provide the RestoreDeletedItems parameter.
    • Set the $credentials variable as the Credential parameter value.
    • Specify the TargetUser parameter value.
    • Specify the TargetFolder parameter value.
    • Provide the Overwrite parameter.

    Restore-VEODDocumentExample 2. Restoring OneDrive Documents of Specific User

    This example shows how to restore all OneDrive documents of the userAlpha user with the following settings:

    • The cmdlet will restore the document to the userBeta user.
    • The cmdlet will restore the document to the UserBetaFolder folder.
    • The cmdlet will restore all versions of OneDrive documents that were modified by the user.
    • The cmdlet will restore all document items that were deleted by the user.
    • The cmdlet will restore all child items.
    • The cmdlet will overwrite the items in the target directory with the restored items if these items have the same name.

    $credentials = Get-Credential

    $session = Get-VEODRestoreSession

    $user = Get-VEODUser -Session $session -Name “userAlpha”

    Restore-VEODDocument -User $user -RestoreChangedItems -RestoreDeletedItems -Credential $credentials -TargetUser “userBeta” -TargetFolder "UserBetaFolder" -Overwrite

    Perform the following steps:

    1. Run the Get-Credential cmdlet to create a credential object. Type Windows credentials to connect to the OneDrive organization. Save the result to the $credentials variable
    2. Run the Get-VEODRestoreSession cmdlet. Save the result to the $session variable.
    3. Run the Get-VEODUser cmdlet. Set the $session variable as the Session parameter value. Specify the Name parameters value. Save the result to the $user variable.
    4. Run the Restore-VEODDocument cmdlet. Specify the following settings:
    • Set the $user variable as the User parameter value.
    • Provide the RestoreChangedItems parameter.
    • Provide the RestoreDeletedItems parameter.
    • Set the $credentials variable as the Credential parameter value.
    • Specify the TargetUser parameter value.
    • Specify the TargetFolder parameter value.
    • Provide the Overwrite parameter.

    Restore-VEODDocumentExample 3. Restoring OneDrive Documents of Multiple Users

    This example shows how to restore OneDrive documents of multiple users with the following settings:

    • The cmdlet will not restore documents for users that are not resolved.
    • The cmdlet will overwrite the items in the target directory with the restored items if these items have the same name..

    $o365credentials = Get-Credential

    $onPremisesCredentials = Get-Credential

    $session = Get-VEODRestoreSession

    $users = Get-VEODUser -Session $session

    Restore-VEODDocument -MultipleUser $users -Office365Credential $o365credentials -OnPremisesCredential $onPremisesCredentials -Overwrite -SkipUnresolvedUsers

    Perform the following steps:

    1. Run the Get-Credential cmdlet to create a credential object. Type Windows credentials to connect to the OneDrive organization. Save the result to the $credentials variable.
    1. Run the Get-Credential cmdlet to create a credential object. Type Windows credentials to connect to On-Premises SharePoint organization. Save the result to the $onPremisesCredentials variable.
    2. Run the Get-VEODRestoreSession cmdlet. Save the result to the $session variable.
    3. Run the Get-VEODUser cmdlet. Set the $session variable as the Session parameter value. Save the result to the $users variable.
    4. Run the Restore-VEODDocument cmdlet. Specify the following settings:
    • Set the $users variable as the MultipleUser parameter value.
    • Set the $o365credentials variable as the Office365Credential parameter value.
    • Set the $onPremisesCredentials variable as the OnPremisesCredential parameter value.
    • Provide the SkipUnresolvedUsers parameter.
    • Provide the Overwrite parameter.

    Related Commands

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.