Stop-VBRVMRestoreToAzure

Short Description

Stops running VM backup restore to Microsoft Azure sessions.

Platform: VMware, Hyper-V

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

Syntax

Stop-VBRVMRestoreToAzure -Session <VBRAzureRestoreSession> [-Wait] [<CommonParameters>]

Detailed Description

This cmdlet stops a selected VM backup restore to Microsoft Azure session.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Session	Specifies the restore session you want to stop. Accepts the `VBRAzureRestoreSession` object. To get this object, run the `Get-VBRAzureRestoreSession` cmdlet.	`VBRAzureRestoreSession`	True	Named	True (ByValue)
Wait	Defines that the command waits for the process to complete before accepting more input.	`SwitchParameter`	False	Named	False

<CommonParameters>

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

Output Object

Examples

Stopping Most Recent Restore to Azure Session

This example shows how to stop the most recent restore to Azure session.

$session = Get-VBRAzureRestoreSession | Sort-Object CreationTime -Descending | Select -First 1

Stop-VBRVMRestoreToAzure -Session $session

Perform the following steps:

Get the most recent restore to Azure session:
- Run the Get-VBRAzureRestoreSession cmdlet.
- Pipe the cmdlet output to the Sort-Object cmdlet. Specify the CreationTime parameter.
- Pipe the cmdlet output to the Select cmdlet. Specify the First parameter.
- Save the result to the $session variable.
Run the Stop-VBRVMRestoreToAzure cmdlet. Set the $session variable as the Session parameter value.