Remove-SPEnterpriseSearchTenantConfiguration

Reference

Module:: sharepoint-server

Applies to:: SharePoint Server Subscription Edition

Removes all tenant specific search settings.

Syntax

Remove-SPEnterpriseSearchTenantConfiguration
      [-SiteSubscriptionId] <Guid>
      -SearchApplication <SearchServiceApplicationPipeBind>
      [-AssignmentCollection <SPAssignmentCollection>]
      [-Confirm]
      [-WhatIf]
      [<CommonParameters>]

Description

The Remove-SPEnterpriseSearchTenantConfigurationcmdlet removes all tenant specific search settings. The removed settings are: query Rules, result types, result sources, managed metadata, ranking models, search dictionaries, authoritative pages, query suggestion settings, client types and the default search center. Use this cmdlet when removing tenants and in conjunction with moving tenants. When moving a tenant, copy the tenant configuration from the source to the destination and then use this cmdlet to remove the tenant configuration from the source farm.

For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at SharePoint Server Cmdlets.

Examples

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

$ssa = Get-SPEnterpriseSearchServiceApplication
Remove-SPEnterpriseSearchTenantConfiguration -SiteSubscriptionId "00000000-0000-0000-0000-000000000001" -SearchApplication $ssa

This example uses Remove-SPEnterpriseSearchTenantConfiguration to remove all tenant specific settings from the search service application referenced by $ssa.

Parameters

-AssignmentCollection

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.

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.

Type:	SPAssignmentCollection
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-Confirm

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

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-SearchApplication

Specifies the name of the search application that contains the tenant configuration. 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.

Type:	SearchServiceApplicationPipeBind
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-SiteSubscriptionId

Specifies the site subscription of the tenant. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh.

Type:	Guid
Aliases:	Identity
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-WhatIf

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

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

Jaa