Share via

Get-OBRecoverableItem

Module:
MSOnlineBackup Module

Gets the array of OBRecoverableItem objects associated with the server.

Syntax

UNNAMED_PARAMETER_SET_1 

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

UNNAMED_PARAMETER_SET_2 

Get-OBRecoverableItem
    [-ParentItem] <CBRecoverableItem>
    [[-PagingContext] <CBPagingContext>]

UNNAMED_PARAMETER_SET_3 

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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UNNAMED_PARAMETER_SET_1
Position:3
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PagingContext

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

Parameter properties

Type:CBPagingContext
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UNNAMED_PARAMETER_SET_1
Position:3
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False
UNNAMED_PARAMETER_SET_2
Position:3
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-ParentItem

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

Parameter properties

Type:CBRecoverableItem
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UNNAMED_PARAMETER_SET_2
Position:2
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-RecoveryPoint

Specifies the RecoveryPoint to get the OBRecoverableItem[] object.

Parameter properties

Type:CBRecoverableItem
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UNNAMED_PARAMETER_SET_1
Position:4
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Source

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

Parameter properties

Type:CBRecoverableSource
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UNNAMED_PARAMETER_SET_3
Position:2
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

Inputs

None

Outputs

Microsoft.Internal.CloudBackup.Commands.OBRecoverableItem