en-US/about_SPUserProfileSection.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
.NAME
    SPUserProfileSection

# Description
    
    This resource will create a section in a user profile service application. It
    creates, update or delete a section using the parameters that are passed in to
    it.
    
    If no DisplayOrder is added then SharePoint will automatically assigned an ID
    
    The default value for the Ensure parameter is Present. When not specifying this
    parameter, the user profile section is created.
    
.PARAMETER Name
    Key - string
    The internal name of the user profile section

.PARAMETER Ensure
    Write - string
    Allowed values: Present, Absent
    Present if the section should exist, absent if it should be removed

.PARAMETER UserProfileService
    Required - string
    The name of the user profile service application this section exists in

.PARAMETER DisplayName
    Write - string
    The display name of the section

.PARAMETER DisplayOrder
    Write - uint32
    A number used to sort sections by

.PARAMETER InstallAccount
    Write - String
    POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5


.EXAMPLE
    This example adds a new section for profile properties to the specified
    user profile service app


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

        node localhost {
            SPUserProfileSection PersonalInformationSection
            {
                Name = "PersonalInformationSection"
                UserProfileService = "User Profile Service Application"
                DisplayName = "Personal Information"
                DisplayOrder = 5000
                Ensure = "Present"
                PsDscRunAsCredential = $SetupAccount
            }
        }
    }