Set-SPEnterpriseSearchMetadataManagedProperty

Sets the properties of a metadata managed property.

Syntax

Set-SPEnterpriseSearchMetadataManagedProperty
   [-AssignmentCollection <SPAssignmentCollection>]
   [-Confirm]
   [-DefaultForQueryIndependentRank <UInt32>]
   [-Description <String>]
   [-EnabledForQueryIndependentRank <Boolean>]
   [-EnabledForScoping <Boolean>]
   [-FullTextQueriable <Boolean>]
   -Identity <ManagedPropertyPipeBind>
   [-IncludeInAlertSignature <Boolean>]
   [-IncludeInMd5 <Boolean>]
   [-Name <String>]
   [-NameNormalized <Boolean>]
   [-NoWordBreaker <Boolean>]
   [-RemoveDuplicates <Boolean>]
   [-RespectPriority <Boolean>]
   [-Retrievable <Boolean>]
   [-SafeForAnonymous <Boolean>]
   [-SearchApplication <SearchServiceApplicationPipeBind>]
   [-SiteCollection <Guid>]
   [-Tenant <Guid>]
   [-UserFlags <Int16>]
   [-WhatIf]
   [<CommonParameters>]

Description

This cmdlet updates the properties of a managed property. It is typically used to change the name or description of a managed property. SPEnterpriseSearchMetadataManagedProperty represents a managed property in the enterprise search metadata property schema.

For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at http://go.microsoft.com/fwlink/p/?LinkId=251831 (http://go.microsoft.com/fwlink/p/?LinkId=251831).

Examples

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

C:\PS>$searchapp = Get-SPEnterpriseSearchServiceApplication
Set-SPEnterpriseSearchMetadataManagedProperty -SearchApplication $searchapp -Identity UserName -EnabledForScoping $true

This example sets the EnabledForScoping property to true for the managed property named UserName in the default search service application.

Required Parameters

-Identity

Specifies the managed property to update.

The type must be a valid name of a managed property, for example, ManagedProperty1, or an instance of a valid ManagedProperty object

Type:ManagedPropertyPipeBind
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016

Optional 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
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016
-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
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016
-DefaultForQueryIndependentRank

Specifies that the managed property is mandatory when it is used in query-independent rank (relevance).

Note: Null indicates that the value is unchanged.

Type:UInt32
Aliases:def
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016
-Description

Adds a description to the metadata managed property.

The type must be a valid string.

Note: Null indicates that the value is unchanged.

Type:String
Aliases:d
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016
-EnabledForQueryIndependentRank

Specifies that the managed property is mandatory when it is used in the custom ranking model for the query-independent work of ranking.

The type must be one of the following query-independent ranking features in the custom model XML:

  • queryIndependentFeature
  • categoryFeature
  • languageFeature

Note: Null indicates that the value is unchanged.

Type:Boolean
Aliases:qir
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016
-EnabledForScoping

Specifies that the managed property can be used in a scope definition.

Note: Null indicates that the value is unchanged.

Type:Boolean
Aliases:e
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016
-FullTextQueriable

Specifies that the managed property can be used in enterprise search SQL queries.

Note: Null indicates that the value is unchanged.

Type:Boolean
Aliases:f
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016
-IncludeInAlertSignature

{{Fill IncludeInAlertSignature Description}}

Type:Boolean
Aliases:ia
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016
-IncludeInMd5

Specifies that the managed property is included in the hash used by the crawler to determine whether a document has changed.

Note: Null indicates that the value is unchanged.

Type:Boolean
Aliases:im5
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016
-Name

Specifies a name for the managed property.

The type must be a valid managed property name, for example ManagedProperty1.

Note: Null indicates that the value is unchanged.

Type:String
Aliases:n
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016
-NameNormalized

Specifies if the values of the managed property should be normalized, that is, enable to return results independent of letter casing and diacritics used in the query. If value is set to true, the values are normalized.

Note: Null indicates that the value is unchanged.

Type:Boolean
Aliases:nn
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016
-NoWordBreaker

Specifies that the values for this managed property are processed by a word breaker.

Note: Null indicates that the value is unchanged.

Type:Boolean
Aliases:nw
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016
-RemoveDuplicates

Specifies that duplicate values for the managed property are removed.

Type:Boolean
Aliases:rd
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016
-RespectPriority

Specifies that when a mapped crawled property contains multiple values and RespectPriority is set to true, only the first mapped crawled property is copied. Otherwise, all mapped crawled properties that have a value are copied.

Note: Null indicates that the value is unchanged.

Type:Boolean
Aliases:rp
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016
-Retrievable

Specifies whether the values for this managed property are retrievable or not.

Note: Null indicates that the value is unchanged.

Type:Boolean
Aliases:r
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016
-SafeForAnonymous

{{Fill SafeForAnonymous Description}}

Type:Boolean
Aliases:sfa
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016
-SearchApplication

Specifies the search application that contains the managed property collection.

The type must be a valid search application name, for example, SearchApp1, or an instance of a valid SearchServiceApplication object.

Type:SearchServiceApplicationPipeBind
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016
-SiteCollection

Specifies that the managed properties returned are to be within the scope of a site collection (SPSite).

The type must be a valid GUID that specifies the property set in the form 12345678-90ab-cdef-1234-567890bcdefgh.

Type:Guid
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016
-Tenant

Specifies that the managed properties returned are to be within the scope of a tenant.

The type must be a valid GUID that specifies the property set in the form 12345678-90ab-cdef-1234-567890bcdefgh.

Type:Guid
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016
-UserFlags

Reserved for future use.

Note: Null indicates that the value is unchanged.

Type:Int16
Aliases:u
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016
-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
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016