Adding example for OnEvent scheduled task configuration and adding help to parameters

Author: danielboth

Modules/ComputerManagementDsc/DSCResources/MSFT_ScheduledTask/MSFT_ScheduledTask.psm1

@@ -201,6 +201,14 @@ $script:localizedData = Get-LocalizedData `
     .PARAMETER LogonType
         Specifies the security logon method that Task Scheduler uses to run the tasks that
         are associated with the principal. Not used in Get-TargetResource.
+
+    .PARAMETER EventSubscription
+        The event subscription in a string that can be parsed as valid XML. This parameter is only
+        valid in combination with the OnEvent Schedule Type.
+
+    .PARAMETER Delay
+        The time to wait after an event based trigger was triggered. This parameter is only
+        valid in combination with the OnEvent Schedule Type.
 #>
 function Get-TargetResource
 {
@@ -681,6 +689,14 @@ function Get-TargetResource
     .PARAMETER LogonType
         Specifies the security logon method that Task Scheduler uses to run the tasks that
         are associated with the principal.
+
+    .PARAMETER EventSubscription
+        The event subscription in a string that can be parsed as valid XML. This parameter is only
+        valid in combination with the OnEvent Schedule Type.
+
+    .PARAMETER Delay
+        The time to wait after an event based trigger was triggered. This parameter is only
+        valid in combination with the OnEvent Schedule Type.
 #>
 function Set-TargetResource
 {
@@ -1436,6 +1452,14 @@ function Set-TargetResource
     .PARAMETER LogonType
         Specifies the security logon method that Task Scheduler uses to run the tasks that
         are associated with the principal.
+
+    .PARAMETER EventSubscription
+        The event subscription in a string that can be parsed as valid XML. This parameter is only
+        valid in combination with the OnEvent Schedule Type.
+
+    .PARAMETER Delay
+        The time to wait after an event based trigger was triggered. This parameter is only
+        valid in combination with the OnEvent Schedule Type.
 #>
 function Test-TargetResource
 {

Modules/ComputerManagementDsc/DSCResources/MSFT_ScheduledTask/MSFT_ScheduledTask.schema.mof

@@ -7,7 +7,7 @@ class MSFT_ScheduledTask : OMI_BaseResource
     [Write, Description("The path to the .exe for this task")] string ActionExecutable;
     [Write, Description("The arguments to pass the executable")] string ActionArguments;
     [Write, Description("The working path to specify for the executable")] string ActionWorkingPath;
-    [Write, Description("When should the task be executed"), ValueMap{"Once", "Daily", "Weekly", "AtStartup", "AtLogOn"}, Values{"Once", "Daily", "Weekly", "AtStartup", "AtLogOn"}] string ScheduleType;
+    [Write, Description("When should the task be executed"), ValueMap{"Once", "Daily", "Weekly", "AtStartup", "AtLogOn", "OnEvent"}, Values{"Once", "Daily", "Weekly", "AtStartup", "AtLogOn", "OnEvent"}] string ScheduleType;
     [Write, Description("How many units (minutes, hours, days) between each run of this task?")] String RepeatInterval;
     [Write, Description("The time of day this task should start at - defaults to 12:00 AM. Not valid for AtLogon and AtStartup tasks")] DateTime StartTime;
     [Write, Description("Present if the task should exist, Absent if it should be removed"), ValueMap{"Present","Absent"}, Values{"Present","Absent"}] string Ensure;

Modules/ComputerManagementDsc/Examples/Resources/ScheduledTask/13-CreateScheduledTasksOnEvent.ps1

@@ -0,0 +1,33 @@
+<#
+    .EXAMPLE
+    This example creates a scheduled task called 'TriggerOnServiceFailures' in the folder
+    root folder. The task is delayed by exactly 30 seconds each time. The task will run when
+    an error event 7001 of source Service Control Manager is generated in the system log.
+    When a service crashes, it waits for 30 seconds and then starts a new PowerShell instance,
+    in which the command Invoke-ServiceCrashReport will be executed.
+#>
+Configuration Example
+{
+    param
+    (
+        [Parameter()]
+        [System.String[]]
+        $NodeName = 'localhost'
+    )
+
+    Import-DscResource -ModuleName ComputerManagementDsc
+
+    Node $NodeName
+    {
+        ScheduledTask ServiceEventManager 
+        {
+            TaskName = 'TriggerOnServiceFailures'
+            Ensure = 'Present'
+            ScheduleType = 'OnEvent'
+            ActionExecutable = 'C:\windows\system32\WindowsPowerShell\v1.0\powershell.exe'
+            ActionArguments = '-Command Invoke-ServiceCrashReport'
+            EventSubscription = '<QueryList><Query Id="0" Path="System"><Select Path="System">*[System[Provider[@Name=''Service Control Manager''] and (Level=2) and (EventID=7001)]]</Select></Query></QueryList>'
+            Delay = '00:00:30'
+        }
+    }
+}