en-US/about_SPStateServiceApp.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
.NAME
    SPStateServiceApp

# Description
    
    This resource provisions an instance of the state service in to the local farm.
    The database specific parameters are only used during initial provisioning of
    the app, and will not change database settings beyond the initial deployment.
    
    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 state service app

.PARAMETER DatabaseCredentials
    Write - String
    The database credentials for accessing the database

.PARAMETER DatabaseName
    Required - string
    The name of the database for the service app

.PARAMETER DatabaseServer
    Write - string
    The name of the database server

.PARAMETER Ensure
    Write - string
    Allowed values: Present, Absent
    Present if the service app 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 creates a state service application in the local farm


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

        node localhost {
            SPStateServiceApp StateServiceApp
            {
                Name                 = "State Service Application"
                DatabaseName         = "SP_State"
                Ensure               = "Present"
                PsDscRunAsCredential = $SetupAccount
            }
        }
    }