vibecoding/M365FoundationsCISReport
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: Update Help

Browse Source
This commit is contained in:
DrIOS
2024-06-24 19:15:15 -05:00
parent 0a92100bb6
commit 73bce280eb
3 changed files with 22 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
help/about_M365FoundationsCISReport.md
View File

@@ -16,23 +16,23 @@ The module includes functionality to synchronize audit results with CIS benchmar
# EXAMPLES # EXAMPLES
```powershell ```powershell
# Example 1: Exporting a security audit table to a CSV file # Example 1: Performing a security audit based on CIS benchmarks
Export-M365SecurityAuditTable -OutputPath "C:\AuditReports\SecurityAudit.csv" $auditResults = Invoke-M365SecurityAudit -TenantAdminUrl "https://contoso-admin.sharepoint.com"
# Example 2: Retrieving licenses for users in administrative roles # Example 2: Exporting a security audit table to a CSV file
Get-AdminRoleUserLicense -RoleName "Global Administrator" Export-M365SecurityAuditTable -ExportAllTests -AuditResults $auditResults -ExportPath "C:\temp" -ExportOriginalTests
# Example 3: Getting MFA status of users # Example 3: Retrieving licenses for users in administrative roles
Get-MFAStatus -UserPrincipalName "user@domain.com" Get-AdminRoleUserLicense
# Example 4: Performing a security audit based on CIS benchmarks # Example 4: Getting MFA status of users
Invoke-M365SecurityAudit -OutputPath "C:\AuditReports\AuditResults.xlsx" Get-MFAStatus -UserId "user@domain.com"
# Example 5: Removing rows with empty status values from a CSV file # 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 # 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 # NOTE

4
helpers/Build-Help.ps1
View File

@@ -37,6 +37,6 @@ $parameters = @{
LogPath = ".\log.txt" LogPath = ".\log.txt"
Encoding = [System.Text.Encoding]::UTF8 Encoding = [System.Text.Encoding]::UTF8
} }
Update-MarkdownHelpModule @parameters Update-MarkdownHelpModule @parameters -Force
Update-MarkdownHelpModule -Path ".\help" -RefreshModulePage Update-MarkdownHelpModule -Path ".\help" -RefreshModulePage -Force
New-ExternalHelp -Path ".\help" -OutputPath ".\source\en-US" -force New-ExternalHelp -Path ".\help" -OutputPath ".\source\en-US" -force

20
source/en-US/about_M365FoundationsCISReport.help.txt
View File

@@ -28,23 +28,23 @@ Optional Subtopics
is always up-to-date with the latest audit findings. is always up-to-date with the latest audit findings.
EXAMPLES EXAMPLES
# Example 1: Exporting a security audit table to a CSV file # Example 1: Performing a security audit based on CIS benchmarks
Export-M365SecurityAuditTable -OutputPath "C:\AuditReports\SecurityAudit.csv" $auditResults = Invoke-M365SecurityAudit -TenantAdminUrl "https://contoso-admin.sharepoint.com"
# Example 2: Retrieving licenses for users in administrative roles # Example 2: Exporting a security audit table to a CSV file
Get-AdminRoleUserLicense -RoleName "Global Administrator" Export-M365SecurityAuditTable -ExportAllTests -AuditResults $auditResults -ExportPath "C:\temp" -ExportOriginalTests
# Example 3: Getting MFA status of users # Example 3: Retrieving licenses for users in administrative roles
Get-MFAStatus -UserPrincipalName "user@domain.com" Get-AdminRoleUserLicense
# Example 4: Performing a security audit based on CIS benchmarks # Example 4: Getting MFA status of users
Invoke-M365SecurityAudit -OutputPath "C:\AuditReports\AuditResults.xlsx" Get-MFAStatus -UserId "user@domain.com"
# Example 5: Removing rows with empty status values from a CSV file # 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 # 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 NOTE
Ensure that you have the necessary permissions and administrative roles in Ensure that you have the necessary permissions and administrative roles in