en-US/about_SPServiceIdentity.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
.NAME
    SPServiceIdentity

# Description
    
    **Type:** Distributed
    **Requires CredSSP:** No
    
    This resource is used to specify a managed account to be used to run a service instance.
    You can also specify LocalService, LocalSystem or NetworkService as ManagedAccount.
    The name is the typename of the service as shown in the Central Admin website.
    This resource only needs to be run on one server in the farm, as the process identity
    update method will apply the settings to all instances of the service.
    
.PARAMETER Name
    Key - string
    The name of the service instance to manage

.PARAMETER ManagedAccount
    Required - string
    The user name of a managed account, LocalService, LocalSystem or NetworkService that will be used to run the service

.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 set the SandBox Code Service to run under a specifed service account. 
    The account must already be registered as a managed account.


Configuration Example 
    {
        param(
            [Parameter(Mandatory = $true)]
            [PSCredential]
            $SetupAccount
        )

 Import-DscResource -ModuleName SharePointDsc

        node localhost {
 
            SPServiceIdentity SandBoxUserAccount
            {
                Name           = "Microsoft SharePoint Foundation Sandboxed Code Service"
                ManagedAccount = "CONTOSO\SPUserCode"
                PsDscRunAsCredential = $SetupAccount
            }
        }
    }