Export (0) Print
Expand All
Expand Minimize

Remove-SPEnterpriseSearchServiceApplicationSiteSettings

SharePoint 2013
 

Applies to: SharePoint Server 2013 Standard, SharePoint Server 2013 Enterprise, SharePoint Foundation 2013

Topic Last Modified: 2013-12-18

Cleans up search settings for a particular site collection, subscription, or search application.

Remove-SPEnterpriseSearchServiceApplicationSiteSettings [-Identity] <SiteSettingsPipeBind> -SearchApplication <SearchServiceApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-TenantId <Guid>] [-WhatIf [<SwitchParameter>]]

Use the Remove-SPEnterpriseSearchServiceApplicationSiteSettings cmdlet to remove all search settings for the specified site collection, subscription, or search application.

 

Parameter Required Type Description

Identity

Required

Microsoft.Office.Server.Search.Cmdlet.SiteSettingsPipeBind

Specifies the site collection to remove search settings from. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh.

SearchApplication

Required

Microsoft.Office.Server.Search.Cmdlet.SearchServiceApplicationPipeBind

Specifies the name of the search application. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object.

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.

NoteNote:
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

TenantId

Optional

System.Guid

Specifies the tenant from which to remove search settings. The type must be a valid GUID in the form 12345678-90ab-cdef-1234-567890bcdefgh.

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

--------EXAMPLE--------

$app = Get-SPEnterpriseSearchServiceApplication
$GC = Start-SPAssignment
$s = $GC | Get-SPSite UrlOfASiteCollection
Remove-SPEnterpriseSearchServiceApplicationSiteSettings -Identity $s.ID.ToString() -SearchApplication $app
Stop-SPAssignment $GC

This example removes the search settings for the site collection referenced by $s in the search application referenced by $app. $s is the site collection with URL "UrlOfSiteCollection", and $s.ID.ToString() is the string representation of the site ID.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft