Get-VBODataRetrieval
Short Description
Returns retrieval jobs.
Syntax
This cmdlet provides the following parameter sets:
-
ByIdParameterSetGet-VBODataRetrieval -Id <Guid> [<CommonParameters>]
-
AllParameterSetGet-VBODataRetrieval [-Repository <VBORepository>] [-Organization <VBOOrganization>]
[-DataState <VBODataRetrievalDataState>] [<CommonParameters>]
Detailed Description
This cmdlet returns retrieval jobs configured in Veeam Backup for Microsoft 365.
Run the Get-VBODataRetrievalSessionReturns data retrieval sessions. cmdlet to get retrieval job IDs.
Parameters
|
Parameter |
Description |
Type |
Required |
Position |
Accept Pipeline Input |
|---|---|---|---|---|---|
|
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:
|
|
False |
Named |
False |
|
Id |
Specifies an ID of the retrieval job. The cmdlet will return the retrieval job with this ID. |
|
True |
Named |
False |
|
Organization |
Specifies a Microsoft organization. The cmdlet will return retrieval jobs for backed-up data of objects from this organization.
Accepts the
To get this object, run the |
False |
Named |
False |
|
|
Repository |
Specifies the object storage repository that was specified as a target for backup copy jobs. The cmdlet will return retrieval jobs for backed-up data stored in this object storage repository.
Accepts the
To get this object, run the |
False |
Named |
True (ByValue) |
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About Common Parameters section of Microsoft Learn.
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 Azure Archive Storage object storage repository and has the Retrieved status.
Perform the following steps:
|
Get-VBODataRetrievalSessionReturns data retrieval sessions.Get-VBORepositoryReturns backup repositories.Get-VBOOrganizationReturns Microsoft organizations added to the Veeam Backup for Microsoft 365 infrastructure.