SPSearchResultSource

SPSearchResultSource

Parameters

Parameter	Attribute	DataType	Description	Allowed Values
Name	Key	String	The name of the result source
SearchServiceAppName	Required	String	The name of the search service application to associate this result source with
Query	Required	String	The query to pass to the provider source
ProviderType	Required	String	The provider type to use for the result source	Exchange Search Provider, Local People Provider, Local SharePoint Provider, OpenSearch Provider, Remote People Provider, Remote SharePoint Provider
ConnectionUrl	Write	String	The URI to connect to the remote location
Ensure	Write	string	Present if the result source should exist, absent if it should not	Present, Absent
InstallAccount	Write	PSCredential	POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5

Description

This resource is used to configure search result sources in the SharePoint search service application. Result sources can be configured to be of the following provider types:

• Exchange Search Provider
• Local People Provider
• Local SharePoint Provider
• OpenSearch Provider
• Remote People Provider
• Remote SharePoint Provider

The default value for the Ensure parameter is Present. When not specifying this parameter, the result source is created.

Examples

Example 1

This example shows how to create a remote sharepoint search result source

    Configuration Example 
    {
        param(
            [Parameter(Mandatory = $true)]
            [PSCredential]
            $SetupAccount
        )
        Import-DscResource -ModuleName SharePointDsc
    
        node localhost {
            SPSearchResultSource RemoteSharePointFarm
            {
                Name = "External SharePoint results"
                SearchServiceAppName = "Search Service Application"
                Query = "{searchTerms}"
                ProviderType = "Remote SharePoint Provider"
                PsDscRunAsCredential = $SetupAccount
            }
        }
    }