Share via

Get-OBRecoverableItem

  • Reference
Module:
MSOnlineBackup

Gets the array of OBRecoverableItem objects associated with the server.

Syntax

Get-OBRecoverableItem
   [-Location] <String>
   [-RecoveryPoint] <CBRecoverableItem>
   [[-PagingContext] <CBPagingContext>]
Get-OBRecoverableItem
   [-ParentItem] <CBRecoverableItem>
   [[-PagingContext] <CBPagingContext>]
Get-OBRecoverableItem
   [-Source] <CBRecoverableSource>

Description

The Get-OBRecoverableItem cmdlet gets the list of OBRecoverableItem[] objects associated with the specified Microsoft Azure Backup server (OBServer object). The OBRecoverableItem[] objects define what items will be recovered from the list of backup items.

To use Microsoft Azure Backup cmdlets, the user needs to be an administrator on the protected machine.

Examples

EXAMPLE 1

Get-OBRecoverableSource | Where-Object -FilterScript {$_.FriendlyName -like "C*"} | Get-OBRecoverableItem

This example returns a recoverable item from source.

EXAMPLE 2

$pc = New-OBPagingContext



$parents = Get-OBRecoverableSource | Where-Object -FilterScript {$_.FriendlyName -like "C*"} | Get-OBRecoverableItem



New-OBPagingContext | Get-OBRecoverableItem -ParentItem $parents[0] -Type FileOnly

This example returns a recoverable item based on browse.

Parameters

-Location

Specifies the path of the root folder to start searching the OBRecoverableItem[] object.

Type:String
Position:3
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-PagingContext

Specifies the OBPagingContext object which contains pagination options to retrieve the OBRecoverableItem[] object as part of search, browse, or search and browse.

Type:CBPagingContext
Position:3
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ParentItem

Specifies the parent OBRecoverableItem[] object from which to obtain the list of one or more child OBRecoverableItem[] objects as part of Recovery.

Type:CBRecoverableItem
Position:2
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-RecoveryPoint

Specifies the RecoveryPoint to get the OBRecoverableItem[] object.

Type:CBRecoverableItem
Position:4
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Source

Lists all root level OBRecoverableItem[] objects of the specified OBRecoverableSource object.

Type:CBRecoverableSource
Position:2
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

Inputs

None

Outputs

Microsoft.Internal.CloudBackup.Commands.OBRecoverableItem[]