en-US/about_SPWebAppPeoplePickerSettings.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
.NAME
    SPWebAppPeoplePickerSettings

# Description
    
    **Type:** Distributed
    
    This resource is used to configure the People Picker settings for a web
    application.
    
    NOTE:
    If the forest or domain on which SharePoint is installed has a one-way
    trust with another forest or domain, you must first set the credentials
    for an account that can authenticate with the forest or domain to be
    queried before you can configure the SearchActiveDirectoryDomains.
    
    The encryption key must be set on every front-end web server in the farm
    on which SharePoint is installed:
    https://technet.microsoft.com/en-us/library/gg602075(v=office.15).aspx#section3
    
.PARAMETER WebAppUrl
    Key - string
    The URL of the web application

.PARAMETER ActiveDirectoryCustomFilter
    Write - String
    Sets a customized query filter to send to Active Directory

.PARAMETER ActiveDirectoryCustomQuery
    Write - String
    Sets the custom query that is sent to Active Directory

.PARAMETER ActiveDirectorySearchTimeout
    Write - Uint16
    Sets the time-out in seconds when a query is issued to Active Directory

.PARAMETER OnlySearchWithinSiteCollection
    Write - Boolean
    Specifies whether to search only the current site collection

.PARAMETER SearchActiveDirectoryDomains
    Write - String
    List of all domains/forests that must be searched

.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 configure the people picker settings on the specified web application


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

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

        node localhost {
            SPWebAppPeoplePickerSettings ConfigurePeoplePicker
            {
                WebAppUrl                      = "http://sharepoint.contoso.com"
                ActiveDirectoryCustomFilter    = $null
                ActiveDirectoryCustomQuery     = $null
                ActiveDirectorySearchTimeout   = 30
                OnlySearchWithinSiteCollection = $false
                SearchActiveDirectoryDomains   = @(
                    MSFT_SPWebAppPPSearchDomain {
                        FQDN          = "contoso.com"
                        IsForest      = $false
                        AccessAccount = $AccessAccount
                    }
                )
                PsDscRunAsCredential           = $SetupAccount
            }
        }
    }