Save-VBREntraIDLogsBackupFLRItem

Short Description

Restores files and folders backed up by a log backup job that protects Microsoft Entra ID audit and sign-in logs.

Product Edition: Enterprise Plus, Veeam Universal License

Syntax

Save-VBREntraIDLogsBackupFLRItem -Item <VBRUnstructuredBackupFLRItem[]> -Server <VBRUnstructuredServer>

-Path <String> [-RunAsync] [-RetrievalSettings <VBRUnstructuredBackupColdStorageRetrievalSettings>] [-Force] [<CommonParameters>]

Detailed Description

This cmdlet restores and saves files and folders backed up by a log backup job.

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
Item	Specifies an array of Entra ID log files and folders that you want to restore. Accepts the `VBREntraIDLogsBackupFLRItem[]` object. To get this object, run the `Get-VBREntraIDLogsBackupFLRItem` cmdlet.	`VBRUnstructuredBackupFLRItem[]`	True	Named	True (ByPropertyName, ByValue)
Path	Specifies the path to the folder where you want to restore log files or folders.	`String`	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
RunAsync	Defines that the command returns immediately without waiting for the task to complete.	`SwitchParameter`	False	Named	False
Server	Specifies the file share to which you want to restore log files or folders. Accepts the `VBRUnstructuredServer` object. To get this object, run the `Get-VBRUnstructuredServer` cmdlet.	`VBRUnstructuredServer`	True	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 VBRUnstructuredBackupFLRItem objects that contain settings of restored log files and folders.

Examples

Restoring Log Files

This example shows how to restore the log files whose names start with 2024-11-01T10. The files are restored to the \\WinSrv\Reports file share to the \\WinSrv\Reports\Restored folder.

$tenant = Get-VBREntraIdTenant -AzureTenantId "xxxxx"

$logBackups = Get-VBREntraIDLogsBackup

$logRestoreSession = Start-VBREntraIDLogsBackupFLRSession -Backup $logBackups[0] -Tenant $tenant

$fileshare = Get-VBRUnstructuredServer -Name "\\WinSrv\Reports"

$files = Get-VBREntraIDLogsBackupFLRItem -Session $logRestoreSession -Name "2024-11-01T10*" -Recurse

Save-VBREntraIDLogsBackupFLRItem -Server $fileshare -Item $files -Path "\\WinSrv\Reports\Restored"

Perform the following steps:

Run the Get-VBREntraIdTenant cmdlet. Specify the AzureTenantId parameter value. Save the result to the $tenant variable.
Run the Get-VBREntraIDLogsBackup cmdlet.

The Get-VBREntraIDLogsBackup cmdlet will return an array of backups. Mind the ordinal number of the necessary backup, for arrays it starts with 0. In our example, it is the first backup in the array.
Run the Start-VBREntraIDLogsBackupFLRSession cmdlet. Set the $logBackups[0] variable as the Backup parameter value. Set the $tenant variable as the Tenant parameter value. Save the result to the $logRestoreSession variable.
Run the Get-VBRUnstructuredServer cmdlet. Specify the Name parameter value. Save the result to the $fileshare variable.
Run the Get-VBREntraIDLogsBackupFLRItem cmdlet. Specify the following settings:
- Set the $logRestoreSession variable as the Session parameter value.
- Specify the Name parameter value.
- Provide the Recurse parameter value.
- Save the result to the $files variable.
Run the Save-VBREntraIDLogsBackupFLRItem cmdlet. Specify the following settings:
- Set the $files variable as the Item parameter value.
- Set the $fileshare variable as the Server parameter value.
- Specify the Path parameter value.