Get-VBOEntityData

Short Description

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

Syntax

This cmdlet provides the following parameter sets:

ByType (Default)

Get-VBOEntityData -Repository <VBORepository> -Type <VBOEntityDataType> [-Name <String>]

[-Organization <VBOOrganization>] [<CommonParameters>]
ByOrganization

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

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

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

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

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

Get-VBOEntityData -Type <VBOEntityDataType> [-Name <String>] -RestorePoint <VBORestorePoint> [<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

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
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.	`VBOOrganizationGroup`	True	Named	False
Name	Specifies a name filter for the searched data. The cmdlet will return a collection of data with the specified name.	`String`	False	Named	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.	`VBOOrganization`	False	Named	False
Repository	Specifies a backup repository. The cmdlet will return backed-up data from this backup repository. Accepts the `VBORepository` object. To get this object, run the `Get-VBORepository` cmdlet.	`VBORepository`	True	Named	True (ByValue)
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.	`VBORestorePoint`	True	Named	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.	`VBOOrganizationSite`	True	Named	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.	`VBOOrganizationTeam`	True	Named	False
Type	Specifies a type of the entity data. 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 the object storage repository that was specified as a target for backup copy jobs.	`VBOEntityDataType`	True	Named	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.	`VBOOrganizationUser`	True	Named	False

<CommonParameters>

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

Examples

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:

Run the Get-VBORepository cmdlet with the Name parameter to get the backup repository. Save the result to the $repository variable.
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.