New-OBPagingContext
New-OBPagingContext
Creates a new OBPagingContext object that is used in the Get-OBRecoverableItem cmdlet during searching and browsing through paginated recoverable items.
Syntax
New-OBPagingContext [ <CommonParameters>]
Detailed Description
The New-OBPagingContext cmdlet creates a new OBPagingContext object that is used in the Get-OBRecoverableItem cmdlet for to enable searching and browsing of paginated recoverable items. Providing the OBPagingContext object will intelligently retrieve paginated files and folders within the destination folder.
This cmdlet only needs to be called once during a session and the OBPagingContext object will be automatically refreshed when browsing or searching under different folders. In the Get-OBRecoverableItem cmdlet if the OBPagingContext object is not supplied the cmdlet would page as necessary for the cmdlet to retrieve and return all items listed recursively in the folder.
While searching and browsing as part of the Get-OBRecoverableItem cmdlet; if the OBPagingContext object is supplied, then re-running the same cmdlet would then fetch the 2nd page, and 3rd page, and so on until the last page is retrieved.
Parameters
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
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.OBPagingContext
Examples
EXAMPLE 1
This example creates a new paging context.
PS C:\> New-OBPagingContext