Skip to content

SPWorkManagementServiceApp

Brian Farnhill edited this page Dec 9, 2016 · 21 revisions

Parameters

Parameter Attribute DataType Description Allowed Values
Name Key string The name of the work management service application
ProxyName Write string The proxy name, if not specified will be /Name of service app/ Proxy
Ensure Write string Present to ensure the app exists, Absent to ensure it is removed Present, Absent
ApplicationPool Write String The name of the application pool this will run in
MinimumTimeBetweenEwsSyncSubscriptionSearches Write uint32 The minimum amount of time bween EWS sync subscription searches
MinimumTimeBetweenProviderRefreshes Write uint32 The minimum time between provider refreshes
MinimumTimeBetweenSearchQueries Write uint32 The minimum time between search queries
NumberOfSubscriptionSyncsPerEwsSyncRun Write uint32 The number of subscription syncronisations per EWS sync run
NumberOfUsersEwsSyncWillProcessAtOnce Write uint32 How many users will EWS calls include at once
NumberOfUsersPerEwsSyncBatch Write uint32 How many users are included in a batch for EWS
InstallAccount Write String POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5

Description

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.

Examples

Example 1

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
        }
    }
}
Clone this wiki locally