.png)
Set-SPEnterpriseSearchQueryScope
Published: May 12, 2010
Sets the properties of a query results scope for a shared search application.
Set-SPEnterpriseSearchQueryScope [-Identity] <ScopePipeBind> -AlternateResultsPage <String> [-AssignmentCollection <SPAssignmentCollection>] [-CompilationType <Nullable>] [-Confirm [<SwitchParameter>]] [-Description <String>] [-DisplayInAdminUI <Nullable>] [-Name <String>] [-SearchApplication <SearchServiceApplicationPipeBind>] [-Url <Uri>] [-WhatIf [<SwitchParameter>]]
Parameters
| Parameter | Required | Type | Description | ||
|---|---|---|---|---|---|
|
Identity |
Required |
Microsoft.Office.Server.Search.Cmdlet.ScopePipeBind |
Specifies the identity of the scope to create. 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. |
||
|
AlternateResultsPage |
Required |
System.String |
Specifies the location to display results for the new query scope. 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.
|
||
|
CompilationType |
Optional |
System.Nullable |
Specifies the compilation type of the new scope. The value 0 specifies the conditionally compiled scope type, and the value 1 specifies the always compiled scope type. The type must be either of the following: 0 or 1. |
||
|
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 |
||
|
Description |
Optional |
System.String |
Adds a description of the new query scope. The type must be a valid string; for example, a description of a query scope. |
||
|
DisplayInAdminUI |
Optional |
System.Nullable |
Specifies that the new scope is displayed in the administration application user interface (UI). The default setting is to hide the new scope in the administration application UI. |
||
|
Name |
Optional |
System.String |
Specifies a name for the query scope. The type must be a valid name of a query scope; for example, QueryScope1. |
||
|
SearchApplication |
Optional |
Microsoft.Office.Server.Search.Cmdlet.SearchServiceApplicationPipeBind |
Specifies the search application that contains the query scope 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. |
||
|
Url |
Optional |
System.Uri |
Filters to delete scopes for the specified results URL. The type must be a valid URL, in the form http://server_name. |
||
|
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 |
Note:
Detailed Description
The Set-SPEnterpriseSearchQueryScope cmdlet updates properties of a shared scope. SPEnterpriseSearchQueryScope represents a query results scope used by all shared search applications on the farm.
Input Types
Return Types
------------------EXAMPLE------------------
$ssa = Get-SPenterpriseSearchServiceApplication –Identity MySSA Get-SPEnterpriseSearchQueryScope -Identity MustCrawl -SearchApplication $ssa | Set-SPEnterpriseSearchQueryScope -Description "Business critical sites to index" -CompilationType 1 -AlternateResultsPage http://altServer
This example obtains a reference to the scope named MustCrawl on the search service application named MySSA, and changes the description, compilation type, and alternate access URL.
Change History
| Date | Description | Reason |
|---|---|---|
|
May 12, 2010 |
Initial publication |
|
