functions/public/Test-365ACState.ps1
|
<# .SYNOPSIS Tests if users have a state assigned in their Microsoft 365 profiles. .DESCRIPTION The Test-365ACState function checks each user retrieved from Microsoft 365 for a state value. It processes a list of users, determining whether each user has a state assigned. The results can be exported to an Excel file, an HTML file, or output directly. .PARAMETER Users An array of users to be tested. This can be piped in or specified directly. Each user should have DisplayName and State properties. .PARAMETER OutputExcelFilePath The file path where the Excel report will be saved. The file must have an .xlsx extension. .PARAMETER HtmlFilePath The file path where the HTML report will be saved. The file must have an .html extension. .PARAMETER TestedProperty The property being tested. This is set to 'Has State' by default. .EXAMPLE PS> $users = Get-MgUser -All -Property DisplayName, State | Select-Object DisplayName, State PS> Test-365ACState -Users $users -OutputExcelFilePath "C:\Reports\StateReport.xlsx" This example retrieves all users with their DisplayName and State, then tests each user to see if they have a state assigned. The results are exported to an Excel file. .EXAMPLE PS> Get-MgUser -All -Property DisplayName, State | Select-Object DisplayName, State | Test-365ACState -HtmlFilePath "C:\Reports\StateReport.html" This example pipes a list of users directly into Test-365ACState, which then checks if each user has a state assigned. The results are exported to an HTML file. .NOTES This function requires the Microsoft Graph PowerShell SDK to retrieve user information from Microsoft 365. .LINK https://docs.microsoft.com/powershell/module/microsoft.graph.users/get-mguser #> Function Test-365ACState { [CmdletBinding()] param ( [Parameter(ValueFromPipeline = $true)] [array]$Users = (Get-MgUser -All -Property DisplayName, State | Select-Object DisplayName, State), [ValidatePattern('\.xlsx$')] [string]$OutputExcelFilePath, [ValidatePattern('\.html$')] [string]$HtmlFilePath, [string]$TestedProperty = 'Has State' ) BEGIN { $results = @() } PROCESS { foreach ($user in $Users) { $hasState = [bool]($user.State) $result = [PSCustomObject]@{ 'User Display Name' = $user.DisplayName $TestedProperty = $hasState } $results += $result } } END { $totalTests = $results.Count $passedTests = ($results | Where-Object { $_.$TestedProperty }).Count $failedTests = $totalTests - $passedTests if ($OutputExcelFilePath) { Export-365ACResultToExcel -Results $results -OutputExcelFilePath $OutputExcelFilePath -TotalTests $totalTests -PassedTests $passedTests -FailedTests $failedTests -TestedProperty $TestedProperty } elseif ($HtmlFilePath) { Export-365ACResultToHtml -Results $results -HtmlFilePath $HtmlFilePath -TotalTests $totalTests -PassedTests $passedTests -FailedTests $failedTests -TestedProperty $TestedProperty } else { Write-Output $results } } } |