en-US/about_SPProjectServerServiceApp.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
.NAME
    SPProjectServerServiceApp

# Description
    
    **Type:** Distributed
    
    This resource is responsible for provisioning and managing the Project Server
    service application in SharePoint Server 2016.
    
    To create a Project Server site the following DSC resources can
    be used to create the site and enable the feature.
    
        SPSite PWASite
        {
            Url                      = "http://projects.contoso.com"
            OwnerAlias               = "CONTOSO\ExampleUser"
            HostHeaderWebApplication = "http://spsites.contoso.com"
            Name                     = "PWA Site"
            Template                 = "PWA#0"
            PsDscRunAsCredential     = $SetupAccount
        }
    
        SPFeature PWASiteFeature
        {
            Name                 = "PWASITE"
            Url                  = "http://projects.contoso.com"
            FeatureScope         = "Site"
            PsDscRunAsCredential = $SetupAccount
            DependsOn            = "[SPSite]PWASite"
        }
    
.PARAMETER Name
    Key - string
    The name of the service application

.PARAMETER ApplicationPool
    Required - string
    The name of the application pool to run the service app in

.PARAMETER ProxyName
    Write - string
    The name of the Project Server Service Application Proxy

.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 shows how to create a new project server services service app
    in the local farm


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

        node localhost {
            SPProjectServerServiceApp ProjectServiceApp
            {
                Name = "Project Server Service Application"
                ApplicationPool = "SharePoint Web Services"
                InstallAccount  = $SetupAccount
            }
        }
    }


.EXAMPLE
    This example shows how to remove a project server service app in the local farm.
    The ApplicationPool property is still required but is not used when removing, so
    the value used here doesn't matter. Configuration Example { param( [Parameter(Mandatory = $true)] [PSCredential] $SetupAccount ) Import-DscResource -ModuleName SharePointDsc node localhost { SPProjectServerServiceApp ProjectServiceApp { Name = "Project Server Service Application" ApplicationPool = "n/a" Ensure = "Absent" InstallAccount = $SetupAccount } } }