New-SPEnterpriseSearchQueryScope
Applies to: SharePoint Server 2010
Topic Last Modified: 2010-02-11
Adds a query results scope to a shared search application.
Syntax
New-SPEnterpriseSearchQueryScope [-Name] <String> -Description <String> -DisplayInAdminUI <Nullable> -SearchApplication <SearchServiceApplicationPipeBind> [-AlternateResultsPage <String>] [-AssignmentCollection <SPAssignmentCollection>] [-CompilationType <Nullable>] [-Confirm [<SwitchParameter>]] [-ExtendedSearchFilter <String>] [-OwningSiteUrl <Uri>] [-WhatIf [<SwitchParameter>]]
Detailed Description
Use the New-SPEnterpriseSearchQueryScope cmdlet to create a new shared scope. SPEnterpriseSearchQueryScope represents a query results scope used by all shared search applications on the farm.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Name |
Required |
System.String |
Specifies the identity of the scope to create. The type must be a valid name of a scope (for example, Scope1). |
Description |
Required |
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 |
Required |
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. |
SearchApplication |
Required |
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. |
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. 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. |
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 |
OwningSiteUrl |
Optional |
System.Uri |
Specifies the SharePoint site that is associated with the new scope. The type must be a valid SharePoint site 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 |
Input Types
Return Types
Example
------------------EXAMPLE------------------
$ssa = Get-SPEnterpriseSearchServiceApplication -Identity MySSA
$ssa | New-SPEnterpriseSearchQueryScope -Name MustCrawl -Description "Sites we must crawl" -DisplayInAdminUI $true
This example adds a scope named MustCrawl that will be displayed in the administration UI to the search service application named MySSA.