Public/Build-IntuneConfigReport.ps1

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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
function Build-IntuneConfigReport {
    [cmdletbinding()]
    param (
        [Parameter(mandatory = $true)]
        [System.Uri]$Tenant,

        [Parameter(mandatory = $true)]
        [System.IO.FileInfo]$OutputFolder,

        [Parameter(mandatory = $false)]
        [ValidateSet('admx','autopilot','deviceCompliance','deviceConfiguration','endpointSecurityPolicy','enrollmentStatus','featureUpdate','scripts','office365','proactiveRemediation','win32Apps')]
        [string[]]$Filter
    )
    try {
        #region authentication
        if (!($PSVersionTable.PSEdition -eq 'core')) {
            throw "Needs to be run in PWSH 7."
        }
        $auth = Get-MsalToken -ClientId $script:applicationId -Tenant $Tenant -DeviceCode
        $authToken = @{
            'Content-Type'  = 'application/json'
            'Authorization' = $auth.CreateAuthorizationHeader()
            'ExpiresOn'     = $($auth.ExpiresOn.LocalDateTime)
        }
        #endregion
        #region Grab the endpoint data
        if ($null -eq $Filter) {
            [string[]]$Filter = 'all'
        }
        Write-Host "Grabbing configuration.. ☕" -ForegroundColor Yellow
        $config = @{
            admxConfiguration      = $Filter -match "all|admx" ? (Get-DeviceManagementPolicy -AuthToken $authToken -ManagementType ADMX) : $null
            autopilot              = $Filter -match "all|autopilot" ? (Get-DeviceManagementPolicy -AuthToken $authToken -ManagementType AutoPilot) : $null
            deviceCompliance       = $Filter -match "all|deviceCompliance" ? (Get-DeviceManagementPolicy -AuthToken $authToken -ManagementType Compliance) : $null
            deviceConfiguration    = $Filter -match "all|deviceConfiguration" ? (Get-DeviceManagementPolicy -AuthToken $authToken -ManagementType Configuration) : $null
            endpointSecurityPolicy = $Filter -match "all|endpointSecurityPolicy" ? (Get-DeviceManagementPolicy -AuthToken $authToken -ManagementType EndpointSecurity) : $null
            enrollmentStatus       = $Filter -match "all|enrollmentStatus" ? (Get-DeviceManagementPolicy -AuthToken $authToken -ManagementType EnrollmentStatus) : $null
            featureUpdate          = $Filter -match "all|featureUpdate" ? (Get-DeviceManagementPolicy -AuthToken $authToken -ManagementType FeatureUpdate) : $null
            scripts                = $Filter -match "all|scripts" ? (Get-DeviceManagementPolicy -AuthToken $authToken -ManagementType Script) : $null
            office365              = $Filter -match "all|office365" ? (Get-MobileAppConfigurations -AuthToken $authToken -MobileAppType Office365) : $null
            proactiveRemediation     = $Filter -match "all|proactiveRemediation" ? (Get-DeviceManagementPolicy -AuthToken $authToken -ManagementType ProactiveRemediation) : $null
            win32Apps              = $Filter -match "all|win32Apps" ? (Get-MobileAppConfigurations -AuthToken $authToken -MobileAppType Win32) : $null
        }
        #endregion
        #region configuration
        $outputPath = "$outputFolder\$Tenant"
        $paths = @{
            admx              = (($config.admxConfiguration) ? "$outputPath\admx" : $null)
            apps              = (($config.win32Apps) ? "$outputPath\apps" : $null)
            autopilotPath     = (($config.autoPilot) ? "$outputPath\autopilot" : $null)
            compliancePath    = (($config.deviceCompliance) ? "$outputPath\compliance-policies" : $null)
            configurationPath = (($config.deviceConfiguration) ? "$outputPath\config-profiles" : $null)
            endpointSecurity  = (($config.endpointSecurityPolicy) ? "$outputPath\endpoint-security-policies" : $null)
            esp               = (($config.enrollmentStatus) ? "$outputPath\esp" : $null)
            fu                = (($config.featureUpdate) ? "$outputPath\feature-update" : $null)
            o365              = (($config.office365) ? "$outputPath\o365" : $null)
            prScripts         = (($config.proactiveRemediation) ? "$outputPath\proactive-remediation-scripts" : $null)
            scriptPath        = (($config.scripts) ? "$outputPath\scripts" : $null)
        }
        $markdownReport = "$outputPath\$Tenant`_report.md"
        #endregion
        #region prepare folder structure
        foreach ($p in ($paths.values | Where-Object { $null -ne $_ })) {
            if (!(Test-Path $p)) {
                New-Item -Path $p -ItemType Directory -Force | Out-Null
            }
        }
        if (!(Test-Path $markdownReport)) {
            New-Item -Path $markdownReport -ItemType File -Force | Out-Null
        }
        else {
            Remove-Item -Path $markdownReport -Force | Out-Null
            New-Item -Path $markdownReport -ItemType File -Force | Out-Null
        }
        #endregion
        #region Generate Title of report
        #endregion
        #region ADMX
        if ($config.admxConfiguration) {
            Write-Host "`rGenerating Report:" -NoNewline -ForegroundColor Yellow
            Write-Host " ADMX Policies " -NoNewline -ForegroundColor Green
            "## ADMX Policies`n" | Out-File $markdownReport -Encoding ascii -NoNewline -Append
            foreach ($gpc in $config.admxConfiguration) {
                "`n### $($gpc.displayName)`n" | Out-File $markdownReport -Encoding ascii -NoNewline -Append
                $folderName = Format-String -inputString $gpc.displayName
                New-Item "$($paths.admx)\$folderName" -ItemType Directory -Force | Out-Null
                $gpcDefinitionValues = Get-GroupPolicyConfigurationsDefinitionValues -GroupPolicyConfigurationID $gpc.id
                foreach ($v in $gpcDefinitionValues) {
                    $definitionValuedefinition = Get-GroupPolicyConfigurationsDefinitionValuesdefinition -GroupPolicyConfigurationID $gpc.id -GroupPolicyConfigurationsDefinitionValueID $v.id
                    $definitionValuedefinitionDisplayName = $definitionValuedefinition.displayName
                    $definitionValuePresentationValues = Get-GroupPolicyConfigurationsDefinitionValuesPresentationValues -GroupPolicyConfigurationID $gpc.id -GroupPolicyConfigurationsDefinitionValueID $v.id
                    $outdef = [PSCustomObject]@{
                        enabled = $($v.enabled.tostring().tolower())
                    }
                    if ($definitionValuePresentationValues.values.count -gt 1) {
                        $presvalues = foreach ($pres in $definitionValuePresentationValues.values) {
                            $pres | Select-Object -Property * -ExcludeProperty id, createdDateTime, lastModifiedDateTime, version, '*@odata*'
                        }
                        $outdef | Add-Member -MemberType NoteProperty -Name "presentationValues" -Value $presvalues
                    }
                    $filename = Format-String -inputString "$($DefinitionValuedefinition.categoryPath)-$definitionValuedefinitionDisplayName"
                    $outdef | ConvertTo-Json -Depth 10 | Out-File -FilePath "$($paths.admx)\$($folderName)\$filename.json" -Encoding ascii
                    $tmp = @{ }
                    $tmp.jsonResult = Format-NullProperties -InputObject $outdef | ConvertTo-Json -Depth 20
                    $tmp.mdResult = (Convert-JsonToMarkdown -json ($tmp.jsonResult) -title "`n##### $($filename -replace '_', ' ')" ) -replace 'presentationValues.',''
                    $tmp.mdResult | Out-File $markdownReport -Encoding ascii -NoNewline -Append
                }
                Format-Assignment -policy $gpc | Out-File $markdownReport -Encoding ascii -NoNewline -Append
            }
            "`n---`n" | Out-File $markdownReport -Encoding ascii -NoNewline -Append
        }
        #endregion
        #region AutoPilot
        if ($config.autoPilot) {
            Write-Host "`rGenerating Report:" -NoNewline -ForegroundColor Yellow
            Write-Host " AutoPilot Policies " -NoNewline -ForegroundColor Green
            "`n## AutoPilot Policies`n" | Out-File $markdownReport -Encoding ascii -NoNewline -Append
            foreach ($a in $config.autoPilot) {
                Format-Policy -policy $a -markdownReport $markdownReport -outFile "$($paths.autopilotPath)\$(Format-String -inputString $a.displayName)`.json"
                Format-Assignment -policy $a | Out-File $markdownReport -Encoding ascii -NoNewline -Append

            }
            "`n---`n" | Out-File $markdownReport -Encoding ascii -NoNewline -Append
        }
        #endregion
        #region Compliance
        if ($config.deviceCompliance) {
            Write-Host "`rGenerating Report:" -NoNewline -ForegroundColor Yellow
            Write-Host " Device Compliance Policies " -NoNewline -ForegroundColor Green
            "`n## Device Compliance Policies`n" | Out-File $markdownReport -Encoding ascii -NoNewline -Append
            foreach ($d in $config.deviceCompliance) {
                Format-Policy -policy $d -markdownReport $markdownReport -outFile "$($paths.compliancePath)\$(Format-String -inputString $d.displayName)`.json"
                Format-Assignment -policy $d | Out-File $markdownReport -Encoding ascii -NoNewline -Append
            }
            "`n---`n" | Out-File $markdownReport -Encoding ascii -NoNewline -Append
        }
        #endregion
        #region Configuration
        if ($config.deviceConfiguration) {
            Write-Host "`rGenerating Report:" -NoNewline -ForegroundColor Yellow
            Write-Host " Device Configuration Policies" -NoNewline -ForegroundColor Green
            "`n## Device Configuration Policies`n" | Out-File $markdownReport -Encoding ascii -NoNewline -Append
            foreach ($d in $config.deviceConfiguration) {
                Format-Policy -policy $d -markdownReport $markdownReport -outFile "$($paths.configurationPath)\$(Format-String -inputString $d.displayName)`.json"
                Format-Assignment -policy $d | Out-File $markdownReport -Encoding ascii -NoNewline -Append
            }
            "`n---`n" | Out-File $markdownReport -Encoding ascii -NoNewline -Append
        }
        #endregion
        #region Endpoint Security Policies
        if ($config.endpointSecurityPolicy) {
            Write-Host "`rGenerating Report:" -NoNewline -ForegroundColor Yellow
            Write-Host " Endpoint Security Policies " -NoNewline -ForegroundColor Green
            "`n## Endpoint Security Policy`n" | Out-File $markdownReport -Encoding ascii -NoNewline -Append
            foreach ($e in $config.endpointSecurityPolicy) {
                "`n### $($e.displayName)`n" | Out-File $markdownReport -Encoding ascii -NoNewline -Append
                $folderName = Format-String -inputString $e.displayName
                New-Item "$($paths.endpointSecurity)\$folderName" -ItemType Directory -Force | Out-Null
                # store template
                $e | Select-Object templateId, displayName, description | ConvertTo-Json -Depth 10 | Out-File -FilePath "$($paths.endpointSecurity)\$folderName\template.json" -Encoding ascii
                #store intents
                $intents = $($e.settings | Select-Object '*@odata*', definitionId, ValueJson | ConvertTo-Json -Depth 10)
                @{
                    "settings" = $intents
                } | ConvertTo-Json | Out-File -FilePath "$($paths.endpointSecurity)\$folderName\intent.json" -Encoding ascii
                #expand setting values
                Get-EndpointSecurityPolicyDetails -AuthToken $authToken -ESPolicies $e
                foreach ($s in $e.settings) {
                    if (!($s.valueJson -eq '"notConfigured"' -or $s.valueJson -eq 'null')) {
                        Write-Verbose "$($s.DisplayName): $($s.valueJson)"
                        $tmp = @{}
                        if ((($s.valueJson | ConvertFrom-Json).psobject.members | Where-Object { $_.membertype -eq "NoteProperty" }).count -eq 0) {
                            $tmp.jsonResult = $s | Select-Object @{ Name = $s.DisplayName; Expression = { $_.valueJson | ConvertFrom-Json } } | ConvertTo-Json -Depth 10
                        }
                        else {
                            $tmp.jsonResult = $s | Select-Object @{ Name = 'Value'; Expression = { $_.valueJson | ConvertFrom-Json } } | ConvertTo-Json -Depth 10
                        }
                        $tmp.mdResult = (Convert-JsonToMarkdown -json $tmp.jsonResult -title "#### $($s.DisplayName)") -replace 'Value\.'
                        $tmp.mdResult | Out-File $markdownReport -Encoding ascii -NoNewline -Append
                    }
                    else {
                        Write-Verbose "$($s.DisplayName): $($s.valueJson)"
                    }
                }
                Format-Assignment -policy $e | Out-File $markdownReport -Encoding ascii -NoNewline -Append
            }
            "`n---`n" | Out-File $markdownReport -Encoding ascii -NoNewline -Append
        }
        #endregion
        #region Enrollment Status Page
        if ($config.enrollmentStatus) {
            Write-Host "`rGenerating Report:" -NoNewline -ForegroundColor Yellow
            Write-Host " Enrollment Status Policies " -NoNewline -ForegroundColor Green
            "`n## Enrollment Status Policy`n" | Out-File $markdownReport -Encoding ascii -NoNewline -Append
            foreach ($e in $config.enrollmentStatus) {
                Format-Policy -policy $e -markdownReport $markdownReport -outFile "$($paths.esp)\$(Format-String -inputString $e.displayName)`.json"
                Format-Assignment -policy $e | Out-File $markdownReport -Encoding ascii -NoNewline -Append
            }
            "`n---`n" | Out-File $markdownReport -Encoding ascii -NoNewline -Append
        }
        #endregion
        #region Feature Update
        if ($config.featureUpdate) {
            Write-Host "`rGenerating Report:" -NoNewline -ForegroundColor Yellow
            Write-Host " Feature Updates " -NoNewline -ForegroundColor Green
            "`n## Feature Update Policy`n" | Out-File $markdownReport -Encoding ascii -NoNewline -Append
            foreach ($f in $config.featureUpdate) {
                Format-Policy -policy $f -markdownReport $markdownReport -outFile "$($paths.fu)\$(Format-String -inputString $f.displayName)`.json"
                Format-Assignment -policy $f | Out-File $markdownReport -Encoding ascii -NoNewline -Append
            }
            "`n---`n" | Out-File $markdownReport -Encoding ascii -NoNewline -Append
        }
        #endregion
        #region Scripts
        if ($config.scripts) {
            Write-Host "`rGenerating Report:" -NoNewline -ForegroundColor Yellow
            Write-Host " PowerShell Scripts " -NoNewline -ForegroundColor Green
            "`n## PowerShell Scripts`n" | Out-File $markdownReport -Encoding ascii -NoNewline -Append
            foreach ($s in $config.scripts) {
                $displayName = $null
                $displayName = Format-String -inputString $s.displayName
                #store the script contents locally
                New-Item "$($paths.scriptPath)\$displayName" -ItemType Directory -Force | Out-Null
                [System.Text.Encoding]::ASCII.GetString([System.Convert]::FromBase64String("$($s.scriptContent)")) |
                Out-File -FilePath "$($paths.scriptPath)\$displayName\$displayName`.ps1" -Encoding ascii -Force

                $fpParam = @{
                    policy         = $($s | Select-Object displayName, description, runAsAccount, enforceSignatureCheck, fileName, runAs32Bit, '*@odata*', assignments)
                    markdownReport = $markdownReport
                    outFile        = "$($paths.scriptPath)\$displayName\$displayName`.json"
                }
                Format-Policy @fpParam
                Format-Assignment -policy $s | Out-File $markdownReport -Encoding ascii -NoNewline -Append
            }
            "`n---`n" | Out-File $markdownReport -Encoding ascii -NoNewline -Append
        }
        #endregion
        #region Office 365 Applications
        if ($config.office365) {
            Write-Host "`rGenerating Report:" -NoNewline -ForegroundColor Yellow
            Write-Host " Office 365 " -NoNewline -ForegroundColor Green
            "`n## Office 365 Configuration`n" | Out-File $markdownReport -Encoding ascii -NoNewline -Append
            foreach ($o in $config.office365) {
                Format-Policy -policy $o -markdownReport $markdownReport -outFile "$($paths.o365)\$(Format-String -inputString $o.displayName)`.json"
                Format-Assignment -policy $o | Out-File $markdownReport -Encoding ascii -NoNewline -Append
            }
            "`n---`n" | Out-File $markdownReport -Encoding ascii -NoNewline -Append
        }
        #endregion
        #region Proactive Remediation Scripts
        if ($config.proactiveRemediation) {
            Write-Host "`rGenerating Report:" -NoNewline -ForegroundColor Yellow
            Write-Host " Remediation Scripts " -NoNewline -ForegroundColor Green
            "`n## Proactive Remediation Scripts`n" | Out-File $markdownReport -Encoding ascii -NoNewline -Append
            foreach ($s in $config.proactiveRemediation) {
                $displayName = $null
                $displayName = Format-String -inputString $s.displayName
                #store the script contents locally
                New-Item "$($paths.prScripts)\$displayName" -ItemType Directory -Force | Out-Null
                #TODO: finish this section
                [System.Text.Encoding]::ASCII.GetString([System.Convert]::FromBase64String("$($s.detectionScriptContent)")) |
                Out-File -FilePath "$($paths.prScripts)\$displayName\detection.ps1" -Encoding ascii -Force
                [System.Text.Encoding]::ASCII.GetString([System.Convert]::FromBase64String("$($s.remediationScriptContent)")) |
                Out-File -FilePath "$($paths.prScripts)\$displayName\remediation`.ps1" -Encoding ascii -Force

                $fpParam = @{
                    policy         = $($s | Select-Object * -ExcludeProperty detectionScriptContent,remediationScriptContent)
                    markdownReport = $markdownReport
                    outFile        = "$($paths.prScripts)\$displayName\$displayName`.json"
                }
                Format-Policy @fpParam
                Format-Assignment -policy $s | Out-File $markdownReport -Encoding ascii -NoNewline -Append
            }
            "`n---`n" | Out-File $markdownReport -Encoding ascii -NoNewline -Append
        }
        #endregion
        #region win32 Applications
        if ($config.win32Apps) {
            Write-Host "`rGenerating Report:" -NoNewline -ForegroundColor Yellow
            Write-Host " Win32 Applications " -NoNewline -ForegroundColor Green
            "`n## Win32 Applications`n" | Out-File $markdownReport -Encoding ascii -NoNewline -Append
            foreach ($a in $config.win32Apps) {
                Format-Policy -policy $a -markdownReport $markdownReport -outFile "$($paths.apps)\$(Format-String -inputString $a.displayName)`.json"
                Format-Assignment -policy $a | Out-File $markdownReport -Encoding ascii -NoNewline -Append
            }
            "`n---`n" | Out-File $markdownReport -Encoding ascii -NoNewline -Append
        }
        #endregion
    }
    catch {
        Write-Warning $_.Exception.Message
    }
    finally {
        if (Test-Path $markdownReport -ErrorAction SilentlyContinue) {
            Write-Host "`rReport Generated:" -NoNewline -ForegroundColor Green
            Write-Host " $markdownReport 🍻`n" -ForegroundColor Yellow
        }
    }
}