Stop-VBORestoreSession

In this article

    Short Description

    Stops a specific Veeam Backup for Microsoft 365 restore session.

    Syntax

    Stop-VBORestoreSession -Session <VBORestoreSession> [-WhatIf] [-Confirm]  [<CommonParameters>]

    Detailed Description

    This cmdlet stops a specific restore session.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept Pipeline Input

    Accept Wildcard Characters

    Session

    Specifies a restore session that you want to stop.

    True

    Named

    False

    False

    WhatIf

    Defines that the cmdlet will write a message that describes the effects of running the cmdlet without actually performing any action.

    False

    Named

    False

    False

    Confirm

    Defines that the cmdlet will display a prompt that asks if the user is sure that he wants to continue.

    False

    Named

    False

    False

    <CommonParameters>

    This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

    Examples

    Example 1. Stopping Restore Session

    This example shows how to stop a restore session.

    $session = Get-VBORestoreSession

    Stop-VBORestoreSession -Session $session

    Perform the following steps:

    1. Run the Get-VBORestoreSession cmdlet to get the restore session you want to stop. Save the result to the $session variable.
    2. Run the Stop-VBORestoreSession cmdlet with the $session variable.

    Related Commands

    Get-VBORestoreSession