Set-SPEnterpriseSearchMetadataCategory

 

Applies to: SharePoint Server 2010

Topic Last Modified: 2010-02-11

Sets properties of a crawled property category for a shared search application.

Syntax

Set-SPEnterpriseSearchMetadataCategory [-Identity] <CategoryPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-AutoCreateNewManagedProperties <Nullable>] [-Confirm [<SwitchParameter>]] [-DiscoverNewProperties <Nullable>] [-MapToContents <Nullable>] [-Name <String>] [-SearchApplication <SearchServiceApplicationPipeBind>] [-WhatIf [<SwitchParameter>]]

Detailed Description

The Set-SPEnterpriseSearchMetadataCategory cmdlet updates properties of a crawled property category when the search functionality is initially configured and after a new crawled property category is discovered during a crawl. SPEnterpriseSearchMetadataCategory represents a category in the enterprise search metadata property schema.

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 GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; 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.

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.

AutoCreateNewManagedProperties

Optional

System.Nullable

Specifies that new managed properties are mapped when new crawled properties in this category are found.

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 new properties in this category are discovered during a crawl.

MapToContents

Optional

System.Nullable

Specifies that all string crawled properties are mapped to content.

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.

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 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.

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

$searchapp = Get-SPEnterpriseSearchServiceApplication "SearchApp1"
$cat = Get-SPEnterpriseSearchMetadataCategory -Identity test -SearchApplication $searchapp
$cat | Set-SPEnterpriseSearchMetadataCategory -Name test2

This example changes the name of the metadata category from test to test2.