Stop-VBREntraIDTenantRestore

Short Description

Stops a Microsoft Entra ID tenant restore session.

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

Syntax

Stop-VBREntraIDTenantRestore -Session <VBREntraIDTenantRestoreSession> [-Graceful] [<CommonParameters>]

Detailed Description

This cmdlet stops an Entra ID tenant restore session. Use this cmdlet when you do not plan to restore any tenant data.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Graceful	Defines that the cmdlet will stop the session gracefully.	`SwitchParameter`	False	Named	False
Session	Specifies the session launched to restore a tenant. The cmdlet will stop this session. Accepts the `VBREntraIDTenantRestoreSession` object. To create this object, run the `Start-VBREntraIDTenantRestore` cmdlet.	`VBREntraIDTenantRestoreSession`	True	Named	False

<CommonParameters>

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

Examples

Stopping Entra ID Tenant Restore Session

This example shows how to stop a tenant restore session.

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

$tenantRestoreSession = Start-VBREntraIDTenantRestore -Backup $backup

...

Stop-VBREntraIDTenantRestore -Session $tenantRestoreSession -Graceful

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 Stop-VBREntraIDTenantRestoreSession cmdlet. Set the $tenantRestoreSession variable as the Session parameter value. Provide the Graceful parameter.