Get-SPEnterpriseSearchQueryScope
Applies to: SharePoint Server 2010
Topic Last Modified: 2010-02-11
Returns a query results scope.
Syntax
Get-SPEnterpriseSearchQueryScope [[-Identity] <ScopePipeBind>] -SearchApplication <SearchServiceApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Url <Uri>]
Detailed Description
The Get-SPEnterpriseSearchQueryScope cmdlet reads a QueryScope object when the shared scope is created or deleted, or when the definition of the shared scope is updated.
If the Identity parameter is not specified, this cmdlet returns the query scope collection from the specified search application.
Parameters
Parameter | Required | Type | Description |
---|---|---|---|
Identity |
Optional |
Microsoft.Office.Server.Search.Cmdlet.ScopePipeBind |
Specifies the results scope to get. 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 |
Required |
Microsoft.Office.Server.Search.Cmdlet.SearchServiceApplicationPipeBind |
Specifies the search application that contains the query scope. 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. |
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. Note 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. |
Url |
Optional |
System.Uri |
Filters to return scopes for the specified results URL. The type must be a valid URL, in the form http://server_name. |
Input Types
Return Types
Example
------------------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 application named MySSA
, and changes the description, compilation type, and alternate access URL.