Add ScheduledTaskId tracking and filtering to logs

Introduces script-level ScheduledTaskId variable in Push-ExecScheduledCommand and ensures its cleanup. Updates Write-LogMessage to include ScheduledTaskId in log entries. Enhances Invoke-ListLogs to support filtering by ScheduledTaskId, improving traceability of scheduled tasks in logs. Also adds cleanup for StandardInfo variable in Push-CIPPStandard.

Author: JohnDuprey

Modules/CIPPCore/Public/Entrypoints/Activity Triggers/Push-ExecScheduledCommand.ps1

@@ -7,6 +7,8 @@ function Push-ExecScheduledCommand {
     $item = $Item | ConvertTo-Json -Depth 100 | ConvertFrom-Json
     Write-Information "We are going to be running a scheduled task: $($Item.TaskInfo | ConvertTo-Json -Depth 10)"
 
+    $script:ScheduledTaskId = $Item.TaskInfo.RowKey
+
     $Table = Get-CippTable -tablename 'ScheduledTasks'
     $task = $Item.TaskInfo
     $commandParameters = $Item.Parameters | ConvertTo-Json -Depth 10 | ConvertFrom-Json -AsHashtable
@@ -21,10 +23,12 @@ function Push-ExecScheduledCommand {
     $CurrentTask = Get-AzDataTableEntity @Table -Filter "PartitionKey eq '$($task.PartitionKey)' and RowKey eq '$($task.RowKey)'"
     if (!$CurrentTask) {
         Write-Information "The task $($task.Name) for tenant $($task.Tenant) does not exist in the ScheduledTasks table. Exiting."
+        Remove-Variable -Name ScheduledTaskId -Scope Script -ErrorAction SilentlyContinue
         return
     }
     if ($CurrentTask.TaskState -eq 'Completed') {
         Write-Information "The task $($task.Name) for tenant $($task.Tenant) is already completed. Skipping execution."
+        Remove-Variable -Name ScheduledTaskId -Scope Script -ErrorAction SilentlyContinue
         return
     }
 
@@ -69,6 +73,7 @@ function Push-ExecScheduledCommand {
                     TaskState     = 'Planned'
                     ScheduledTime = [string]$nextRunUnixTime
                 }
+                Remove-Variable -Name ScheduledTaskId -Scope Script -ErrorAction SilentlyContinue
                 return
             }
         }
@@ -94,6 +99,7 @@ function Push-ExecScheduledCommand {
         }
 
         Write-LogMessage -API 'Scheduler_UserTasks' -tenant $Tenant -tenantid $TenantInfo.customerId -message "Failed to execute task $($task.Name): The command $($Item.Command) does not exist." -sev Error
+        Remove-Variable -Name ScheduledTaskId -Scope Script -ErrorAction SilentlyContinue
         return
     }
 
@@ -330,4 +336,5 @@ function Push-ExecScheduledCommand {
     if ($TaskType -ne 'Alert') {
         Write-LogMessage -API 'Scheduler_UserTasks' -tenant $Tenant -tenantid $TenantInfo.customerId -message "Successfully executed task: $($task.Name)" -sev Info
     }
+    Remove-Variable -Name ScheduledTaskId -Scope Script -ErrorAction SilentlyContinue
 }

Modules/CIPPCore/Public/Entrypoints/Activity Triggers/Standards/Push-CIPPStandard.ps1

@@ -56,5 +56,7 @@ function Push-CIPPStandard {
         Write-Warning "Error running standard $($Standard) for tenant $($Tenant) - $($_.Exception.Message)"
         Write-Information $_.InvocationInfo.PositionMessage
         throw $_.Exception.Message
+    } finally {
+        Remove-Variable -Name StandardInfo -Scope Script -ErrorAction SilentlyContinue
     }
 }

Modules/CIPPCore/Public/Entrypoints/Invoke-ListLogs.ps1

@@ -86,6 +86,7 @@ function Invoke-ListLogs {
             $TenantFilter = $Request.Query.Tenant
             $ApiFilter = $Request.Query.API
             $StandardFilter = $Request.Query.StandardTemplateId
+            $ScheduledTaskFilter = $Request.Query.ScheduledTaskId
 
             $StartDate = $Request.Query.StartDate ?? $Request.Query.DateFilter
             $EndDate = $Request.Query.EndDate ?? $Request.Query.DateFilter
@@ -115,9 +116,10 @@ function Invoke-ListLogs {
         $Rows = Get-AzDataTableEntity @Table -Filter $Filter | Where-Object {
             $_.Severity -in $LogLevel -and
             $_.Username -like $username -and
-            ($TenantFilter -eq $null -or $TenantFilter -eq 'AllTenants' -or $_.Tenant -like "*$TenantFilter*" -or $_.TenantID -eq $TenantFilter) -and
-            ($ApiFilter -eq $null -or $_.API -match "$ApiFilter") -and
-            ($StandardFilter -eq $null -or $_.StandardTemplateId -eq $StandardFilter)
+            ([string]::IsNullOrEmpty($TenantFilter) -or $TenantFilter -eq 'AllTenants' -or $_.Tenant -like "*$TenantFilter*" -or $_.TenantID -eq $TenantFilter) -and
+            ([string]::IsNullOrEmpty($ApiFilter) -or $_.API -match "$ApiFilter") -and
+            ([string]::IsNullOrEmpty($StandardFilter) -or $_.StandardTemplateId -eq $StandardFilter) -and
+            ([string]::IsNullOrEmpty($ScheduledTaskFilter) -or $_.ScheduledTaskId -eq $ScheduledTaskFilter)
         }
 
         if ($AllowedTenants -notcontains 'AllTenants') {

Modules/CIPPCore/Public/GraphHelper/Write-LogMessage.ps1

@@ -76,6 +76,9 @@ function Write-LogMessage {
             $TableRow.ConditionalAccessTemplateId = [string]$script:StandardInfo.ConditionalAccessTemplateId
         }
     }
+    if ($script:ScheduledTaskId) {
+        $TableRow.ScheduledTaskId = [string]$script:ScheduledTaskId
+    }
 
     $Table.Entity = $TableRow
     Add-CIPPAzDataTableEntity @Table | Out-Null