Stop-VBREntraIDLogsBackupFLRSession

Short Description

Stops a restore session started to recover data from Microsoft Entra ID log backups.

Product Edition: Enterprise Plus, Veeam Universal License

Syntax

Stop-VBREntraIDLogsBackupFLRSession -Session <VBRUnstructuredBackupFLRSession> [-RunAsync] [<CommonParameters>]

Detailed Description

This cmdlet stops a restore sessions started to recover a Entra ID log backup.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
RunAsync	Defines that the command returns immediately without waiting for the task to complete.	`SwitchParameter`	False	Named	False
Session	Specifies the restore session that you want to stop. Accepts the `VBRUnstructuredBackupFLRSession` object. To create this object, run the `Start-VBREntraIDLogsBackupFLRSession` cmdlet. To get this object, run the `Get-VBRUnstructuredBackupFLRSession` cmdlet.	`VBRUnstructuredBackupFLRSession`	True	Named	True (ByPropertyName, ByValue)

<CommonParameters>

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

Examples

Stopping Entra ID Log Restore Session

This example shows how to stop a log restore session.

$tenant = Get-VBREntraIdTenant -AzureTenantId "xxxxx"

$logBackups = Get-VBREntraIDLogsBackup

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

...

Stop-VBREntraIDLogsBackupFLRSession -Session $logRestoreSession

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. Specify the following settings:
- 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 Stop-VBREntraIDLogsBackupFLRSession cmdlet. Set the $logRestoreSession variable as the Session parameter value.