Start-VBREntraIDTenantRestore
Short Description
Starts a restore session for a Microsoft Entra ID tenant.
Applies to
Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License
Syntax
Start-VBREntraIDTenantRestore [-Backup] <VBREntraIDTenantBackup> [<CommonParameters>] |
Detailed Description
This cmdlet starts a restore session for an Entra ID tenant.
If the application that you used while 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.
Then you can use the following cmdlets:
- Restore-VBREntraIDTenantItem to restore the entire Entra ID items (users, roles and so on).
- Restore-VBREntraIDTenantItemAttributes to restore Entra ID item attributes.
Parameters
Parameter | Description | Type | Required | Position | Accept |
|---|---|---|---|---|---|
Backup | Specifies a tenant backup from which you want to restore data. | Accepts the VBREntraIDTenantBackup object. To get this object, run the Get-VBREntraIDTenantBackup cmdlet. | True | 0 | 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
This example shows how to start a tenant restore session for the backup created by the Tenant backup job.
$backup = Get-VBREntraIDTenantBackup -Name "Tenant backup" $tenantRestoreSession = Start-VBREntraIDTenantRestore -Backup $backup |
Perform the following steps:
- Run the Get-VBREntraIDTenantBackup cmdlet. Specify the Name parameter value. Save the result to the $backup variable.
- Run the Start-VBREntraIDTenantRestore cmdlet. Set the $backup variable as the Backup parameter value. Save the result to the $tenantRestoreSession variable.
Related Commands