Set-SPEnterpriseSearchResultItemType

设置结果项类型的属性。

语法

Default (默认值)

Set-SPEnterpriseSearchResultItemType
    [-Identity] <ResultItemTypePipeBind>
    -Owner <SearchObjectOwner>
    [-AssignmentCollection <SPAssignmentCollection>]
    [-Confirm]
    [-DisplayProperties <String>]
    [-DisplayTemplateUrl <String>]
    [-Name <String>]
    [-OptimizeForFrequentUse <Boolean>]
    [-RulePriority <Int32>]
    [-Rules <PropertyRuleCollection>]
    [-SearchApplication <SearchServiceApplicationPipeBind>]
    [-SearchApplicationProxy <SearchServiceApplicationProxyPipeBind>]
    [-SourceID <Guid>]
    [-WhatIf]
    [<CommonParameters>]

说明

cmdlet Set-SPEnterpriseSearchResultItemType 设置用户创建的结果项类型的属性。 不能使用此 cmdlet 设置或更改 SharePoint 产品中包含的内置结果项类型的属性。

使用结果项类型可以根据结果类型更改搜索结果的外观。 首先定义规则集合,这些规则将根据结果的属性进行评估。 然后定义用于呈现该类型结果的显示模板。 创建结果项类型后,与结果项类型规则匹配的结果将使用指定的显示模板呈现。

用例示例:

  • 更改特定文件扩展名的结果外观,例如Word文档。
  • 更改搜索结果中特定内容类型的外观。
  • 更改特定作者的结果的外观。
  • 将一个结果操作从作为自定义搜索应用程序一部分的特定结果源添加到结果中。

有关适用于 SharePoint 产品的 Windows PowerShell 的权限和最新信息,请参阅 SharePoint Server cmdlet

示例

$web = Get-SPWeb https://webUrl
$tenantOwner = Get-SPEnterpriseSearchOwner -Level SPSite -SPWeb $web
$ssa = Get-SPEnterpriseSearchServiceApplication
$resultType = Get-SPEnterpriseSearchResultItemType -Owner $tenantOwner -SearchApplication $ssa
$resultType.BuiltIn
$rule = Get-SPEnterpriseSearchPropertyRule -PropertyName "ContentTypeId" -Operator "StartsWith"
$rule.AddValue('0x010063C2F478ACC511DFB869B5BFDFD720851252')
$ruleCollection = Get-SPEnterpriseSearchPropertyRuleCollection
$ruleCollection.Add($rule)
$displayProperties = "WorkId,Rank,Title,Size,Path,Description,SiteName,HitHighlightedSummary,HitHighlightedProperties,ViewsLifeTime"
$displaytemplateUrl = "~sitecollection/_catalogs/masterpage/Display Templates/Search/Item_MyCustomDisplayTemplate.js"
Set-SPEnterpriseSearchResultItemType
-Identity $resultType `
-SearchApplication $ssa `
-Name "CustomResultType" `
-Rules $ruleCollection `
-RulePriority 1
-DisplayProperties $displayProperties `
-DisplayTemplateUrl $displaytemplateUrl `
-Owner $tenantOwner

此示例首先定义网站的 URL、搜索所有者和搜索应用程序的变量。 它检索结果项类型并检查该类型是否为内置结果项类型。 如果 $resultType.BuiltIn 返回 false,则结果项类型不是内置类型,可以使用 设置其属性 Set-SPEnterpriseSearchResultItemType

接下来,该示例创建结果项类型应匹配的规则,并将其添加到属性规则集合。

紧接着,此示例定义应显示的结果项类型属性以及要使用的显示模板。

最后,该示例使用 Set-SPEnterpriseSearchResultItemType cmdlet 修改结果项类型。

参数

-AssignmentCollection

适用:SharePoint Server 2013、SharePoint Server 2016 SharePoint Server 2019

管理对象以便正确进行处理。 使用 SPWeb 或 SPSite 等对象可能会耗用大量内存,而且在 Windows PowerShell 脚本中使用这些对象需要正确管理内存。 通过使用 SPAssignment 对象,可以将对象分配给变量,然后在不需要这些对象时对它们进行处理,以释放内存。 在使用 SPWeb、SPSite 或 SPSiteAdministration 对象时,如果不使用分配集合或 Global 参数,则会自动处理这些对象。

使用全局参数时,所有对象均包含在全局存储中。 如果未立即使用对象,或未通过使用 Stop-SPAssignment 命令来处理对象,则可能会发生内存不足的情况。

参数属性

类型:SPAssignmentCollection
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:True
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Confirm

适用:SharePoint Server 2013、SharePoint Server 2016 SharePoint Server 2019

执行命令前,看到确认提示。 有关详细信息,请键入以下命令:get-help about_commonparameters

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False
别名:cf

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-DisplayProperties

适用:SharePoint Server 2013、SharePoint Server 2016 SharePoint Server 2019

指定要显示的结果属性。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False
别名:dp

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-DisplayTemplateUrl

适用:SharePoint Server 2013、SharePoint Server 2016 SharePoint Server 2019

指定应用于呈现结果的显示模板的 URL。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False
别名:url

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Identity

适用:SharePoint Server 2013、SharePoint Server 2016 SharePoint Server 2019

指定要更新的结果项类型。 键入的值必须是 12345678-90ab-cdef-1234-567890bcdefgh 形式的有效 GUID。

参数属性

类型:ResultItemTypePipeBind
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:1
必需:True
来自管道的值:True
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Name

适用:SharePoint Server 2013、SharePoint Server 2016 SharePoint Server 2019

指定结果项类型的名称。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False
别名:n

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-OptimizeForFrequentUse

适用:SharePoint Server 2013、SharePoint Server 2016 SharePoint Server 2019

{{ Fill OptimizeForFrequentUse Description }}

参数属性

类型:Boolean
默认值:None
支持通配符:False
不显示:False
别名:选择

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Owner

适用:SharePoint Server 2013、SharePoint Server 2016 SharePoint Server 2019

指定定义从中创建结果项类型的范围的搜索对象所有者。

参数属性

类型:SearchObjectOwner
默认值:None
支持通配符:False
不显示:False
别名:o

参数集

(All)
Position:Named
必需:True
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-RulePriority

适用:SharePoint Server 2013、SharePoint Server 2016 SharePoint Server 2019

指定规则集合与其他规则相比所具有的优先级。

参数属性

类型:Int32
默认值:None
支持通配符:False
不显示:False
别名:priority

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Rules

适用:SharePoint Server 2013、SharePoint Server 2016 SharePoint Server 2019

指定要针对结果属性进行评估的规则集合。

参数属性

类型:PropertyRuleCollection
默认值:None
支持通配符:False
不显示:False
别名:统治

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-SearchApplication

适用:SharePoint Server 2013、SharePoint Server 2016 SharePoint Server 2019

指定搜索应用程序的名称。 键入的值必须是 12345678-90ab-cdef-1234-567890bcdefgh 形式的有效 GUID;有效的搜索应用程序名称(如 SearchApp1);或有效 SearchServiceApplication 对象的实例。

参数属性

类型:SearchServiceApplicationPipeBind
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-SearchApplicationProxy

适用:SharePoint Server 2013、SharePoint Server 2016 SharePoint Server 2019

指定包含结果项类型的搜索应用程序的代理。 键入的值必须是 12345678-90ab-cdef-1234-567890bcdefgh 形式的有效 GUID;有效的搜索应用程序代理名称(如 SearchAppProxy1);或有效 SearchServiceApplicationProxy 对象的实例。

参数属性

类型:SearchServiceApplicationProxyPipeBind
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:True
来自管道的值(按属性名称):False
来自剩余参数的值:False

-SourceID

适用:SharePoint Server 2013、SharePoint Server 2016 SharePoint Server 2019

标识结果项类型应用于的搜索结果源。

参数属性

类型:Guid
默认值:None
支持通配符:False
不显示:False
别名:sid

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-WhatIf

适用:SharePoint Server 2013、SharePoint Server 2016 SharePoint Server 2019

显示一条描述命令作用的消息,而不执行命令。 有关详细信息,请键入以下命令:get-help about_commonparameters

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False
别名:无线

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

CommonParameters

此 cmdlet 支持通用参数:-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息,请参阅 about_CommonParameters