Get-VBRAzureRestoreSession

Short Description

Returns VM backup restore to Microsoft Azure sessions.

Platform: VMware, Hyper-V

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

Syntax

This cmdlet provides the following parameter sets:

AllParameterSets (Default)

Get-VBRAzureRestoreSession [<CommonParameters>]
Session

Get-VBRAzureRestoreSession [-Session <VBRAzureRestoreSession>] [<CommonParameters>]
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 cmdlet to stop the running session.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Id	Specifies the ID of the Microsoft Azure session you want to get.	`Guid`	False	Named	True (ByPropertyName)
Session	Specifies the restore to Microsoft Azure session you want to get. Accepts the `VBRAzureRestoreSession` object. To get this object, run the `Get-VBRAzureRestoreSession` cmdlet.	`VBRAzureRestoreSession`	False	Named	True (ByPropertyName, ByValue)

<CommonParameters>

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

Output Object

VBRAzureRestoreSession

Examples

Get-VBRAzureRestoreSession Example 1. Getting All Restore to Azure Sessions

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

Get-VBRAzureRestoreSession

Get-VBRAzureRestoreSession Example 2. Getting Restore Session and Its Status

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

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

Perform the following steps:

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.