en-US/about_SPSearchServiceApp.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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
.NAME
    SPSearchServiceApp

# Description
    
    This resource is responsible for provisioning the search service application.
    The current version lets you specify the database name and server, as well as
    the application pool. If the application pool is changed the DSC resource will
    set it back as per what is set in the resource. The database name parameter is
    used as the prefix for all search databases (so you will end up with one for
    the admin database which matches the name, and then
    "_analyticsreportingstore", "_crawlstore" and "_linkstore" databases as well).
    
    The default value for the Ensure parameter is Present. When not specifying this
    parameter, the service application is provisioned.
    
.PARAMETER Name
    Key - string
    The name of the search service application

.PARAMETER ProxyName
    Write - string
    The proxy name, if not specified will be /Name of service app/ Proxy

.PARAMETER ApplicationPool
    Required - string
    The application pool that it should run in

.PARAMETER SearchCenterUrl
    Write - string
    The URL of the enterprise search center site collection

.PARAMETER DatabaseName
    Write - string
    The name of the database (noting that some search databases will use this as a prefix)

.PARAMETER DatabaseServer
    Write - string
    The server that host the databases for this service application

.PARAMETER DefaultContentAccessAccount
    Write - String
    The default content access account for this search service app

.PARAMETER CloudIndex
    Write - boolean
    Should this search service application be a cloud based service app

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

.PARAMETER WindowsServiceAccount
    Write - string
    Sets the windows services for search to run as this account

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


.EXAMPLE
    This example creates a new search service app in the local farm


    Configuration Example 
    {
        param(
            [Parameter(Mandatory = $true)]
            [PSCredential]
            $SetupAccount
        )
        Import-DscResource -ModuleName SharePointDsc

        node localhost {
            SPSearchServiceApp SearchServiceApp
            {  
                Name                  = "Search Service Application"
                DatabaseName          = "SP_Search"
                ApplicationPool       = "SharePoint Service Applications"
                PsDscRunAsCredential  = $SetupAccount
            }
        }
    }


.EXAMPLE
    This example removes a search service app in the local farm. The ApplicationPool
    parameter is still required but is not actually used, so its value does not matter.


    Configuration Example 
    {
        param(
            [Parameter(Mandatory = $true)]
            [PSCredential]
            $SetupAccount
        )
        Import-DscResource -ModuleName SharePointDsc

        node localhost {
            SPSearchServiceApp SearchServiceApp
            {  
                Name                  = "Search Service Application"
                Ensure                = "Absent"
                ApplicationPool       = "n/a"
                PsDscRunAsCredential  = $SetupAccount
            }
        }
    }