en-US/about_SPProjectServerGroup.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
.NAME
    SPProjectServerGroup

# Description
    
    **Type:** Distributed
    
    This resource is used to configure a group within Project Server. This is only
    available for use when the site is configured to use Project Server permissions
    mode and for Project Server 2016 only.
    
.PARAMETER Url
    Key - string
    The default zone URL of the Project site to manage the group at

.PARAMETER Name
    Key - string
    The name of the group

.PARAMETER Description
    Write - string
    The description of the group

.PARAMETER ADGroup
    Write - string
    What AD group should be used to synchronise membership to this Project Server group, cannot be used with Members, MembersToInclude or MembersToExclude

.PARAMETER Members
    Write - string
    A fixed list of members to be in this group, cannot be used with ADGroup, MembersToInclude or MembersToExclude

.PARAMETER MembersToInclude
    Write - string
    A list of members to ensure are in this group, cannot be used with ADGroup or Members

.PARAMETER MembersToExclude
    Write - string
    A list of members to ensure are not in this group, cannot be used with ADGroup or Members

.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 group with a specific list of members in a PWA site


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

    node localhost 
    {
        SPProjectServerGroup Group
        {
            Url = "http://projects.contoso.com"
            Name = "My group"
            Members = @(
                "Domain\User1"
                "Domain\User2"
            )
            PSDscRunAsCredential = $SetupAccount
        }
    }
}


.EXAMPLE
    This example shows how to create a PWA group mapped to a group in AD


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

    node localhost 
    {
        SPProjectServerGroup Group
        {
            Url = "http://projects.contoso.com"
            Name = "My group"
            ADGroup = "Domain\Group"
            PSDscRunAsCredential = $SetupAccount
        }
    }
}