This is an archive version of the document. To get the most up-to-date information, see the current version.

Get-VBRAzureRestoreSession

Short Description

Returns VM backup restore to Microsoft Azure sessions.

Applies to

Platform: VMware, Hyper-V

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

Syntax

This cmdlet provides 3 parameter sets.

  • For looking for all restore to Azure sessions:

Get-VBRAzureRestoreSession  [<CommonParameters>]

  • For looking for a specific restore to Azure session:

Get-VBRAzureRestoreSession [-Session <VBRAzureRestoreSession>]  [<CommonParameters>]

  • For looking for restore to Azure sessions by the session ID:

Get-VBRAzureRestoreSession [-Id <guid>]  [<CommonParameters>]

Detailed Description

This cmdlet returns restore to Microsoft Azure sessions. You can look for a session to check its status or to pass it to the Stop-VBRVMRestoreToAzure to stop the running session.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Session

Specifies the restore to Microsoft Azure session you want to get.

False

Named

True (ByValue,
ByProperty
Name)

False

Id

Specifies the ID of the Microsoft Azure session you want to get.

False

Named

True (ByProperty
Name)

False

<CommonParameters>

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

Return Type

VBRAzureRestoreSession

Example 1

This command gets all restore to Azure sessions that have been run on this Veeam backup server.

Get-VBRAzureRestoreSession

Example 2

This example shows how to get a restore session and check its status.

  1. Get all restore to Azure sessions and select the most recent one. Save it to the $session variable.
  2. Run Get-VBRAzureRestoreSession with the saved variable.

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