Get-SPEnterpriseSearchResultSource
Retrieves a result source.
Syntax
Default (Default)
Get-SPEnterpriseSearchResultSource
[[-Identity] <ResultSourcePipeBind>]
-Owner <SearchObjectOwner>
-SearchApplication <SearchServiceApplicationPipeBind>
[-AssignmentCollection <SPAssignmentCollection>]
[<CommonParameters>]
Description
This cmdlet retrieves a result source object.
If the Identity parameter is not specified, this cmdlet returns the result source collection for the specified search object owner. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [https://go.microsoft.com/fwlink/p/?LinkId=251831] (https://go.microsoft.com/fwlink/p/?LinkId=251831).
Examples
-------------- Example 1: Get result source by name --------------
$ssa = Get-SPEnterpriseSearchServiceApplication -Identity 'Search Service Application'
$owner = Get-SPEnterpriseSearchOwner -Level SSA
Get-SPEnterpriseSearchResultSource -Identity "Local SharePoint Results" -SearchApplication $ssa -Owner $owner
This example retrieves the search service application level result source with the name "Local SharePoint Results".
-------------- Example 2: Get result source by id --------------
$ssa = Get-SPEnterpriseSearchServiceApplication -Identity 'Search Service Application'
$owner = Get-SPEnterpriseSearchOwner -Level SSA
Get-SPEnterpriseSearchResultSource -Identity 8413cd39-2156-4e00-b54d-11efd9abdB89 -SearchApplication $ssa -Owner $owner
This example retrieves the search service application level result source with the id 8413cd39-2156-4e00-b54d-11efd9abdB89.
-------------- Example 3: Get all result sources under SSA --------------
$ssa = Get-SPEnterpriseSearchServiceApplication -Identity 'Search Service Application'
$owner = Get-SPEnterpriseSearchOwner -Level SSA
Get-SPEnterpriseSearchResultSource -SearchApplication $ssa -Owner $owner
This example retrieves all the search service application level result sources.
Parameters
-AssignmentCollection
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
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.
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.
Parameter properties
| Type: | SPAssignmentCollection |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Identity
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies the result source to retrieve.
The type must be a valid GUID string, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a result source (for example, "Local SharePoint Results"); or an instance of a valid Source object.
If not specified, the result source collection for the specified search object owner is returned.
Parameter properties
| Type: | ResultSourcePipeBind |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 1 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Owner
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies the search object owner that defines the scope at which the corresponding result source is available.
Parameter properties
| Type: | SearchObjectOwner |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | o |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-SearchApplication
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies the search application.
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.
Parameter properties
| Type: | SearchServiceApplicationPipeBind |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.