Get-VBREntraIDTenantRestoreSession

Short Description

Returns restore sessions started to recover Microsoft Entra ID tenant backups.

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

Syntax

Get-VBREntraIDTenantRestoreSession [-Id <Guid[]>] [<CommonParameters>]

Detailed Description

This cmdlet returns restore sessions started to recover Entra ID tenant backups. If you do not provide any parameters, the cmdlet returns all restore sessions.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Id	Specifies an array of restore session IDs. The cmdlet will return restore sessions with these IDs.	`Guid[]`	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 array of VBREntraIDTenantRestoreSession objects that contain settings of restore sessions started to recover Entra ID tenant backups.

Examples

Getting Entra ID Tenant Restore Session by ID

This example shows how to get a tenant restore session by its ID.

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

$tenantRestoreSession = Start-VBREntraIDTenantRestore -Backup $backup

...

$session = Get-VBREntraIDTenantRestoreSession -Id $tenantRestoreSession.Id

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.
Run the Get-VBREntraIDTenantRestoreSession cmdlet. Set the $tenantRestoreSession.Id variable as the Id parameter value. Save the result to the $session variable.