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 backed-up 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 the retrieval job. The cmdlet will return the retrieval job with this ID. | Guid | True | Named | False | False |
Repository | Specifies a backup repository extended with object storage that was specified as a target for backup copy jobs. The cmdlet will return retrieval jobs for backed-up 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 backed-up 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 a status of the backed-up data. The cmdlet will return retrieval jobs in which data has the specified status. You can select the following statuses:
| 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
Example 1. Getting Retrieval Job by ID
This command returns a retrieval job by ID.
|
Example 2. Getting Retrieval Job by Backup Repository and Data Status
This example shows how to get a list of retrieval jobs in which backed-up data is stored in the backup repository with the name Azure Archive repository and has the Retrieved status.
Perform the following steps:
|
Related Commands