New-OBRecoverableItem
New-OBRecoverableItem
Creates a new OBRecoverableItem for the given path.
Syntax
Parameter Set: Default
New-OBRecoverableItem [-OBRecoverableItem] <CBRecoverableItem> [-RelativePath] <String> [-IsDir] <Boolean> [ <CommonParameters>]
Detailed 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.
Parameters
-IsDir<Boolean>
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.
Aliases |
none |
Required? |
true |
Position? |
3 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-OBRecoverableItem<CBRecoverableItem>
This is the point in time to which the relative path will be appended to create the new recoverable item.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-RelativePath<String>
This is the relative path which would be appended to the given recoverable item to create the new recoverable item.
Aliases |
none |
Required? |
true |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
- None
Outputs
The output type is the type of the objects that the cmdlet emits.
- Microsoft.Internal.CloudBackup.Commands.OBRecoverableItem
Examples
EXAMPLE 1
This example creates a new recovery item.
PS C:\> $sources = Get-OBRecoverableSource
PS C:\> $rp = Get-OBRecoverableItem $sources[0]
PS C:\> $new_item1 = New-OBRecoverableItem $rp[0] "resources\folder" $TRUE
PS C:\> $new_item2 = New-OBRecoverableItem $rp[0] "resources\folder\file.txt" $FALSE
PS C:\> Start-OBRecovery @($new_item1, $new_item2)