From 73bce280ebd09429e2732859441c6dd3de703d26 Mon Sep 17 00:00:00 2001 From: DrIOS <58635327+DrIOSX@users.noreply.github.com> Date: Mon, 24 Jun 2024 19:15:15 -0500 Subject: [PATCH] docs: Update Help --- help/about_M365FoundationsCISReport.md | 20 +++++++++---------- helpers/Build-Help.ps1 | 4 ++-- .../about_M365FoundationsCISReport.help.txt | 20 +++++++++---------- 3 files changed, 22 insertions(+), 22 deletions(-) diff --git a/help/about_M365FoundationsCISReport.md b/help/about_M365FoundationsCISReport.md index 9cd1fed..6a2e671 100644 --- a/help/about_M365FoundationsCISReport.md +++ b/help/about_M365FoundationsCISReport.md @@ -16,23 +16,23 @@ The module includes functionality to synchronize audit results with CIS benchmar # EXAMPLES ```powershell -# Example 1: Exporting a security audit table to a CSV file -Export-M365SecurityAuditTable -OutputPath "C:\AuditReports\SecurityAudit.csv" +# Example 1: Performing a security audit based on CIS benchmarks +$auditResults = Invoke-M365SecurityAudit -TenantAdminUrl "https://contoso-admin.sharepoint.com" -# Example 2: Retrieving licenses for users in administrative roles -Get-AdminRoleUserLicense -RoleName "Global Administrator" +# Example 2: Exporting a security audit table to a CSV file +Export-M365SecurityAuditTable -ExportAllTests -AuditResults $auditResults -ExportPath "C:\temp" -ExportOriginalTests -# Example 3: Getting MFA status of users -Get-MFAStatus -UserPrincipalName "user@domain.com" +# Example 3: Retrieving licenses for users in administrative roles +Get-AdminRoleUserLicense -# Example 4: Performing a security audit based on CIS benchmarks -Invoke-M365SecurityAudit -OutputPath "C:\AuditReports\AuditResults.xlsx" +# Example 4: Getting MFA status of users +Get-MFAStatus -UserId "user@domain.com" # Example 5: Removing rows with empty status values from a CSV file -Remove-RowsWithEmptyCSVStatus -InputPath "C:\AuditReports\AuditResults.csv" -OutputPath "C:\AuditReports\CleanedResults.csv" +Remove-RowsWithEmptyCSVStatus -FilePath "C:\Reports\Report.xlsx" -WorksheetName "Sheet1" # Example 6: Synchronizing CIS benchmark data with audit results -Sync-CISExcelAndCsvData -ExcelPath "C:\CISBenchmarks\CISBenchmark.xlsx" -CsvPath "C:\AuditReports\AuditResults.csv" +Sync-CISExcelAndCsvData -ExcelPath "path\to\excel.xlsx" -CsvPath "path\to\data.csv" -SheetName "Combined Profiles" ``` # NOTE diff --git a/helpers/Build-Help.ps1 b/helpers/Build-Help.ps1 index c0d4383..ef68208 100644 --- a/helpers/Build-Help.ps1 +++ b/helpers/Build-Help.ps1 @@ -37,6 +37,6 @@ $parameters = @{ LogPath = ".\log.txt" Encoding = [System.Text.Encoding]::UTF8 } -Update-MarkdownHelpModule @parameters -Update-MarkdownHelpModule -Path ".\help" -RefreshModulePage +Update-MarkdownHelpModule @parameters -Force +Update-MarkdownHelpModule -Path ".\help" -RefreshModulePage -Force New-ExternalHelp -Path ".\help" -OutputPath ".\source\en-US" -force \ No newline at end of file diff --git a/source/en-US/about_M365FoundationsCISReport.help.txt b/source/en-US/about_M365FoundationsCISReport.help.txt index a2c3532..2dc01a1 100644 --- a/source/en-US/about_M365FoundationsCISReport.help.txt +++ b/source/en-US/about_M365FoundationsCISReport.help.txt @@ -28,23 +28,23 @@ Optional Subtopics is always up-to-date with the latest audit findings. EXAMPLES - # Example 1: Exporting a security audit table to a CSV file - Export-M365SecurityAuditTable -OutputPath "C:\AuditReports\SecurityAudit.csv" + # Example 1: Performing a security audit based on CIS benchmarks + $auditResults = Invoke-M365SecurityAudit -TenantAdminUrl "https://contoso-admin.sharepoint.com" - # Example 2: Retrieving licenses for users in administrative roles - Get-AdminRoleUserLicense -RoleName "Global Administrator" + # Example 2: Exporting a security audit table to a CSV file + Export-M365SecurityAuditTable -ExportAllTests -AuditResults $auditResults -ExportPath "C:\temp" -ExportOriginalTests - # Example 3: Getting MFA status of users - Get-MFAStatus -UserPrincipalName "user@domain.com" + # Example 3: Retrieving licenses for users in administrative roles + Get-AdminRoleUserLicense - # Example 4: Performing a security audit based on CIS benchmarks - Invoke-M365SecurityAudit -OutputPath "C:\AuditReports\AuditResults.xlsx" + # Example 4: Getting MFA status of users + Get-MFAStatus -UserId "user@domain.com" # Example 5: Removing rows with empty status values from a CSV file - Remove-RowsWithEmptyCSVStatus -InputPath "C:\AuditReports\AuditResults.csv" -OutputPath "C:\AuditReports\CleanedResults.csv" + Remove-RowsWithEmptyCSVStatus -FilePath "C:\Reports\Report.xlsx" -WorksheetName "Sheet1" # Example 6: Synchronizing CIS benchmark data with audit results - Sync-CISExcelAndCsvData -ExcelPath "C:\CISBenchmarks\CISBenchmark.xlsx" -CsvPath "C:\AuditReports\AuditResults.csv" + Sync-CISExcelAndCsvData -ExcelPath "path\to\excel.xlsx" -CsvPath "path\to\data.csv" -SheetName "Combined Profiles" NOTE Ensure that you have the necessary permissions and administrative roles in