en-US/about_SPSearchResultSource.help.txt

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
.NAME
    SPSearchResultSource

# Description
    
    **Type:** Distributed
    
    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.
    
.PARAMETER Name
    Key - String
    The name of the result source

.PARAMETER SearchServiceAppName
    Required - String
    The name of the search service application to associate this result source with

.PARAMETER Query
    Required - String
    The query to pass to the provider source

.PARAMETER ProviderType
    Required - String
    Allowed values: Exchange Search Provider, Local People Provider, Local SharePoint Provider, OpenSearch Provider, Remote People Provider, Remote SharePoint Provider
    The provider type to use for the result source

.PARAMETER ConnectionUrl
    Write - String
    The URI to connect to the remote location

.PARAMETER Ensure
    Write - string
    Allowed values: Present, Absent
    Present if the result source should exist, absent if it should not

.PARAMETER InstallAccount
    Write - String
    POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5


.EXAMPLE
    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
            }
        }
    }