Set-SPEnterpriseSearchMetadataCategory
Published: July 16, 2012
Applies to: SharePoint Server 2013 Enterprise | SharePoint Server 2013 Standard | SharePoint Foundation 2013
Sets properties of a crawled property category.
Set-SPEnterpriseSearchMetadataCategory [-Identity] <CategoryPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-AutoCreateNewManagedProperties <Nullable>] [-Confirm [<SwitchParameter>]] [-DiscoverNewProperties <Nullable>] [-MapToContents <Nullable>] [-Name <String>] [-SearchApplication <SearchServiceApplicationPipeBind>] [-WhatIf [<SwitchParameter>]]
Parameters
| Parameter | Required | Type | Description | ||
|---|---|---|---|---|---|
| Identity | Required | Microsoft.Office.Server.Search.Cmdlet.CategoryPipeBind | Specifies the metadata category to update. The type must be a valid name of a metadata category, for example, MetadataCategory1, or an instance of a valid Category 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.
| ||
| AutoCreateNewManagedProperties | Optional | System.Nullable | Specifies that when a new crawled property in this category is found, a corresponding managed property is created and mapped to this new crawled property. Note:Null indicates that the value is unchanged. | ||
| 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 | ||
| DiscoverNewProperties | Optional | System.Nullable | Specifies that if there are unknown properties in this category, these new properties are discovered during a crawl. Note:Null indicates that the value is unchanged. | ||
| MapToContents | Optional | System.Nullable | Specifies that all crawled properties of type string are mapped to corresponding managed properties of this category. Note:Null indicates that the value is unchanged. | ||
| Name | Optional | System.String | Specifies the name of the enterprise search metadata category. The type must be a valid name of a metadata category, for example MetadataCategory1. Note:Null indicates that the value is unchanged. | ||
| SearchApplication | Optional | Microsoft.Office.Server.Search.Cmdlet.SearchServiceApplicationPipeBind | Specifies the search application that contains the enterprise search metadata categories. The type must be a valid search application name, for example, SearchApp1, or an instance of a valid SearchServiceApplication object. | ||
| 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 |
Detailed Description
This cmdlet updates properties of a crawled property category when the search functionality is configured for the first time, and after a new crawled property category is discovered during a crawl. SPEnterpriseSearchMetadataCategory represents a category in the enterprise search metadata property schema.
Note that a category may represent multiple propsets. Changes to the category will overwrite all propsets.
Input Types
Return Types
------------------EXAMPLE------------------
$searchapp = Get-SPEnterpriseSearchServiceApplication
Set-SPEnterpriseSearchMetadataCategory -Identity People -SearchApplication $searchapp -DiscoverNewProperties $false -MapToContents $false
This example sets both DiscoverNewProperties and MapToContents properties to False for the People category for the default search service application.
Change History
| Date | Description |
|---|---|
| July 16, 2012 | Initial publication |

Note: