Specifies the name of the Search service application from which to retrieve the related backup information.

BackupId

Optional

System.String

Specifies the GUID of the backup in the referred package.

UseMostRecent

Optional

System.Management.Automation.SwitchParameter

A switch to specify if the most recent backup should be used.

IsVerbose

Optional

System.Management.Automation.SwitchParameter

A switch to specify if messages should be printed out when the cmdlet is running.

AssignmentCollection

Optional

Microsoft.SharePoint.PowerShell.SPAssignmentCollection

Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.

Note:

When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.

Confirm

Optional

System.Management.Automation.SwitchParameter

Prompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparameters

WhatIf

Optional

System.Management.Automation.SwitchParameter

Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparameters

This example retrieves the backup of the search databases and index files that are located at \\sample\backup with the backup id 3222ad97-91ad-471f-a764-780ec1f05f74 from the Search service application Search Service Application.