Start-VBODataRetrieval

Short Description

Creates and starts retrieval jobs.

Syntax

This cmdlet provides parameter sets that allow you to:

  • Create and start retrieval jobs to retrieve the archived Exchange data from Azure Archive Storage.

Start-VBODataRetrieval -RestorePoint <VBORestorePoint> -AvailabilityPeriodDays <int32> -AzureArchiveRetrievalPolicy {StandardPriority | HighPriority} [-Name <string>] [-Description <string>] [-EnableExpirationNotification] [-ExpirationHoursThreshold <int32>] [-ShowDeleted] [-ShowAllVersions] [-Mailbox <VBOMailboxData[]>] [<CommonParameters>]

  • Create and start retrieval jobs to retrieve the archived OneDrive data from Azure Archive Storage.

Start-VBODataRetrieval -RestorePoint <VBORestorePoint> -AvailabilityPeriodDays <int32> -AzureArchiveRetrievalPolicy {StandardPriority | HighPriority} [-Name <string>] [-Description <string>] [-EnableExpirationNotification] [-ExpirationHoursThreshold <int32>] [-ShowDeleted] [-ShowAllVersions] [-OneDrive <VBOOneDriveData[]>] [<CommonParameters>]

  • Create and start retrieval jobs to retrieve the archived SharePoint data from Azure Archive Storage.

Start-VBODataRetrieval -RestorePoint <VBORestorePoint> -AvailabilityPeriodDays <int32> -AzureArchiveRetrievalPolicy {StandardPriority | HighPriority} [-Name <string>] [-Description <string>] [-EnableExpirationNotification] [-ExpirationHoursThreshold <int32>] [-ShowDeleted] [-ShowAllVersions] [-Site <VBOSiteData[]>]  [<CommonParameters>]

  • Create and start retrieval jobs to retrieve the archived Teams data from Azure Archive Storage.

Start-VBODataRetrieval -RestorePoint <VBORestorePoint> -AvailabilityPeriodDays <int32> -AzureArchiveRetrievalPolicy {StandardPriority | HighPriority} [-Name <string>] [-Description <string>] [-EnableExpirationNotification] [-ExpirationHoursThreshold <int32>] [-ShowDeleted] [-ShowAllVersions] [-Team <VBOTeamData[]>]  [<CommonParameters>]

  • Create and start retrieval jobs to retrieve the archived Exchange data from Amazon S3 Glacier or Amazon S3 Glacier Deep Archive.

Start-VBODataRetrieval -RestorePoint <VBORestorePoint> -AvailabilityPeriodDays <int32> -AmazonS3GlacierRetrievalPolicy {Expedited | Standard | Bulk} [-Name <string>] [-Description <string>] [-EnableExpirationNotification] [-ExpirationHoursThreshold <int32>] [-ShowDeleted] [-ShowAllVersions] [-Mailbox <VBOMailboxData[]>]  [<CommonParameters>]

  • Create and start retrieval jobs to retrieve the archived OneDrive data from Amazon S3 Glacier or Amazon S3 Glacier Deep Archive.

Start-VBODataRetrieval -RestorePoint <VBORestorePoint> -AvailabilityPeriodDays <int32> -AmazonS3GlacierRetrievalPolicy {Expedited | Standard | Bulk} [-Name <string>] [-Description <string>] [-EnableExpirationNotification] [-ExpirationHoursThreshold <int32>] [-ShowDeleted] [-ShowAllVersions] [-OneDrive <VBOOneDriveData[]>]  [<CommonParameters>]

  • Create and start retrieval jobs to retrieve the archived SharePoint data from Amazon S3 Glacier or Amazon S3 Glacier Deep Archive.

Start-VBODataRetrieval -RestorePoint <VBORestorePoint> -AvailabilityPeriodDays <int32> -AmazonS3GlacierRetrievalPolicy {Expedited | Standard | Bulk} [-Name <string>] [-Description <string>] [-EnableExpirationNotification] [-ExpirationHoursThreshold <int32>] [-ShowDeleted] [-ShowAllVersions] [-Site <VBOSiteData[]>]  [<CommonParameters>]

  • Create and start retrieval jobs to retrieve the archived Teams data from Amazon S3 Glacier or Amazon S3 Glacier Deep Archive.

Start-VBODataRetrieval -RestorePoint <VBORestorePoint> -AvailabilityPeriodDays <int32> -AmazonS3GlacierRetrievalPolicy {Expedited | Standard | Bulk} [-Name <string>] [-Description <string>] [-EnableExpirationNotification] [-ExpirationHoursThreshold <int32>] [-ShowDeleted] [-ShowAllVersions] [-Team <VBOTeamData[]>]  [<CommonParameters>]

Detailed Description

This cmdlet creates and starts a retrieval job.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Accept Wildcard Characters

RestorePoint

Specifies a restore point stored in Veeam Backup for Microsoft 365 for a backup repository extended with an archive object storage. The cmdlet will create and start a retrieval job to retrieve archived data from this restore point.

Accepts the VBORestorePoint object.

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

True

Named

True (ByValue)

False

AvailabilityPeriodDays

Specifies the number of days during which the retrieved backed-up data will be available to explore and restore using Veeam Explorers.

Default: 1

Int32

True

Named

False

False

AzureArchiveRetrievalPolicy

Specifies a retrieval policy that you want to use for Azure Archive Storage. The cmdlet will create a retrieval job and apply the specified retrieval policy. You can select the following retrieval policies:

  • StandardPriority
  • HighPriority

Note: Data retrieval cost varies depending on the desired speed of the data retrieval process.

VBOAzureArchiveRetrievalPolicy

True

Named

False

False

AmazonS3GlacierRetrievalPolicy

Specifies a retrieval policy that you want to use for Amazon S3 Glacier and Amazon S3 Glacier Deep Archive. The cmdlet will create a retrieval job and apply the specified retrieval policy. You can select the following retrieval policies:

  • Expedited
  • Standard
  • Bulk

Note: Data retrieval cost varies depending on the desired speed of the data retrieval process.

The Expedited policy is unavailable for Amazon S3 Glacier Deep Archive.

VBOAmazonS3GlacierRetrievalPolicy

True

Named

False

False

Name

Specifies a retrieval job name. The cmdlet will add a retrieval job with this name.

String

False

Named

False

False

Description

Specifies a description of a retrieval job.

String

False

Named

False

False

EnableExpirationNotification

Defines that Veeam Backup for Microsoft 365 will notify you when the availability period is about to end.

SwitchParameter

False

Named

False

False

ExpirationHoursThreshold

For the EnableExpirationNotification option.

Specifies how many hours should remain before the retrieved backed-up data expires to send a notification by email.

Int32

False

Named

False

False

ShowDeleted

Defines that Veeam Backup for Microsoft 365 will retrieve items that have been removed by user before the specified date.

SwitchParameter

False

Named

False

False

ShowAllVersions

Defines that Veeam Backup for Microsoft 365 will retrieve all versions of items that have been modified by user before the specified date.

SwitchParameter

False

Named

False

False

Mailbox

Specifies an array of mailboxes whose backed-up data you want to retrieve from the archive. The cmdlet will create and start a retrieval job to retrieve archived data for these mailboxes.

VBOMailboxData[]

False

Named

False

False

OneDrive

Specifies an array of OneDrives whose backed-up data you want to retrieve from the archive. The cmdlet will create and start a retrieval job to retrieve archived data for these OneDrives.

VBOOneDriveData[]

False

Named

False

False

Site

Specifies an array of SharePoint sites whose backed-up data you want to retrieve from the archive. The cmdlet will create and start a retrieval job to retrieve archived data for these sites.

VBOSiteData[]

False

Named

False

False

Team

Specifies an array of teams whose backed-up data you want to retrieve from the archive. The cmdlet will create and start a retrieval job to retrieve archived data for these teams.

VBOTeamData[]

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 the VBODataRetrieval object that contains settings for a retrieval job.

Examples

Start-VBODataRetrievalExample 1. Starting Retrieval Job to Retrieve Mailbox Data

This example shows how to create and start the retrieval job that will retrieve mailbox data from the Azure Blob Storage Archive.

$repository = Get-VBORepository -Name "Azure Archive repository"

$mailbox = Get-VBOEntityData -Repository $repository -Type Mailbox -Name "User Mailbox"

$restorepoint = Get-VBORestorePoint -Repository $repository -Latest

Start-VBODataRetrieval -RestorePoint $restorepoint -AvailabilityPeriodDays 5 -AzureArchiveRetrievalPolicy HighPriority -Name "ABC User Mailbox" -EnableExpirationNotification -ExpirationHoursThreshold 2 -Mailbox $mailbox

Perform the following steps:

  1. Run the Get-VBORepository cmdlet. Specify the Name parameter value. Save the result to the $repository variable.
  2. Run the Get-VBOEntityData cmdlet. Set the $repository variable as the Repository parameter value. Specify the Type parameter value. Specify the Name parameter value. Save the result to the $mailbox variable.  
  3. Run the Get-VBORestorePoint cmdlet. Set the $repository variable as the Repository parameter value. Provide the Latest parameter. Save the result to the $restorepoint variable.
  4. Run the Start-VBODataRetrieval cmdlet. Specify the following settings:
  • Set the $restorepoint variable as the RestorePoint parameter value.
  • Specify the AvailabilityPeriodDays parameter value.
  • Specify the AzureArchiveRetrievalPolicy parameter value.
  • Specify the Name parameter value.
  • Provide the EnableExpirationNotification parameter.
  • Specify the ExpirationHoursThreshold parameter value.
  • Set the $mailbox variable as the Mailbox parameter value.

Related Commands