Export (0) Print
Expand All
Expand Minimize

Set-SPEnterpriseSearchQueryScopeRule

Published: July 16, 2012

Applies to:  SharePoint Server 2013 Enterprise | SharePoint Server 2013 Standard 

Sets the properties of a shared scope rule for a query scope.

Set-SPEnterpriseSearchQueryScopeRule [-Identity] <ScopeRulePipeBind> -Url <Uri> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-FilterBehavior <String>] [-ManagedPropertyName <String>] [-MatchingString <String>] [-PropertyValue <String>] [-Scope <ScopePipeBind>] [-SearchApplication <SearchServiceApplicationPipeBind>] [-UrlScopeRuleType <String>] [-WhatIf [<SwitchParameter>]]

Parameters

Parameter Required Type Description

Identity

Required

Microsoft.Office.Server.Search.Cmdlet.ScopeRulePipeBind

Specifies the scope rule to update.

The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a scope rule (for example, ScopeRule1); or an instance a valid ScopeRule object.

Url

Required

System.Uri

Specifies the results URL that is associated with the query scope rule.

The type must be a valid URL, in the form http://server_name.

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.

noteNote:

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

FilterBehavior

Optional

System.String

Specifies the type of scope rule to create for the query scope.

The type must be one of the following values: Exclude, Include, or Require.

ManagedPropertyName

Optional

System.String

Specifies the name of the managed property to use for the PropertyQuery scope rule.

The type must be a valid name of a managed property; for example, ManagedProp1.

MatchingString

Optional

System.String

Specifies the string to use when matching the URL rule type.

PropertyValue

Optional

System.String

Specifies the property value to use when matching the PropertyQuery rule type.

Scope

Optional

Microsoft.Office.Server.Search.Cmdlet.ScopePipeBind

Applies the query scope rule to the specified scope.

The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a scope (for example, Scope1); or an instance of a valid Scope object.

SearchApplication

Optional

Microsoft.Office.Server.Search.Cmdlet.SearchServiceApplicationPipeBind

Specifies the search application that contains the query scope rule collection.

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.

UrlScopeRuleType

Optional

System.String

Specifies the value to use when matching the URL rule type.

The type must be one of the following values: Folder, HostName, or Domain.

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

noteNote:

After you upgrade a Search service application from SharePoint Server 2010 to SharePoint Server 2013, you can view shared scopes, but you cannot create, update, or delete them. Therefore, you cannot use this cmdlet for shared scopes after upgrade. However, you can convert shared scopes to result sources, which serve a similar purpose. Similarly, after you upgrade a SharePoint Server 2010 site collection to SharePoint Server 2013 mode, you can view local scopes, but you cannot create, update, or delete them. Therefore, you cannot use this cmdlet for local scopes after you upgrade a site collection. However, you can convert local scopes to result sources, which serve a similar purpose.

The Set-SPEnterpriseSearchQueryScopeRule cmdlet updates the properties of a query scope. SPEnterpriseSearchQueryScopeRule represents a query results scope rule that can be applied to a scope.

Input Types

Return Types

------------------EXAMPLE------------------

$ssa = Get-SPEnterpriseSearchServiceApplication -Identity "MySSA"$scope = Get-SPEnterpriseSearchQueryScope -Identity MustCrawl -SearchApplication $ssaGet-SPEnterpriseSearchQueryScopeRule -Scope $scope -Url http://criticalSite | Set-SPEnterpriseSearchQueryScopeRule -Url http://criticalSite -UrlScopeRuleType Url

This example gets a reference to a scope rule for the URL http://criticalSite and sets its rule type to Url.

Change History

Date Description

July 16, 2012

Initial publication

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft