Get-VBORestoreSession

Short Description

Returns Veeam Backup for Microsoft 365 restore sessions.

Syntax

This cmdlet provides the following parameter sets:

  • DefaultParameterSet (Default)

    Get-VBORestoreSession [-Name <String>] [-Status <VBORestoreSessionStatus>] [-Result <VBORestoreSessionResult>]

    [-Last] [<CommonParameters>]

  • ByIdParameterSet

    Get-VBORestoreSession -Id <Guid> [<CommonParameters>]

Detailed Description

This cmdlet returns restore sessions.

Parameters

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Id

Specifies an ID of the restore session. The cmdlet will return details of the restore session with this ID.

Guid

True

Named

False

Last

Defines that the cmdlet will return the latest restore session.

Default: False

SwitchParameter

False

Named

False

Name

Specifies a name of the restore session. The cmdlet will return the restore session with this name.

String

False

Named

False

Result

Specifies the status of the completed restore session:

  • Success
  • Warning
  • Failed

The cmdlet will return the restore session with the specified result.

VBORestoreSessionResult

False

Named

False

Status

Specifies the current status of the restore session:

  • Running
  • Stopped

The cmdlet will return the restore session with the specified status.

VBORestoreSessionStatus

False

Named

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About Common Parameters section of Microsoft Learn.

Output Object

The cmdlet returns the VBORestoreSession object that contains restore session details.

Examples

Get-VBORestoreSessionExample 1: Getting Specific Restore Session by ID

This command returns a restore session with the ID 4a4aaaa4-4aa4-44a4-aaa4-a4a444444aa4.

Get-VBORestoreSession -Id 4a4aaaa4-4aa4-44a4-aaa4-a4a444444aa4

Get-VBORestoreSessionExample 2: Getting Specific Restore Session by Name

This command returns a restore session with the specified name.

Get-VBORestoreSession -Name "TestRestoreSession"

Page updated 2026-08-21

Page content applies to build 8.6.0.1102