en-US/about_SPWorkManagementServiceApp.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
.NAME
    SPWorkManagementServiceApp

# Description
    
    **Type:** Distributed
    
    This resource is used to provision and manage an instance of the Work
    Management Services Service Application. It will identify an instance of the
    work management service application through the application display name.
    Currently the resource will provision the app if it does not yet exist, and
    will change the application pool associated to the app if it does not match
    the configuration.
    
    Remarks
    
    - Parameters MinimumTimeBetweenEwsSyncSubscriptionSearches,
      MinimumTimeBetweenProviderRefreshes, MinimumTimeBetweenSearchQueries are in
      minutes.
    
    The default value for the Ensure parameter is Present. When not specifying this
    parameter, the service application is provisioned.
    
    NOTE:
    You cannot use this resource with SharePoint 2016, since the Work
    Management functionality has been removed in SharePoint 2016.
    More information:
    https://technet.microsoft.com/en-us/library/mt346112(v=office.16).aspx
    
.PARAMETER Name
    Key - string
    The name of the work management service application

.PARAMETER ProxyName
    Write - string
    The proxy name, if not specified will be /Name of service app/ Proxy

.PARAMETER Ensure
    Write - string
    Allowed values: Present, Absent
    Present to ensure the app exists, Absent to ensure it is removed

.PARAMETER ApplicationPool
    Write - String
    The name of the application pool this will run in

.PARAMETER MinimumTimeBetweenEwsSyncSubscriptionSearches
    Write - uint32
    The minimum amount of time bween EWS sync subscription searches

.PARAMETER MinimumTimeBetweenProviderRefreshes
    Write - uint32
    The minimum time between provider refreshes

.PARAMETER MinimumTimeBetweenSearchQueries
    Write - uint32
    The minimum time between search queries

.PARAMETER NumberOfSubscriptionSyncsPerEwsSyncRun
    Write - uint32
    The number of subscription syncronisations per EWS sync run

.PARAMETER NumberOfUsersEwsSyncWillProcessAtOnce
    Write - uint32
    How many users will EWS calls include at once

.PARAMETER NumberOfUsersPerEwsSyncBatch
    Write - uint32
    How many users are included in a batch for EWS

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


.EXAMPLE
    This example creates a new work management service app in the local farm


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

        node localhost {
            SPWorkManagementServiceApp WorkManagementServiceApp
            {
                Name                   = "Work Management Service Application"
                ApplicationPool        = "SharePoint web services"
                MinimumTimeBetweenEwsSyncSubscriptionSearches = 10
                PsDscRunAsCredential   = $SetupAccount
            }
        }
    }