Remove-FASTSearchMetadataCategory

Article
07/25/2014

Applies to: SharePoint Server 2010

Removes a crawled property category from the installation.

Syntax

Remove-FASTSearchMetadataCategory -Category <Category> [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-WhatIf [<SwitchParameter>]]

Remove-FASTSearchMetadataCategory [-Name] <String> [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-WhatIf [<SwitchParameter>]]

Detailed Description

This cmdlet deletes a crawled property category from your installation. It contains more than one parameter set. You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. When doing simple operations, there is no difference between using the Category versus the Name parameter. The only difference is when using the Name parameter you look up the category each time, while when using the Category parameter you use the object you already have a reference to. However, when dealing with operations involving a large set of objects (for example iterating over all categories), avoiding extra lookups by name can be slightly more efficient. For more information about how to use parameter sets, see Cmdlet Parameter Sets.

All crawled properties mapped to this category are also removed. To avoid deleting crawled properties belonging to a category that you are about to remove, first map all crawled properties that you wish to save to a different property set using the Set-FASTSearchMetadataCrawledProperty cmdlet.

Parameters

Parameter	Required	Type	Description
Name	Required	System.String	The name of the category to delete.
Category	Required	Microsoft.SharePoint.Search.Extended.Administration.Schema.Category	A category object to be deleted.
Confirm	Optional	System.Management.Automation.SwitchParameter	Activates user prompting to confirm the operation. If set, prompting is activated. If Confirm is false (`-Confirm $false`), confirmation prompting is not used. In cases where Confirm is not specified, the cmdlet will prompt if the `$ConfirmPreference` shell variable is equal to or greater than the ConfirmImpact setting of the cmdlet (HIGH).
Force	Optional	System.Management.Automation.SwitchParameter	Overrides any user prompting settings, so that confirmation of the operation is not required.
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

Input Types

Return Types

Example

---------------EXAMPLE 1-----------------

Remove-FASTSearchMetadataCategory -name Sharepoint

This example deletes the category named “Sharepoint”. Confirmation of the operation is requested. All crawled properties mapped to the “SharePoint” category are also removed.

---------------EXAMPLE 2-----------------

$category = Get-FASTSearchMetadataCategory -name Office
Remove-FASTSearchMetadataCategory -category $category -force

This example deletes a crawled property category (stored as $category). Since Force is specified, confirmation of the operation is not required.