Get-VBREntraIDTenantItemRestoreSession

Short Description

Returns a restore session launched for the item or attribute restore.

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

Syntax

Detailed Description

This cmdlet returns a restore session launched for the item or attribute restore.

Parameters

<CommonParameters>

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

Output Object

The cmdlet returns the VBREntraIDTenantItemRestoreSession object that contains settings of an item or attribute restore session.

Examples

Getting Item Restore Session

This example shows how to get an item restore session.

Perform the following steps:

1. Run the Get-VBREntraIDTenantRestoreSessionReturns restore sessions started to recover Microsoft Entra ID tenant backups. cmdlet. Specify the Id parameter value. Save the result to the $tenantRestoreSession variable.
2. Run the Get-VBREntraIDTenantBackupReturns backups of Microsoft Entra ID tenants. cmdlet. Specify the Name parameter value. Save the result to the $backup variable.
3. Run the Get-VBREntraIDTenantRestorePointReturns restore points of a Microsoft Entra ID tenant backup. cmdlet. Set the $backup variable as the Backup parameter value. Specify the Id parameter value. Save the result to the $restorePoint variable.
4. Run the Get-VBREntraIDTenantItemReturns Microsoft Entra ID items that a backup contains. cmdlet. Set the $backup variable as the Backup parameter value. Specify the Type and Name parameter value. Save the result to the $item variable.
5. Create the $defaultPsswd variable. Use the Read-Host cmdlet to get the application secret and convert it to a secure string.
6. Run the Restore-VBREntraIDTenantItemRestores a Microsoft Entra ID item. cmdlet. Specify the following settings:
   • Set the $tenantRestoreSession variable as the Session parameter value.
   • Set the $item variable as the Items parameter value.
   • Set the $restorePoint variable as the RestorePoint parameter value.
   • Set the $defaultPsswd variable as the DefaultUserPassword parameter value.
   • Save the result to the $itemRestoreSessionId variable.
7. Run the Get-VBREntraIDTenantItemRestoreSession cmdlet. Specify the following settings:
   • Set the $itemRestoreSessionId variable as the Id parameter value.
   • Set the $tenantRestoreSession variable as the ParentSession parameter value.
   • Save the result to the $session variable.

Related Commands

• Get-VBREntraIDTenantRestoreSessionReturns restore sessions started to recover Microsoft Entra ID tenant backups.
• Get-VBREntraIDTenantBackupReturns backups of Microsoft Entra ID tenants.
• Get-VBREntraIDTenantRestorePointReturns restore points of a Microsoft Entra ID tenant backup.
• Get-VBREntraIDTenantItemReturns Microsoft Entra ID items that a backup contains.
• Restore-VBREntraIDTenantItemRestores a Microsoft Entra ID item.