Restore-VBREntraIDTenantItemAttributes

Short Description

Restores properties of Microsoft Entra ID items.

Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License

Syntax

Restore-VBREntraIDTenantItemAttributes -Session <VBREntraIDTenantRestoreSession> [-CredentialsId <Guid>]

-RestorePoint <VBREntraIDTenantRestorePoint> -Item <VBREntraIDTenantItem>

-IncludedProperties <VBREntraIDTenantItemIncludedProperty[]> [-Reason <String>] [<CommonParameters>]

Detailed Description

This cmdlet restores properties of Entra ID items.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
CredentialsId	Used only if you requested login using the `Request-VBREntraIDLogin` cmdlet. Specifies the ID of the login session. Set the parameter value to the value returned by the `Request-VBREntraIDLogin` cmdlet.	`Guid`	False	Named	False
IncludedProperties	Specifies an array of the properties that you want to restore. Accepts the `VBREntraIDTenantItemIncludedProperty[]` object. To create this object, run the `New-VBREntraIDTenantItemIncludedProperty` cmdlet.	`VBREntraIDTenantItemIncludedProperty[]`	True	Named	False
Item	Specifies the item whose properties you want to restore. Accepts the `VBREntraIDTenantItem` object. To get this object, run the `Get-VBREntraIDTenantItem` cmdlet.	`VBREntraIDTenantItem`	True	Named	False
Reason	Specifies the reason of the restore operation.	`String`	False	Named	False
RestorePoint	Specifies a restore point from which you want to restore Entra ID items. Accepts the `VBREntraIDTenantRestorePoint` object. To get this object, run the `Get-VBREntraIDTenantRestorePoint` cmdlet.	`VBREntraIDTenantRestorePoint`	True	Named	False
Session	Specifies the restore session started to recover items backed-up by a tenant backup job. Accepts the `VBREntraIDTenantRestoreSession` object. To create this object, run the `Start-VBREntraIDTenantRestore` cmdlet.	`VBREntraIDTenantRestoreSession`	True	Named	False

<CommonParameters>

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

Output Object

Guid.

Examples

Restoring Manager Reference of User

This example shows how to restore the manager reference of a user.

$tenantRestoreSession = Get-VBREntraIDTenantRestoreSession -Id "901e32ac-4c9e-4f7a-9b36-a4fd0f7248fe"

$backup = Get-VBREntraIDTenantBackup -Name "Tenant backup"

$oldRP = Get-VBREntraIDTenantRestorePoint -Backup $backup -Id "a66808bc-780e-46f2-8538-63ace3c8f9be"

$item = Get-VBREntraIDTenantItem -Backup $backup -Type User -Name "Test Admin"

$compareInfo = Compare-VBREntraIDTenantItem -Session $tenantRestoreSession -Item $item -OldRestorePoint $oldRP

$managerReferenceObj = New-VBREntraIDTenantItemIncludedProperty -PropertyId $compareInfo.References.Values[0].ReferenceId -GroupId $compareInfo.References.ReferenceType[0]

$sessionId = Restore-VBREntraIDTenantItemAttributes -Session $tenantRestoreSession -RestorePoint $oldRP -Item $item -IncludedProperties $managerReferenceObj

Perform the following steps:

Run the Get-VBREntraIDTenantRestoreSession cmdlet. Specify the Id parameter value. Save the result to the $tenantRestoreSession variable.
Run the Get-VBREntraIDTenantBackup cmdlet. Specify the Name parameter value. Save the result to the $backup variable.
Run the Get-VBREntraIDTenantRestorePoint cmdlet. Set the $backup variable as the Backup parameter value. Specify the Id parameter value. Save the result to the $oldRP variable.
Run the Get-VBREntraIDTenantItem cmdlet. Set the $backup variable as the Backup parameter value. Specify the Type and Name parameter value. Save the result to the $item variable.
Run the Compare-VBREntraIDTenantItem cmdlet. Specify the following settings:
- Set the $tenantRestoreSession variable as the Session parameter value.
- Set the $item variable as the Item parameter value.
- Set the $oldRP variable as the OldRestorePoint parameter value.
- Save the result to the $compareInfo variable.
Run the New-VBREntraIDTenantItemIncludedProperty cmdlet. Specify the following settings:
- Set the $compareInfo.References.Values[0].ReferenceId variable as the PropertyId parameter value.
  The manager reference ID is the first in the received array of references.
- Set the $compareInfo.References.ReferenceType[0] variable as the GroupId parameter value.
  The manager reference is the first in the received array of references.
- Save the result to the $managerReferenceObj variable.
Run the Restore-VBREntraIDTenantItemAttributes cmdlet. Specify the following settings:
- Set the $tenantRestoreSession variable as the Session parameter value.
- Set the $oldRP variable as the RestorePoint parameter value.
- Set the $item variable as the Item parameter value.
- Set the $managerReferenceObj variable as the IncludedProperties parameter value.
- Save the result to the $sessionId variable.