New-SPEnterpriseSearchMetadataCategory
Adds a crawled property category to a search service application.
Syntax
New-SPEnterpriseSearchMetadataCategory
[-AssignmentCollection <SPAssignmentCollection>]
[-AutoCreateNewManagedProperties <Boolean>]
[-Confirm]
[-DiscoverNewProperties <Boolean>]
[-MapToContents <Boolean>]
-Name <String>
[-PropSet <Guid>]
-SearchApplication <SearchServiceApplicationPipeBind>
[-WhatIf]
[<CommonParameters>] Description
This cmdlet creates the new crawled property category. SPEnterpriseSearchMetadataCategory represents a category 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 SharePoint Server Cmdlets.
Examples
------------------EXAMPLE------------------
$ssa = Get-SPEnterpriseSearchServiceApplication
$guid = [System.Guid]::NewGuid()
New-SPEnterpriseSearchMetadataCategory -SearchApplication $ssa -Name MyCategory -DiscoverNewProperties $true -PropSet $guidThis example adds a new metadata category named MyCategory to the default search service application. The DiscoverNewProperties parameter is set to true. Therefore, new crawled properties will be added to the MyCategory metadata category and the unique category identifier is set with the PropSet parameter.
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 |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-AutoCreateNewManagedProperties
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.
| Type: | Boolean |
| Aliases: | auto |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-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 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-DiscoverNewProperties
Specifies that if there are unknown properties in this category, these new properties are discovered during a crawl.
| Type: | Boolean |
| Aliases: | d |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-MapToContents
Specifies that all crawled properties of type string are mapped to corresponding managed properties of this category.
| Type: | Boolean |
| Aliases: | m |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-Name
Specifies the identity of the new metadata category.
The type must be a valid name of a metadata category, for example, MetadataCategory1.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-PropSet
Creates a new metadata category with the specified property set.
Note that the specified property set is the identifier of the category. Therefore, two categories cannot share a property set.
The type must be a valid GUID that specifies the property set, in the form 12345678-90ab-cdef-1234-567890bcdefgh.
| Type: | Guid |
| Aliases: | p |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-SearchApplication
Specifies the search service 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.
| Type: | SearchServiceApplicationPipeBind |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-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 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |