Merge pull request #1405 from Ren-Roros-Digital/chore-AutopilotStatusPage

chore: fix up AutopilotStatusPage

Author: KelvinTegelaar

Modules/CIPPCore/Public/Set-CIPPDefaultAPEnrollment.ps1

@@ -23,7 +23,7 @@ function Set-CIPPDefaultAPEnrollment {
             'displayName'                             = 'All users and all devices'
             'description'                             = 'This is the default enrollment status screen configuration applied with the lowest priority to all users and all devices regardless of group membership.'
             'showInstallationProgress'                = [bool]$ShowProgress
-            'blockDeviceSetupRetryByUser'             = ![bool]$blockDevice
+            'blockDeviceSetupRetryByUser'             = ![bool]$BlockDevice
             'allowDeviceResetOnInstallFailure'        = [bool]$AllowReset
             'allowLogCollectionOnInstallFailure'      = [bool]$EnableLog
             'customErrorMessage'                      = "$ErrorMessage"
@@ -35,16 +35,16 @@ function Set-CIPPDefaultAPEnrollment {
             'roleScopeTagIds'                         = @()
         }
         $Body = ConvertTo-Json -InputObject $ObjBody
-        $ExistingStatusPage = (New-GraphGetRequest -Uri 'https://graph.microsoft.com/beta/deviceManagement/deviceEnrollmentConfigurations' -tenantid $($TenantFilter)) | Where-Object { $_.id -like '*DefaultWindows10EnrollmentCompletionPageConfiguration' }
+        $ExistingStatusPage = (New-GraphGetRequest -Uri 'https://graph.microsoft.com/beta/deviceManagement/deviceEnrollmentConfigurations' -tenantid $TenantFilter) | Where-Object { $_.id -like '*DefaultWindows10EnrollmentCompletionPageConfiguration' }
 
         if ($PSCmdlet.ShouldProcess($ExistingStatusPage.ID, 'Set Default Enrollment Status Page')) {
-            $null = New-GraphPOSTRequest -uri "https://graph.microsoft.com/beta/deviceManagement/deviceEnrollmentConfigurations/$($ExistingStatusPage.ID)" -body $body -Type PATCH -tenantid $($TenantFilter)
-            "Successfully changed default enrollment status page for $($($TenantFilter))"
-            Write-LogMessage -Headers $User -API $APINAME -tenant $($TenantFilter) -message "Added Autopilot Enrollment Status Page $($Displayname)" -Sev 'Info'
+            $null = New-GraphPOSTRequest -uri "https://graph.microsoft.com/beta/deviceManagement/deviceEnrollmentConfigurations/$($ExistingStatusPage.ID)" -body $Body -Type PATCH -tenantid $TenantFilter
+            "Successfully changed default enrollment status page for $TenantFilter"
+            Write-LogMessage -Headers $User -API $APIName -tenant $TenantFilter -message "Added Autopilot Enrollment Status Page $($ExistingStatusPage.displayName)" -Sev 'Info'
         }
     } catch {
         $ErrorMessage = Get-CippException -Exception $_
-        Write-LogMessage -Headers $User -API $APINAME -tenant $($TenantFilter) -message "Failed adding Autopilot Enrollment Status Page $($Displayname). Error: $($ErrorMessage.NormalizedError)" -Sev 'Error' -LogData $ErrorMessage
-        throw "Failed to change default enrollment status page for $($($TenantFilter)): $($ErrorMessage.NormalizedError)"
+        Write-LogMessage -Headers $User -API $APIName -tenant $TenantFilter -message "Failed adding Autopilot Enrollment Status Page $($ExistingStatusPage.displayName). Error: $($ErrorMessage.NormalizedError)" -Sev 'Error' -LogData $ErrorMessage
+        throw "Failed to change default enrollment status page for $($TenantFilter): $($ErrorMessage.NormalizedError)"
     }
 }

Modules/CIPPCore/Public/Standards/Invoke-CIPPStandardAutopilotStatusPage.ps1

@@ -36,16 +36,33 @@ function Invoke-CIPPStandardAutopilotStatusPage {
         https://docs.cipp.app/user-documentation/tenant/standards/list-standards/
     #>
     param($Tenant, $Settings)
+
+    # Get current Autopilot enrollment status page configuration
+    try {
+        $CurrentConfig = New-GraphGetRequest -uri "https://graph.microsoft.com/beta/deviceManagement/deviceEnrollmentConfigurations?`$expand=assignments&orderBy=priority&`$filter=deviceEnrollmentConfigurationType eq 'windows10EnrollmentCompletionPageConfiguration' and priority eq 0" -tenantid $Tenant |
+        Select-Object -Property id, displayName, priority, showInstallationProgress, blockDeviceSetupRetryByUser, allowDeviceResetOnInstallFailure, allowLogCollectionOnInstallFailure, customErrorMessage, installProgressTimeoutInMinutes, allowDeviceUseOnInstallFailure, trackInstallProgressForAutopilotOnly
+
+        $StateIsCorrect = ($CurrentConfig.installProgressTimeoutInMinutes -eq $Settings.TimeOutInMinutes) -and
+            ($CurrentConfig.customErrorMessage -eq $Settings.ErrorMessage) -and
+            ($CurrentConfig.showInstallationProgress -eq $Settings.ShowProgress) -and
+            ($CurrentConfig.allowLogCollectionOnInstallFailure -eq $Settings.EnableLog) -and
+            ($CurrentConfig.trackInstallProgressForAutopilotOnly -eq $Settings.OBEEOnly) -and
+            ($CurrentConfig.blockDeviceSetupRetryByUser -eq !$Settings.BlockDevice) -and
+            ($CurrentConfig.allowDeviceResetOnInstallFailure -eq $Settings.AllowReset) -and
+            ($CurrentConfig.allowDeviceUseOnInstallFailure -eq $Settings.AllowFail)
+    } catch {
+        $ErrorMessage = Get-NormalizedError -Message $_.Exception.Message
+        Write-LogMessage -API 'Standards' -tenant $Tenant -message "Failed to check Autopilot Enrollment Status Page: $ErrorMessage" -sev Error
+        $StateIsCorrect = $false
+    }
+
+    # Remediate if the state is not correct
     If ($Settings.remediate -eq $true) {
-        ##$Rerun -Type Standard -Tenant $Tenant -Settings $Settings 'APESP'
-        if ($Rerun -eq $true) {
-            exit 0
-        }
         try {
             $Parameters = @{
                 TenantFilter     = $Tenant
                 ShowProgress     = $Settings.ShowProgress
-                BlockDevice      = $Settings.blockDevice
+                BlockDevice      = $Settings.BlockDevice
                 AllowReset       = $Settings.AllowReset
                 EnableLog        = $Settings.EnableLog
                 ErrorMessage     = $Settings.ErrorMessage
@@ -61,51 +78,20 @@ function Invoke-CIPPStandardAutopilotStatusPage {
         }
     }
 
-    # Get current Autopilot enrollment status page configuration
-    try {
-        $CurrentConfig = New-GraphGetRequest -uri "https://graph.microsoft.com/beta/deviceManagement/deviceEnrollmentConfigurations?`$filter=startswith(displayName,'Windows Autopilot')" -tenantid $Tenant
-        
-        # Check if the enrollment status page exists
-        $ESPConfig = $CurrentConfig.value | Where-Object { $_.displayName -like '*Enrollment Status Page*' }
-        
-        $ESPConfigured = $null -ne $ESPConfig
-        
-        # Check if settings match what's expected
-        $SettingsMismatch = $false
-        $MismatchDetails = @{}
-        
-        if ($ESPConfigured) {
-            # Check timeout setting
-            if ($ESPConfig.priority -ne 0) {
-                $SettingsMismatch = $true
-                $MismatchDetails.Priority = @{Expected = 0; Actual = $ESPConfig.priority }
-            }
-
-        }
-        
-        $StateIsCorrect = $ESPConfigured -and (-not $SettingsMismatch)
-    } catch {
-        $ErrorMessage = Get-NormalizedError -Message $_.Exception.Message
-        Write-LogMessage -API 'Standards' -tenant $tenant -message "Failed to check Autopilot Enrollment Status Page: $ErrorMessage" -sev Error
-        $StateIsCorrect = $false
-    }
-    
+    # Report
     if ($Settings.report -eq $true) {
-        $state = $StateIsCorrect -eq $true ? $true : $StateIsCorrect
-        Set-CIPPStandardsCompareField -FieldName 'standards.AutopilotStatusPage' -FieldValue $state -TenantFilter $tenant
-        Add-CIPPBPAField -FieldName 'AutopilotStatusPage' -FieldValue $StateIsCorrect -StoreAs bool -Tenant $tenant
+        $FieldValue = $StateIsCorrect -eq $true ? $true : $CurrentConfig
+        Set-CIPPStandardsCompareField -FieldName 'standards.AutopilotStatusPage' -FieldValue $FieldValue -TenantFilter $Tenant
+        Add-CIPPBPAField -FieldName 'AutopilotStatusPage' -FieldValue [bool]$StateIsCorrect -StoreAs bool -Tenant $Tenant
     }
 
-    if ($Settings.alert) {
-        if (!$ESPConfigured) {
-            Write-StandardsAlert -message 'Autopilot Enrollment Status Page is not configured' -object @{} -tenant $Tenant -standardName 'AutopilotStatusPage' -standardId $Settings.standardId
-            Write-LogMessage -API 'Standards' -tenant $tenant -message 'Autopilot Enrollment Status Page is not configured' -sev Info
-        } elseif ($SettingsMismatch) {
-            Write-StandardsAlert -message 'Autopilot Enrollment Status Page settings do not match expected configuration' -object $MismatchDetails -tenant $Tenant -standardName 'AutopilotStatusPage' -standardId $Settings.standardId
-            Write-LogMessage -API 'Standards' -tenant $tenant -message 'Autopilot Enrollment Status Page settings do not match expected configuration' -sev Info
+    # Alert
+    if ($Settings.alert -eq $true) {
+        if ($StateIsCorrect -eq $true) {
+            Write-LogMessage -API 'Standards' -tenant $Tenant -message 'Autopilot Enrollment Status Page is configured correctly' -sev Info
         } else {
-            Write-LogMessage -API 'Standards' -tenant $tenant -message 'Autopilot Enrollment Status Page is configured correctly' -sev Info
+            Write-StandardsAlert -message 'Autopilot Enrollment Status Page settings do not match expected configuration' -object $CurrentConfig -tenant $Tenant -standardName 'AutopilotStatusPage' -standardId $Settings.standardId
+            Write-LogMessage -API 'Standards' -tenant $Tenant -message 'Autopilot Enrollment Status Page settings do not match expected configuration' -sev Info
         }
     }
-
 }