Get-VBORestorePoint

In this article

    Short Description

    Returns restore points.

    Syntax

    This cmdlet provides parameter sets that allow you to:

    • Get restore points created by a specific backup job.

    Get-VBORestorePoint -Job <VBOJob> [-Repository <VBORepository>]  [<CommonParameters>]

    • Get restore points for a specific Veeam Backup for Microsoft 365 organization or backup repository.

    Get-VBORestorePoint [-Organization <VBOOrganization>] [-Repository <VBORepository>] [-IsLongTermCopy] [-IsRetrieved] [-Latest] [<CommonParameters>]

    Detailed Description

    This cmdlet returns restore points stored in Veeam Backup for Microsoft 365. Once you get restore points, you can do the following:

    • Start restore sessions to explore and restore backed-up Microsoft Exchange objects, SharePoint items, OneDrive items, and Microsoft Teams objects using the following cmdlets:
    • Create and start a retrieval job to retrieve data from backup copies created by Veeam Backup for Microsoft 365 in an archive object storage. For more information, see Start-VBODataRetrieval.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    Accept Wildcard Characters

    Job

    Specifies a backup job. The cmdlet will return restore points created by this backup job.

    Accepts the VBOJob object.

    To get this object, run the Get-VBOJob cmdlet.

    True

    Named

    True (ByValue)

    False

    Organization

    Specifies a Microsoft organization. The cmdlet will return restore points created for this organization.

    Accepts the VBOOrganization object.

    To get this object, run the Get-VBOOrganization cmdlet.

    False

    Named

    True (ByValue)

    False

    Repository

    Specifies a backup repository. The cmdlet will return restore points created for this backup repository.

    Accepts the VBORepository object.

    To get this object, run the Get-VBORepository cmdlet.

    False

    Named

    False

    False

    IsLongTermCopy

    Defines that the cmdlet will return restore points created for backup repository extended with an archive object storage.

    SwitchParameter

    False

    Named

    False

    False

    IsRetrieved

    Defines that the cmdlet will return restore points created by a retrieval job.

    SwitchParameter

    False

    Named

    False

    False

    Latest

    Defines that the cmdlet will return only the latest restore point.

    SwitchParameter

    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.

    Output Object

    The cmdlet returns an array of restore points created by Veeam Backup for Microsoft 365.

    Examples

    Get-VBORestorePointExample 1. Getting All Restore Points

    This command returns restore points created by all backup jobs in Veeam Backup for Microsoft 365:

    Get-VBORestorePoint

    Get-VBORestorePointExample 2. Getting Restore Points for Specific Backup Job

    This example shows how to get restore points created by Veeam Backup for Microsoft 365 for a specific backup job.

    $job = Get-VBOJob -Name "Backup: Sales Mailbox"

    Get-VBORestorePoint -Job $job

    Perform the following steps:

    1. Run the Get-VBOJob cmdlet with the Name parameter to get the backup job for which you want to get restore points. Save the result to the $job variable.
    2. Run the Get-VBORestorePoint cmdlet. Set the $job variable as the Job parameter value.

    Get-VBORestorePointExample 3. Getting Restore Points for Specific Organization

    This example shows how to get restore points created by Veeam Backup for Microsoft 365 for a specific organization.

    $org = Get-VBOOrganization -Name "ABC"

    Get-VBORestorePoint -Organization $org

    Perform the following steps:

    1. Run the Get-VBOOrganization cmdlet with the Name parameter to get the organization with the name ABC. Save the result to the $org variable.
    2. Run the Get-VBORestorePoint cmdlet. Set the $org variable as the Organization parameter value.

    Get-VBORestorePointExample 4. Starting Exchange Items Restore Session

    This example shows how to start a restore session to explore backed-up Microsoft Exchange objects for the first restore point of a specific backup job.

    $job = Get-VBOJob -Name "Backup: Sales Mailbox"

    $restorepoint = (Get-VBORestorePoint -Job $job | Sort -Property BackupTime)

    Start-VBOExchangeItemRestoreSession -RestorePoint $restorepoint[0]

    Perform the following steps:

    1. Run the Get-VBOJob cmdlet with the Name parameter to get the backup job for which you want to start a restore session. Save the result to the $job variable.
    2. Run the Get-VBORestorePoint cmdlet to get an array of restore points automatically sorted descending by BackupTime. Set the $job variable as the Job parameter value. Save the result to the $restorepoint variable.
    3. Run the Start-VBOExchangeItemRestoreSession cmdlet. Set the $restorepoint variable as the RestorePoint parameter value.

    Get-VBORestorePointExample 5. Getting Restore Points for Backup Repository Extended with Archive Storage

    This example shows how to get restore points created by Veeam Backup for Microsoft 365 for a specific backup repository extended with an archive object storage.

    $archiverepo = Get-VBORepository -Name "Azure Archive Storage" -LongTerm

    Get-VBORestorePoint -Repository $archiverepo -IsLongTermCopy

    Perform the following steps:

    1. Run the Get-VBORepository cmdlet with the Name parameter. Provide the LongTerm parameter. Save the result to the $archiverepo variable.
    2. Run the Get-VBORestorePoint cmdlet. Set the $archiverepo variable as the Repository parameter value. Provide the IsLongTermCopy parameter.

    Related Commands