Start-VBREntraIDTenantCopyRestore

Short Description

Starts a restore session from a backup copy of a Microsoft Entra ID tenant.

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

Syntax

Start-VBREntraIDTenantCopyRestore -RestorePoint <VBRNASBackupRestorePoint> [-Reason <String>]

[-RetrievalSettings <VBRUnstructuredBackupColdStorageRetrievalSettings>] [-Force] [<CommonParameters>]

Detailed Description

This cmdlet starts a restore session for an Entra ID tenant using a backup copy.

If the application used for adding the tenant does not have the required roles, use the Request-VBREntraIDLogin cmdlet to get access to Entra ID. For more information on the required permissions, see the Permissions section in the User Guide for Microsoft Entra ID.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Force	Defines that the cmdlet will modify settings of managed file shares without showing warnings in the PowerShell console.	`SwitchParameter`	False	Named	False
Reason	Specifies the reason of the restore operation.	`String`	False	Named	False
RestorePoint	Specifies a restore point. The cmdlet will start restore to recover backup files to the specified restore point. Accepts the `VBRNASBackupRestorePoint` object. To get this object, run the `Get-VBRUnstructuredBackupRestorePoint` cmdlet.	`VBRNASBackupRestorePoint`	True	Named	False
RetrievalSettings	Specifies the retrieval policy settings. The cmdlet will use these settings to retrieve data from archive repositories. Accepts the `VBRUnstructuredBackupColdStorageRetrievalSettings` object. To create this object, run the `New-VBRUnstructuredBackupColdStorageRetrievalSettings` cmdlet.	`VBRUnstructuredBackupColdStorageRetrievalSettings`	False	Named	False

<CommonParameters>

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

Output Object

The cmdlet returns the VBREntraIDTenantRestoreSession object that contains properties of the tenant restore session.

Examples

Starting Entra ID Tenant Restore Session from Backup Copy

This example shows how to start a tenant restore session from the Tenant backup backup copy located on the \\WinSRV2049\Documents file share.

$backup = Get-VBRUnstructuredBackup -Name "Tenant Backup"

$server = Get-VBRUnstructuredServer -Name "\\WinSRV2049\Documents"

$restorePoint = Get-VBRUnstructuredBackupRestorePoint -Server $server -Backup $backup

$retrieval = New-VBRUnstructuredBackupColdStorageRetrievalSettings -AmazonS3GlacierRetrievalPolicy HighPriority -AvailabilityPeriodDays 7 -EnableExpirationNotification -ExpirationHoursThreshold 24

$tenantRestoreSession = Start-VBREntraIDTenantCopyRestore -RestorePoint $restorePoint -Reason "users restore" -RetrievalSettings $retrieval

Perform the following steps:

Run the Get-VBRUnstructuredBackup cmdlet. Specify the Name parameter value. Save the result to the $backup variable.
Run the Get-VBRUnstructuredServer cmdlet. Specify the Name parameter value. Save the result to the $server variable.
Run the Get-VBRUnstructuredBackupRestorePoint cmdlet. Set the $server variable as the Server parameter value and the $backup variable as the Backup parameter value. Save the result to the $restorePoint variable.
Run the New-VBRUnstructuredBackupColdStorageRetrievalSettings cmdlet. Specify the AmazonS3GlacierRetrievalPolicy, AvailabilityPeriodDays and ExpirationHoursThreshold parameter values. Save the result to the $retrieval variable.
Run the Start-VBREntraIDTenantCopyRestore cmdlet. Set the $restorePoint variable as the RestorePoint parameter value and the $retrieval variable as the RetrievalSettings parameter value. Specify the Reason parameter value. Save the result to the $tenantRestoreSession variable.