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

Get-VEODDocument

Short Description

Returns 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:

  • To get documents of the specified user:

Get-VEODDocument [-User] <VBOOneDriveUser> [-Name <string[]>] [-Recurse]  [<CommonParameters>]

  • To get all children documents of the specified document:

Get-VEODDocument [-ParentDocument] <VBOOneDriveDocument> [-Name <string[]>] [-Recurse]  [<CommonParameters>]

Detailed Description

This cmdlet returns documents that are stored in the OneDrive repository.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

User

Specifies a name of the OneDrive user. This cmdlet will return the OneDrive user with the specified name.

True

0

True (ByValue)

False

Name

Specifies a name of the document. The cmdlet will return the document with this name.

False

Named

False

True

ParentDocument

Specifies a parent document. The cmdlet will return the child documents of this parent document.

True

0

True (ByValue)

False

Recurse

Indicates that the cmdlet will return documents from all subfolders of the specified folder.

False

Named

False

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Example 1

This example shows how to get the document.txt document and its children from the userAlpha user.

  1. Run the Get-VEODRestoreSession cmdlet to get an active restore session. Save the result to the $session variable.
  2. Run the Get-VEODUser cmdlet with the $session variable to get the user. Save the result to the $user variable.
  3. Run the Get-VEODDocument cmdlet with the $user variable and Name parameter to get the specific OneDrive document. Use the Recurse parameter to get all children of the parent document.txt document.

$session = Get-VEODRestoreSession

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

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

Example 2

This example shows how to get subfolders under the folder parent folder.

  1. Run the Get-VEODRestoreSession cmdlet to get an active restore session. Save the result to the $session variable.
  2. Run the Get-VEODUser cmdlet with the $session variable to get the user. Save the result to the $user variable.
  3. Run the Get-VEODDocument cmdlet with the $folder variable and the Name parameter to get the specific folder from the specified user.
  4. Run the Get-VEODDocument cmdlet with the $folder variable. Use the ParentDocument and Recurse parameters to get all child documents of the parent document.

$session = Get-VEODRestoreSession

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

$folder = Get-VEODDocument -User $user -Name “folder”

Get-VEODDocument -ParentDocument $folder -Name “document.txt” -Recurse

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