Start-VBREntraIDTenantRestore

Short Description

Starts a restore session for a Microsoft Entra ID tenant.

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

Syntax

Detailed Description

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

If the application used for adding the tenant does not have the required roles, use the Request-VBREntraIDLoginRequests login to Microsoft Entra ID using an account associated with the tenant whose data you are restoring. 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-VBREntraIDTenantItemRestores a Microsoft Entra ID item. to restore the entire Entra ID items (users, roles and so on).
• Restore-VBREntraIDTenantItemAttributesRestores properties of Microsoft Entra ID items. to restore Entra ID item attributes.

Parameters

<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

This example shows how to start a tenant restore session for the backup created by the Tenant backup job.

Perform the following steps:

1. Run the Get-VBREntraIDTenantBackupReturns backups of Microsoft Entra ID tenants. cmdlet. Specify the Name parameter value. Save the result to the $backup variable.
2. Run the Start-VBREntraIDTenantRestore cmdlet. Set the $backup variable as the Backup parameter value. Save the result to the $tenantRestoreSession variable.

Related Commands

Get-VBREntraIDTenantBackupReturns backups of Microsoft Entra ID tenants.