M365FoundationsCISReport

Export-M365SecurityAuditTable

Exports Microsoft 365 security audit results to CSV or Excel files and supports outputting specific test results as objects.

The Export-M365SecurityAuditTable function exports Microsoft 365 security audit results from an array of CISAuditResult objects or a CSV file.
It can export all results to a specified path, output a specific test result as an object, and includes options for exporting results to Excel.
Additionally, it computes hashes for the exported files and includes them in the zip archive for verification purposes.

Syntax 

Export-M365SecurityAuditTable [-AuditResults] <CISAuditResult[]> [-OutputTestNumber] <String> [<CommonParameters>]

Export-M365SecurityAuditTable [-AuditResults] <CISAuditResult[]> [[-ExportAllTests]] -ExportPath <String> -ExportOriginalTests [-ExportToExcel] [<CommonParameters>]

Export-M365SecurityAuditTable [-CsvPath] <String> [-OutputTestNumber] <String> [<CommonParameters>]

Export-M365SecurityAuditTable [-CsvPath] <String> [[-ExportAllTests]] -ExportPath <String> -ExportOriginalTests [-ExportToExcel] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-AuditResults An array of CISAuditResult objects containing the audit results. This parameter is mandatory when exporting from audit results. true false
-CsvPath The path to a CSV file containing the audit results. This parameter is mandatory when exporting from a CSV file. true false
-OutputTestNumber The test number to output as an object. Valid values are "1.1.1", "1.3.1", "6.1.2", "6.1.3", "7.3.4". This parameter is used to output a specific test result. true false
-ExportAllTests Switch to export all test results. When specified, all test results are exported to the specified path. false false False
-ExportPath The path where the CSV or Excel files will be exported. This parameter is mandatory when exporting all tests. true false
-ExportOriginalTests Switch to export the original audit results to a CSV file. When specified, the original test results are exported along with the processed results. true false False
-ExportToExcel Switch to export the results to an Excel file. When specified, results are exported in Excel format. false false False

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • [CISAuditResult[]] - An array of CISAuditResult objects. [string] - A path to a CSV file.

Outputs

The output type is the type of the objects that the cmdlet emits.

  • [PSCustomObject] - A custom object containing the path to the zip file and its hash.

Examples

EXAMPLE 1 
Export-M365SecurityAuditTable -AuditResults $object -OutputTestNumber 6.1.2
# Outputs the result of test number 6.1.2 from the provided audit results as an object.
EXAMPLE 2 
Export-M365SecurityAuditTable -ExportAllTests -AuditResults $object -ExportPath "C:\temp"
# Exports all audit results to the specified path in CSV format.
EXAMPLE 3 
Export-M365SecurityAuditTable -CsvPath "C:\temp\auditresultstoday1.csv" -OutputTestNumber 6.1.2
# Outputs the result of test number 6.1.2 from the CSV file as an object.
EXAMPLE 4 
Export-M365SecurityAuditTable -ExportAllTests -CsvPath "C:\temp\auditresultstoday1.csv" -ExportPath "C:\temp"
# Exports all audit results from the CSV file to the specified path in CSV format.
EXAMPLE 5 
Export-M365SecurityAuditTable -ExportAllTests -AuditResults $object -ExportPath "C:\temp" -ExportOriginalTests
# Exports all audit results along with the original test results to the specified path in CSV format.
EXAMPLE 6 
Export-M365SecurityAuditTable -ExportAllTests -CsvPath "C:\temp\auditresultstoday1.csv" -ExportPath "C:\temp" -ExportOriginalTests
# Exports all audit results from the CSV file along with the original test results to the specified path in CSV format.
EXAMPLE 7 
Export-M365SecurityAuditTable -ExportAllTests -AuditResults $object -ExportPath "C:\temp" -ExportToExcel
# Exports all audit results to the specified path in Excel format.

Top of page

Links

Get-AdminRoleUserLicense

Retrieves user licenses and roles for administrative accounts from Microsoft 365 via the Graph API.

The Get-AdminRoleUserLicense function connects to Microsoft Graph and retrieves all users who are assigned administrative roles along with their user details and licenses. This function is useful for auditing and compliance checks to ensure that
administrators have appropriate licenses and role assignments.

Syntax 

Get-AdminRoleUserLicense [-SkipGraphConnection] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-SkipGraphConnection A switch parameter that, when set, skips the connection to Microsoft Graph if already established. This is useful for batch processing or when used within scripts where multiple calls are made and the connection is managed externally. false false False

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • None. You cannot pipe objects to Get-AdminRoleUserLicense.

Outputs

The output type is the type of the objects that the cmdlet emits.

  • PSCustomObject Returns a custom object for each user with administrative roles that includes the following properties: RoleName, UserName, UserPrincipalName, UserId, HybridUser, and Licenses.

Note

Creation Date: 2024-04-15 Purpose/Change: Initial function development to support Microsoft 365 administrative role auditing.

Examples

EXAMPLE 1 
Get-AdminRoleUserLicense
This example retrieves all administrative role users along with their licenses by connecting to Microsoft Graph using the default scopes.
EXAMPLE 2 
Get-AdminRoleUserLicense -SkipGraphConnection
This example retrieves all administrative role users along with their licenses without attempting to connect to Microsoft Graph, assuming that the connection is already established.

Top of page

Links

Get-MFAStatus

Retrieves the MFA (Multi-Factor Authentication) status for Azure Active Directory users.

The Get-MFAStatus function connects to Microsoft Online Service and retrieves the MFA status for all Azure Active Directory users, excluding guest accounts. Optionally, you can specify a single user by their User Principal Name (UPN) to get their MFA status.

Syntax 

Get-MFAStatus [[-UserId] <String>] [-SkipMSOLConnectionChecks] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-UserId The User Principal Name (UPN) of a specific user to retrieve MFA status for. If not provided, the function retrieves MFA status for all users. false false
-SkipMSOLConnectionChecks false false False

Outputs

The output type is the type of the objects that the cmdlet emits.

  • System.Object Returns a sorted list of custom objects containing the following properties: - UserPrincipalName - DisplayName - MFAState - MFADefaultMethod - MFAPhoneNumber - PrimarySMTP - Aliases

Note

The function requires the MSOL module to be installed and connected to your tenant. Ensure that you have the necessary permissions to read user and MFA status information.

Examples

EXAMPLE 1 
Get-MFAStatus
Retrieves the MFA status for all Azure Active Directory users.
EXAMPLE 2 
Get-MFAStatus -UserId "example@domain.com"
Retrieves the MFA status for the specified user with the UPN "example@domain.com".

Top of page

Links

Grant-M365SecurityAuditConsent

Grants Microsoft Graph permissions for an auditor.

This function grants the specified Microsoft Graph permissions to a user, allowing the user to perform audits. It connects to Microsoft Graph, checks if a service principal exists for the client application, creates it if it does not exist, and then grants
the specified permissions. Finally, it assigns the app to the user.

Syntax 

Grant-M365SecurityAuditConsent [-UserPrincipalNameForConsent] <String> [-SkipGraphConnection] [-SkipModuleCheck] [-SuppressRevertOutput] [-DoNotDisconnect] [-WhatIf] [-Confirm] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-UserPrincipalNameForConsent The UPN or ID of the user to grant consent for. true true (ByValue, ByPropertyName)
-SkipGraphConnection If specified, skips connecting to Microsoft Graph. false false False
-SkipModuleCheck If specified, skips the check for the Microsoft.Graph module. false false False
-SuppressRevertOutput If specified, suppresses the output of the revert commands. false false False
-DoNotDisconnect If specified, does not disconnect from Microsoft Graph after granting consent. false false False
-WhatIf wi false false
-Confirm cf false false

Outputs

The output type is the type of the objects that the cmdlet emits.

  • System.Void

Note

This function requires the Microsoft.Graph module version 2.4.0 or higher.

Examples

EXAMPLE 1 
Grant-M365SecurityAuditConsent -UserPrincipalNameForConsent user@example.com
Grants Microsoft Graph permissions to user@example.com for the client application with the specified Application ID.
EXAMPLE 2 
Grant-M365SecurityAuditConsent -UserPrincipalNameForConsent user@example.com -SkipGraphConnection
Grants Microsoft Graph permissions to user@example.com, skipping the connection to Microsoft Graph.

Top of page

Links

Invoke-M365SecurityAudit

Invokes a security audit for Microsoft 365 environments.

The Invoke-M365SecurityAudit cmdlet performs a comprehensive security audit based on the specified parameters. It allows auditing of various configurations and settings within a Microsoft 365 environment, such as compliance with CIS benchmarks.

Syntax 

Invoke-M365SecurityAudit [-TenantAdminUrl <String>] [-DomainName <String>] [-ApprovedCloudStorageProviders <String[]>] [-ApprovedFederatedDomains <String[]>] [-DoNotConnect] [-DoNotDisconnect] [-NoModuleCheck] [-DoNotConfirmConnections] [-WhatIf] [-Confirm] 
[<CommonParameters>]

Invoke-M365SecurityAudit [-TenantAdminUrl <String>] [-DomainName <String>] -ELevel <String> -ProfileLevel <String> [-ApprovedCloudStorageProviders <String[]>] [-ApprovedFederatedDomains <String[]>] [-DoNotConnect] [-DoNotDisconnect] [-NoModuleCheck] 
[-DoNotConfirmConnections] [-WhatIf] [-Confirm] [<CommonParameters>]

Invoke-M365SecurityAudit [-TenantAdminUrl <String>] [-DomainName <String>] -IncludeIG1 [-ApprovedCloudStorageProviders <String[]>] [-ApprovedFederatedDomains <String[]>] [-DoNotConnect] [-DoNotDisconnect] [-NoModuleCheck] [-DoNotConfirmConnections] 
[-WhatIf] [-Confirm] [<CommonParameters>]

Invoke-M365SecurityAudit [-TenantAdminUrl <String>] [-DomainName <String>] -IncludeIG2 [-ApprovedCloudStorageProviders <String[]>] [-ApprovedFederatedDomains <String[]>] [-DoNotConnect] [-DoNotDisconnect] [-NoModuleCheck] [-DoNotConfirmConnections] 
[-WhatIf] [-Confirm] [<CommonParameters>]

Invoke-M365SecurityAudit [-TenantAdminUrl <String>] [-DomainName <String>] -IncludeIG3 [-ApprovedCloudStorageProviders <String[]>] [-ApprovedFederatedDomains <String[]>] [-DoNotConnect] [-DoNotDisconnect] [-NoModuleCheck] [-DoNotConfirmConnections] 
[-WhatIf] [-Confirm] [<CommonParameters>]

Invoke-M365SecurityAudit [-TenantAdminUrl <String>] [-DomainName <String>] -IncludeRecommendation <String[]> [-ApprovedCloudStorageProviders <String[]>] [-ApprovedFederatedDomains <String[]>] [-DoNotConnect] [-DoNotDisconnect] [-NoModuleCheck] 
[-DoNotConfirmConnections] [-WhatIf] [-Confirm] [<CommonParameters>]

Invoke-M365SecurityAudit [-TenantAdminUrl <String>] [-DomainName <String>] -SkipRecommendation <String[]> [-ApprovedCloudStorageProviders <String[]>] [-ApprovedFederatedDomains <String[]>] [-DoNotConnect] [-DoNotDisconnect] [-NoModuleCheck] 
[-DoNotConfirmConnections] [-WhatIf] [-Confirm] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-TenantAdminUrl The URL of the tenant admin. If not specified, none of the SharePoint Online tests will run. false false
-DomainName The domain name of the Microsoft 365 environment to test. This parameter is not mandatory and by default it will pass/fail all found domains as a group if a specific domain is not specified. false false
-ELevel Specifies the E-Level (E3 or E5) for the audit. This parameter is optional and can be combined with the ProfileLevel parameter. true false
-ProfileLevel Specifies the profile level (L1 or L2) for the audit. This parameter is optional and can be combined with the ELevel parameter. true false
-IncludeIG1 If specified, includes tests where IG1 is true. true false False
-IncludeIG2 If specified, includes tests where IG2 is true. true false False
-IncludeIG3 If specified, includes tests where IG3 is true. true false False
-IncludeRecommendation Specifies specific recommendations to include in the audit. Accepts an array of recommendation numbers. true false
-SkipRecommendation Specifies specific recommendations to exclude from the audit. Accepts an array of recommendation numbers. true false
-ApprovedCloudStorageProviders Specifies the approved cloud storage providers for the audit. Accepts an array of cloud storage provider names. false false @()
-ApprovedFederatedDomains Specifies the approved federated domains for the audit test 8.2.1. Accepts an array of allowed domain names. false false
-DoNotConnect If specified, the cmdlet will not establish a connection to Microsoft 365 services. false false False
-DoNotDisconnect If specified, the cmdlet will not disconnect from Microsoft 365 services after execution. false false False
-NoModuleCheck If specified, the cmdlet will not check for the presence of required modules. false false False
-DoNotConfirmConnections If specified, the cmdlet will not prompt for confirmation before proceeding with established connections and will disconnect from all of them. false false False
-WhatIf wi false false
-Confirm cf false false

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • None. You cannot pipe objects to Invoke-M365SecurityAudit.

Outputs

The output type is the type of the objects that the cmdlet emits.

  • CISAuditResult[] The cmdlet returns an array of CISAuditResult objects representing the results of the security audit.

Note

- This module is based on CIS benchmarks. - Governed by the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License. - Commercial use is not permitted. This module cannot be sold or used for commercial purposes. - Modifications and sharing are allowed under the same license. - For full license details, visit: https://creativecommons.org/licenses/by-nc-sa/4.0/deed.en - Register for CIS Benchmarks at: https://www.cisecurity.org/cis-benchmarks

Examples

EXAMPLE 1 
Invoke-M365SecurityAudit
Performs a security audit using default parameters. Output: Status : Fail ELevel : E3 ProfileLevel: L1 Connection : Microsoft Graph Rec : 1.1.1 Result : False Details : Non-compliant accounts: Username | Roles | HybridStatus | Missing Licence user1@domain.com| Global Administrator | Cloud-Only | AAD_PREMIUM user2@domain.com| Global Administrator | Hybrid | AAD_PREMIUM, AAD_PREMIUM_P2 FailureReason: Non-Compliant Accounts: 2
EXAMPLE 2 
Invoke-M365SecurityAudit -TenantAdminUrl "https://contoso-admin.sharepoint.com" -DomainName "contoso.com" -ELevel "E5" -ProfileLevel "L1"
Performs a security audit for the E5 level and L1 profile in the specified Microsoft 365 environment. Output: Status : Fail ELevel : E5 ProfileLevel: L1 Connection : Microsoft Graph Rec : 1.1.1 Result : False Details : Non-compliant accounts: Username | Roles | HybridStatus | Missing Licence user1@domain.com| Global Administrator | Cloud-Only | AAD_PREMIUM user2@domain.com| Global Administrator | Hybrid | AAD_PREMIUM, AAD_PREMIUM_P2 FailureReason: Non-Compliant Accounts: 2
EXAMPLE 3 
Invoke-M365SecurityAudit -TenantAdminUrl "https://contoso-admin.sharepoint.com" -DomainName "contoso.com" -IncludeIG1
Performs an audit including all tests where IG1 is true. Output: Status : Fail ELevel : E3 ProfileLevel: L1 Connection : Microsoft Graph Rec : 1.1.1 Result : False Details : Non-compliant accounts: Username | Roles | HybridStatus | Missing Licence user1@domain.com| Global Administrator | Cloud-Only | AAD_PREMIUM user2@domain.com| Global Administrator | Hybrid | AAD_PREMIUM, AAD_PREMIUM_P2 FailureReason: Non-Compliant Accounts: 2
EXAMPLE 4 
Invoke-M365SecurityAudit -TenantAdminUrl "https://contoso-admin.sharepoint.com" -DomainName "contoso.com" -SkipRecommendation '1.1.3', '2.1.1'
Performs an audit while excluding specific recommendations 1.1.3 and 2.1.1. Output: Status : Fail ELevel : E3 ProfileLevel: L1 Connection : Microsoft Graph Rec : 1.1.1 Result : False Details : Non-compliant accounts: Username | Roles | HybridStatus | Missing Licence user1@domain.com| Global Administrator | Cloud-Only | AAD_PREMIUM user2@domain.com| Global Administrator | Hybrid | AAD_PREMIUM, AAD_PREMIUM_P2 FailureReason: Non-Compliant Accounts: 2
EXAMPLE 5 
$auditResults = Invoke-M365SecurityAudit -TenantAdminUrl "https://contoso-admin.sharepoint.com" -DomainName "contoso.com"
PS> $auditResults | Export-Csv -Path "auditResults.csv" -NoTypeInformation Captures the audit results into a variable and exports them to a CSV file. Output: CISAuditResult[] auditResults.csv
EXAMPLE 6 
Invoke-M365SecurityAudit -WhatIf
Displays what would happen if the cmdlet is run without actually performing the audit. Output: What if: Performing the operation "Invoke-M365SecurityAudit" on target "Microsoft 365 environment".

Top of page

Links

Remove-RowsWithEmptyCSVStatus

Removes rows from an Excel worksheet where the 'CSV_Status' column is empty and saves the result to a new file.

The Remove-RowsWithEmptyCSVStatus function imports data from a specified worksheet in an Excel file, checks for the presence of the 'CSV_Status' column, and filters out rows where the 'CSV_Status' column is empty. The filtered data is then exported to a new
Excel file with a '-Filtered' suffix added to the original file name.

Syntax 

Remove-RowsWithEmptyCSVStatus [-FilePath] <String> [-WorksheetName] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-FilePath The path to the Excel file to be processed. true false
-WorksheetName The name of the worksheet within the Excel file to be processed. true false

Note

This function requires the ImportExcel module to be installed.

Examples

EXAMPLE 1 
Remove-RowsWithEmptyCSVStatus -FilePath "C:\Reports\Report.xlsx" -WorksheetName "Sheet1"
This command imports data from the "Sheet1" worksheet in the "Report.xlsx" file, removes rows where the 'CSV_Status' column is empty, and saves the filtered data to a new file named "Report-Filtered.xlsx" in the same directory.

Top of page

Sync-CISExcelAndCsvData

Synchronizes and updates data in an Excel worksheet with new information from a CSV file, including audit dates.

The Sync-CISExcelAndCsvData function merges and updates data in a specified Excel worksheet from a CSV file. This includes adding or updating fields for connection status, details, failure reasons, and the date of the update. It's designed to ensure that
the Excel document maintains a running log of changes over time, ideal for tracking remediation status and audit history.

Syntax 

Sync-CISExcelAndCsvData [[-ExcelPath] <String>] [[-CsvPath] <String>] [[-SheetName] <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-ExcelPath Specifies the path to the Excel file to be updated. This parameter is mandatory. false false
-CsvPath Specifies the path to the CSV file containing new data. This parameter is mandatory. false false
-SheetName Specifies the name of the worksheet in the Excel file where data will be merged and updated. This parameter is mandatory. false false

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • System.String The function accepts strings for file paths and worksheet names.

Outputs

The output type is the type of the objects that the cmdlet emits.

  • None The function directly updates the Excel file and does not output any objects.

Note

- Ensure that the 'ImportExcel' module is installed and up to date to handle Excel file manipulations. - It is recommended to back up the Excel file before running this function to avoid accidental data loss. - The CSV file should have columns that match expected headers like 'Connection', 'Details', 'FailureReason', and 'Status' for correct data mapping.

Examples

EXAMPLE 1 
Sync-CISExcelAndCsvData -ExcelPath "path\to\excel.xlsx" -CsvPath "path\to\data.csv" -SheetName "AuditData"
Updates the 'AuditData' worksheet in 'excel.xlsx' with data from 'data.csv', adding new information and the date of the update.

Top of page

Links