Share via

New-OBRecoverableItem

  • Reference
Module:
MSOnlineBackup

Creates a new OBRecoverableItem for the given path.

Syntax

New-OBRecoverableItem
   [-OBRecoverableItem] <CBRecoverableItem>
   [-RelativePath] <String>
   [-IsDir] <Boolean>

Description

The New-OBRecoverableItem cmdlet creates a new OBRecoverable item with a given relative path. This file path would be used to recover the file item from a recovery point.

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

Examples

EXAMPLE 1

$sources = Get-OBRecoverableSource
$rp = Get-OBRecoverableItem $sources[0]
$new_item1 = New-OBRecoverableItem $rp[0] "resources\folder" $TRUE
$new_item2 = New-OBRecoverableItem $rp[0] "resources\folder\file.txt" $FALSE
Start-OBRecovery @($new_item1, $new_item2)

This example creates a new recovery item.

Parameters

-IsDir

Specify if the relative path is a directory through the use of the Boolean value TRUE or a file by specifying FALSE. This parameter is mandatory.

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

-OBRecoverableItem

This is the point in time to which the relative path will be appended to create the new recoverable item.

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

-RelativePath

This is the relative path which would be appended to the given recoverable item to create the new recoverable item.

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

Inputs

None

Outputs

Microsoft.Internal.CloudBackup.Commands.OBRecoverableItem