Get-VBODataRetrieval

Short Description

Returns retrieval jobs.

Syntax

This cmdlet provides parameter sets that allow you to:

  • Get a retrieval job by the retrieval job ID.

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

  • Get retrieval jobs by the associated backup repository or Microsoft organization or status of the archived data.

Get-VBODataRetrieval [-Repository <VBORepository>] [-Organization <VBOOrganization>] [-DataState {Retrieving | Retrieved | ChangingAvailabilityPeriod | Removing}]  [<CommonParameters>]

Detailed Description

This cmdlet returns retrieval jobs configured in Veeam Backup for Microsoft 365.

Run the Get-VBODataRetrievalSession cmdlet to get retrieval job IDs.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Accept Wildcard Characters

Id

Specifies an ID of a retrieval job. The cmdlet will return the retrieval job with this ID.

Guid

True

Named

False

False

Repository

Specifies a backup repository extended with an archive object storage. The cmdlet will return retrieval jobs for archived data stored in this backup repository.

Accepts the VBORepository object.

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

False

Named

True (ByValue)

False

Organization

Specifies Microsoft organization. The cmdlet will return retrieval jobs for archived data of objects from this organization.

Accepts the VBOOrganization object.

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

False

Named

False

False

DataState

Specifies the status of archived data. The cmdlet will return retrieval jobs in which archived data has the specified status. You can select the following statuses:

  • Retrieving
  • Retrieved
  • ChangingAvailabilityPeriod
  • Removing

VBODataRetrievalDataState

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

Get-VBODataRetrievalExample 1. Getting Retrieval Job by ID

This example shows how to get a retrieval job by ID:

Get-VBODataRetrieval -Id f5fda89f-40a2-4d1c-8e05-f6bba94b6c50

Get-VBODataRetrievalExample 2. Getting Retrieval Job by Backup Repository and Archived Data Status

This example shows how to get a list of retrieval jobs in which archived data is stored in the backup repository with the name Azure Archive repository and has the Retrieved status.

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

Get-VBODataRetrieval -Repository $repository -DataState Retrieved

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-VBODataRetrieval cmdlet. Set the $repository variable as the Repository parameter value. Specify the DataState parameter value.

Related Commands