Share via


Set-SPEnterpriseSearchContentEnrichmentConfiguration

Stores the specified content enrichment configuration to the search service application.

Syntax

Default (Default)

Set-SPEnterpriseSearchContentEnrichmentConfiguration

    -ContentEnrichmentConfiguration <ContentEnrichmentConfigurationPipeBind>
    -SearchApplication <SearchServiceApplicationPipeBind>
    [-AssignmentCollection <SPAssignmentCollection>]
    [-Confirm]
    [-WhatIf]
    [<CommonParameters>]

Description

This cmdlet validates the ContentEntrichmentConfiguration object and stores the provided configuration in the SearchServiceApplication. Both a ContentEnrichmentConfiguration and a SearchServiceApplication object have to be provided.

For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at SharePoint Server Cmdlets.

Examples

EXAMPLE 1

$config = New-SPEnterpriseSearchContentEnrichmentConfiguration
$config.Endpoint = "https://server/service"
$config.InputProperties = "Title", "Url"
$config.OutputProperties = "Title", "Url"
$ssa = Get-SPEnterpriseSearchServiceApplication
Set-SPEnterpriseSearchContentEnrichmentConfiguration -SearchApplication $ssa -ContentEnrichmentConfiguration $config

This example creates a new ContentEnrichmentConfiguration object. The URL of the external web service is stored in the $config.Endpoint property. The new ContentEnrichmentConfiguration is configured to use Title and URL, which are the managed properties that you want to send to the external web service. It is also configured to expect the external web service to output the same managed properties. The SearchServiceApplication object is retrieved and used for storing the newly created ContentEnrichmentConfiguration.

EXAMPLE 2

C:\PS>$config = New-SPEnterpriseSearchContentEnrichmentConfiguration
$config.Endpoint = "https://server/service"
$config.InputProperties = "Title"
$config.OutputProperties = "Title"
$config.Trigger = 'Contains(Title, "Example")'
$ssa = Get-SPEnterpriseSearchServiceApplication
Set-SPEnterpriseSearchContentEnrichmentConfiguration -SearchApplication $ssa -ContentEnrichmentConfiguration $config

This example creates a new ContentEnrichmentConfiguration object. The URL of the external web service is stored in the $config.Endpoint property. The new ContentEnrichmentConfiguration is configured to use Title, which is the managed property that you want to send to the external web service. It is also configured to expect the external web service to output the same managed property. The $config.Trigger is set to only send the managed property when the Boolean trigger expression is true, in this case when the managed property Title contains the string "Example". The SearchServiceApplication object is retrieved, and used for storing the newly created ContentEnrichmentConfiguration.

Parameters

-AssignmentCollection

Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

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.

Parameter properties

Type:SPAssignmentCollection
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

Prompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparameters

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ContentEnrichmentConfiguration

Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

Specifies the ContentEnrichmentConfiguration that should be stored in the SearchServiceApplication.

Parameter properties

Type:ContentEnrichmentConfigurationPipeBind
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-SearchApplication

Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

Specifies the SearchServiceApplication that contains the ContentEnrichmentConfiguration.

Parameter properties

Type:SearchServiceApplicationPipeBind
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.