New-SPEnterpriseSearchMetadataCrawledProperty
Applies to: SharePoint Server 2010
Topic Last Modified: 2011-08-05
Adds a crawled property to a search application crawled property category.
Syntax
New-SPEnterpriseSearchMetadataCrawledProperty -Category <CategoryPipeBind> -IsNameEnum <$true | $false> -Name <String> -PropSet <Guid> -SearchApplication <SearchServiceApplicationPipeBind> -VariantType <Int32> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-IsMappedToContents <Nullable>] [-WhatIf [<SwitchParameter>]]
Detailed Description
The New-SPEnterpriseSearchMetadataCrawledProperty cmdlet is used when the search functionality is initially configured, and after any new crawled property is added to create the rules for the crawled property. SPEnterpriseSearchMetadataCrawledProperty represents a crawled property in the enterprise search metadata property schema.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Identity |
Required |
Microsoft.Office.Server.Search.Cmdlet.CrawledPropertyPipeBind |
Specifies the identity of the new crawled property. 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. |
Category |
Required |
Microsoft.Office.Server.Search.Cmdlet.CategoryPipeBind |
Specifies the crawled property category to add. 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. |
IsNameEnum |
Required |
System.Boolean |
Specifies whether the crawled property name is a string that was converted from an integer; for example, if the crawled property name is the string 5 that was converted from the value 5. |
PropSet |
Optional |
System.Guid |
Creates the new metadata property with the specified property set. The type must be a valid GUID that specifies the property set, in the form 12345678-90ab-cdef-1234-567890bcdefgh. |
SearchApplication |
Required |
Microsoft.Office.Server.Search.Cmdlet.SearchServiceApplicationPipeBind |
Specifies the search application that contains the crawled property. 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. |
VariantType |
Required |
System.Int32 |
Add the new crawled property as the specified variant type. For more information about valid values for this property, see VARIANT Type Constants (https://go.microsoft.com/fwlink/p/?LinkId=143322&clcid=0x409). The type must be an integer that specifies the variant data type of the property set. |
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. |
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 |
IsMappedToContents |
Optional |
System.Nullable |
Specifies that the crawled property is mapped to managed properties. |
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 SharePoint -SearchApplication $searchapp
New-SPEnterpriseSearchMetadataCrawledProperty -SearchApplication $searchapp -Category $cat -VariantType 20 -Propset 00000000-0000-1111-1111-111111111111 -Name testcrawledproperty -IsNameEnum $false
This example creates a new crawled property in the SharePoint category (VariantType 20).