Get-VBOEntityData

Short Description

Returns a user, group, site, team or organization backed-up data.

Syntax

This cmdlet provides parameter sets that allow you to:

  • Get backed-up data by the associated backup repository and type of the entity data from a specific restore point.

Get-VBOEntityData -Repository <VBORepository> -Type {User | Group | Site | Team | Organization | OneDrive | Mailbox} [-Name <string>] [-RestorePoint <VBORestorePoint>] [-Organization <VBOOrganization>]  [<CommonParameters>]

  • Get a specific Microsoft organization backed-up data by the associated backup repository.

Get-VBOEntityData -Repository <VBORepository> -Organization <VBOOrganization>  [<CommonParameters>]

  • Get a specific user backed-up data by the associated backup repository.

Get-VBOEntityData -Repository <VBORepository> -User <VBOOrganizationUser>  [<CommonParameters>]

  • Get a specific group backed-up data by the associated backup repository.

Get-VBOEntityData -Repository <VBORepository> -Group <VBOOrganizationGroup>  [<CommonParameters>]

  • Get a specific SharePoint site backed-up data by the associated backup repository.

Get-VBOEntityData -Repository <VBORepository> -Site <VBOOrganizationSite>  [<CommonParameters>]

  • Get a specific team backed-up data by the associated backup repository.

Get-VBOEntityData -Repository <VBORepository> -Team <VBOOrganizationTeam>  [<CommonParameters>]

Detailed Description

This cmdlet returns a representation entity of the backed-up data of an organization user, organization group, organization site, organization team, or an organization itself. You can use it with the Move-VBOEntityData or Remove-VBOEntityData cmdlets.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Accept Wildcard Characters

Type

Specifies the entity data type. The cmdlet will return backed-up data for the entity of this type. You can select the following entity data types:

  • User
  • Group
  • Site
  • Team
  • Organization
  • OneDrive
  • Mailbox

Note: The OneDrive and Mailbox entity data types can be used only for backup repositories extended with an archive object storage.

VBOEntityDataType

True

Named

False

False

Name

Specifies a name filter for the searched data. The cmdlet will return a collection of the data with the specified name.

String

False

Named

False

True

Repository

Specifies a backup repository. The cmdlet will return backed-up data from this repository.

Accepts the VBORepository object.

To get this object, run the Get-VBORepository cmdlet.

True

Named

True (ByValue)

False

Group

Specifies an organization group. The cmdlet will return backed-up data for this group.

Accepts the VBOOrganizationGroup object.

To get this object, run the  Get-VBOOrganizationGroup cmdlet.

True

Named

False

False

Organization

Specifies a Microsoft organization. The cmdlet will return backed-up data for this organization.

Accepts the VBOOrganization object.

To get this object, run the Get-VBOOrganization cmdlet.

False

Named

False

False

RestorePoint

Specifies a restore point stored in Veeam Backup for Microsoft 365. The cmdlet will return backed-up data from this restore point.

Accepts the VBORestorePoint object.

To get this object, run the Get-VBORestorePoint cmdlet.

False

Named

False

False

Site

Specifies a SharePoint site. The cmdlet will return backed-up data for this site.

Accepts the VBOOrganizationSite object.

To get this object, run the Get-VBOOrganizationSite cmdlet.

True

Named

False

False

Team

Specifies an organization team. The cmdlet will return backed-up data for this team.

Accepts the VBOOrganizationTeam object.

To get this object, run the Get-VBOOrganizationTeam cmdlet.

True

Named

False

False

User

Specifies an organization user. The cmdlet will return backed-up data for this user.

Accepts the VBOOrganizationUser object.

To get this object, run the Get-VBOOrganizationUser cmdlet.

True

Named

False

False

<CommonParameters>

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

Examples

Get-VBOEntityDataExample 1. Getting Backed-Up Data of Specific User

This example shows how to get backed-up data of a user with the name Chuck Brown.

$repository = Get-VBORepository -Name "ABC Daily Backup"

Get-VBOEntityData -Repository $repository -Type User -Name "Chuck Brown"

Perform the following steps:

  1. Run the Get-VBORepository cmdlet with the Name parameter to get the backup repository. Save the result to the $repository variable.
  2. Run the Get-VBOEntityData cmdlet with the $repository variable and Name parameter to get backed-up data of a user with the name Chuck Brown.

Related Commands