en-US/about_SPSecureStoreServiceApp.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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
.NAME
    SPSecureStoreServiceApp

# Description
    
    This resource is responsible for provisioning and configuring the secure store
    service application. The parameters passed in (except those related to database
    specifics) are validated and set when the resource is run, the database values
    are only used in provisioning of the service application.
    
    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 secure store service app

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

.PARAMETER ApplicationPool
    Required - string
    The name of the application pool it will run in

.PARAMETER AuditingEnabled
    Required - boolean
    Is auditing enabled for this service app

.PARAMETER AuditlogMaxSize
    Write - uint32
    What is the maximum size of the audit log in MB

.PARAMETER DatabaseCredentials
    Write - String
    What SQL credentials should be used to access the database

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

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

.PARAMETER DatabaseAuthenticationType
    Write - string
    Allowed values: Windows, SQL
    What type of authentication should be used to access the database

.PARAMETER FailoverDatabaseServer
    Write - string
    The name of the database server hosting a failover instance of the database

.PARAMETER PartitionMode
    Write - boolean
    Is partition mode enabled for this service app

.PARAMETER Sharing
    Write - boolean
    Is sharing enabled for this service app

.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 new secure store service app.


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

        node localhost {
            SPSecureStoreServiceApp SecureStoreServiceApp
            {
                Name            = "Secure Store Service Application"
                ApplicationPool = "SharePoint Service Applications"
                AuditingEnabled = $true
                AuditlogMaxSize = 30
                DatabaseName    = "SP_SecureStore"
                InstallAccount  = $SetupAccount
            }
        }
    }


.EXAMPLE
    This example removes a secure store service app. The ApplicationPool and
    AuditingEnabled parameters are required, but are not used so their values
    are able to be set to anything.


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

        node localhost {
            SPSecureStoreServiceApp SecureStoreServiceApp
            {
                Name            = "Secure Store Service Application"
                ApplicationPool = "n/a"
                AuditingEnabled = $false
                InstallAccount  = $SetupAccount
                Ensure          = "Absent"
            }
        }
    }