New-SPEnterpriseSearchMetadataMapping
Published: July 16, 2012
Applies to: SharePoint Server 2013 Enterprise | SharePoint Server 2013 Standard | SharePoint Foundation 2013
Adds a managed property mapping.
New-SPEnterpriseSearchMetadataMapping -CrawledProperty <CrawledPropertyPipeBind> -ManagedProperty <ManagedPropertyPipeBind> -SearchApplication <SearchServiceApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-SiteCollection <Guid>] [-Tenant <Guid>] [-WhatIf [<SwitchParameter>]]
Parameters
| Parameter | Required | Type | Description | ||
|---|---|---|---|---|---|
|
CrawledProperty |
Required |
Microsoft.Office.Server.Search.Cmdlet.CrawledPropertyPipeBind |
Specifies the crawled property to map. The type must be a valid GUID in the form 12345678-90ab-cdef-1234-567890bcdefgh, a valid URL in the form http://server_name, or an instance of a valid CrawledProperty object. |
||
|
ManagedProperty |
Required |
Microsoft.Office.Server.Search.Cmdlet.ManagedPropertyPipeBind |
Specifies the managed property to which the crawled property should be mapped. The type must be a valid GUID in the form 12345678-90ab-cdef-1234-567890bcdefgh, a valid name of a managed property, for example, ManagedProperty1, or an instance of a valid ManagedProperty object. |
||
|
SearchApplication |
Required |
Microsoft.Office.Server.Search.Cmdlet.SearchServiceApplicationPipeBind |
Specifies the search application that contains the metadata mapping. The type must be a valid search application name, for example, SearchApp1, or an instance of a valid SearchServiceApplication 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.
|
||
|
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 |
||
|
SiteCollection |
Optional |
System.Guid |
Specifies that the metadata mapping 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. |
||
|
Tenant |
Optional |
System.Guid |
Specifies that the metadata mapping 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. |
||
|
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 maps a crawled property to a managed property. SPEnterpriseSearchMetadataMapping represents a snapshot of a mapping between a managed property and one or more crawled properties in the enterprise search metadata property schema.
Input Types
Return Types
------------------EXAMPLE------------------
$searchapp = Get-SPEnterpriseSearchServiceApplication
$mp = Get-SPEnterpriseSearchMetadataManagedProperty -SearchApplication $searchapp -Identity UserName
$cat = Get-SPEnterpriseSearchMetadataCategory –SearchApplication $searchapp –Identity People
$cp = Get-SPEnterpriseSearchMetadataCrawledProperty -SearchApplication $searchapp -Category $cat –Limit 1
$ncp = New-SPEnterpriseSearchMetadataCrawledProperty -SearchApplication $searchapp -Name "MyCrawlProp" -PropSet $cp.PropSet -Category $cp.CategoryName -IsNameEnum $false -VariantType $cp.VariantType -IsMappedToContents $true
New-SPEnterpriseSearchMetadataMapping -SearchApplication $searchapp -ManagedProperty $mp –CrawledProperty $ncp
This example maps the created crawled property MyCrawlProp to the managed property UserName for the default search service application.

Note: