From 5f4df00ceaa746288ab4d54fa126717bdddd3037 Mon Sep 17 00:00:00 2001 From: DrIOS <58635327+DrIOSX@users.noreply.github.com> Date: Sat, 29 Jun 2024 20:05:04 -0500 Subject: [PATCH] docs: Update Help/WikiFiles --- help/Export-M365SecurityAuditTable.md | 90 +- help/Get-AdminRoleUserLicense.md | 17 +- help/Get-MFAStatus.md | 32 +- help/Grant-M365SecurityAuditConsent.md | 68 +- help/Invoke-M365SecurityAudit.md | 194 ++- help/M365FoundationsCISReport.md | 5 +- help/Remove-RowsWithEmptyCSVStatus.md | 18 +- help/Sync-CISExcelAndCsvData.md | 31 +- .../en-US/M365FoundationsCISReport-help.xml | 1356 +++++++---------- 9 files changed, 718 insertions(+), 1093 deletions(-) diff --git a/help/Export-M365SecurityAuditTable.md b/help/Export-M365SecurityAuditTable.md index a2a7ba0..858ea30 100644 --- a/help/Export-M365SecurityAuditTable.md +++ b/help/Export-M365SecurityAuditTable.md @@ -1,4 +1,4 @@ ---- +--- external help file: M365FoundationsCISReport-help.xml Module Name: M365FoundationsCISReport online version: https://criticalsolutionsnetwork.github.io/M365FoundationsCISReport/#Export-M365SecurityAuditTable @@ -15,25 +15,24 @@ Exports M365 security audit results to a CSV file or outputs a specific test res ### OutputObjectFromAuditResultsSingle ``` Export-M365SecurityAuditTable [-AuditResults] [-OutputTestNumber] - [-ProgressAction ] [] + [] ``` ### ExportAllResultsFromAuditResults ``` Export-M365SecurityAuditTable [-AuditResults] [-ExportAllTests] -ExportPath - [-ExportOriginalTests] [-ExportToExcel] [-ProgressAction ] [] + [-ExportOriginalTests] [-ExportToExcel] [] ``` ### OutputObjectFromCsvSingle ``` -Export-M365SecurityAuditTable [-CsvPath] [-OutputTestNumber] - [-ProgressAction ] [] +Export-M365SecurityAuditTable [-CsvPath] [-OutputTestNumber] [] ``` ### ExportAllResultsFromCsv ``` Export-M365SecurityAuditTable [-CsvPath] [-ExportAllTests] -ExportPath [-ExportOriginalTests] - [-ExportToExcel] [-ProgressAction ] [] + [-ExportToExcel] [] ``` ## DESCRIPTION @@ -110,6 +109,22 @@ Accept pipeline input: False Accept wildcard characters: 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". + +```yaml +Type: String +Parameter Sets: OutputObjectFromAuditResultsSingle, OutputObjectFromCsvSingle +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ExportAllTests Switch to export all test results. @@ -118,23 +133,8 @@ Type: SwitchParameter Parameter Sets: ExportAllResultsFromAuditResults, ExportAllResultsFromCsv Aliases: -Required: True -Position: 1 -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExportOriginalTests -Switch to export the original audit results to a CSV file. - -```yaml -Type: SwitchParameter -Parameter Sets: ExportAllResultsFromAuditResults, ExportAllResultsFromCsv -Aliases: - Required: False -Position: Named +Position: 1 Default value: False Accept pipeline input: False Accept wildcard characters: False @@ -155,6 +155,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ExportOriginalTests +Switch to export the original audit results to a CSV file. + +```yaml +Type: SwitchParameter +Parameter Sets: ExportAllResultsFromAuditResults, ExportAllResultsFromCsv +Aliases: + +Required: True +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ExportToExcel Switch to export the results to an Excel file. @@ -170,37 +185,6 @@ Accept pipeline input: False Accept wildcard characters: 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". - -```yaml -Type: String -Parameter Sets: OutputObjectFromAuditResultsSingle, OutputObjectFromCsvSingle -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/help/Get-AdminRoleUserLicense.md b/help/Get-AdminRoleUserLicense.md index 22625bb..0100860 100644 --- a/help/Get-AdminRoleUserLicense.md +++ b/help/Get-AdminRoleUserLicense.md @@ -13,7 +13,7 @@ Retrieves user licenses and roles for administrative accounts from Microsoft 365 ## SYNTAX ``` -Get-AdminRoleUserLicense [-SkipGraphConnection] [-ProgressAction ] [] +Get-AdminRoleUserLicense [-SkipGraphConnection] [] ``` ## DESCRIPTION @@ -38,21 +38,6 @@ This example retrieves all administrative role users along with their licenses w ## PARAMETERS -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -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. diff --git a/help/Get-MFAStatus.md b/help/Get-MFAStatus.md index 9e9b878..c64235b 100644 --- a/help/Get-MFAStatus.md +++ b/help/Get-MFAStatus.md @@ -1,4 +1,4 @@ ---- +--- external help file: M365FoundationsCISReport-help.xml Module Name: M365FoundationsCISReport online version: https://criticalsolutionsnetwork.github.io/M365FoundationsCISReport/#Get-MFAStatus @@ -13,8 +13,7 @@ Retrieves the MFA (Multi-Factor Authentication) status for Azure Active Director ## SYNTAX ``` -Get-MFAStatus [[-UserId] ] [-SkipMSOLConnectionChecks] [-ProgressAction ] - [] +Get-MFAStatus [[-UserId] ] [-SkipMSOLConnectionChecks] [] ``` ## DESCRIPTION @@ -37,16 +36,17 @@ Retrieves the MFA status for the specified user with the UPN "example@domain.com ## PARAMETERS -### -ProgressAction -{{ Fill ProgressAction Description }} +### -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. ```yaml -Type: ActionPreference +Type: String Parameter Sets: (All) -Aliases: proga +Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -67,22 +67,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -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. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/help/Grant-M365SecurityAuditConsent.md b/help/Grant-M365SecurityAuditConsent.md index e2c864c..c5c5564 100644 --- a/help/Grant-M365SecurityAuditConsent.md +++ b/help/Grant-M365SecurityAuditConsent.md @@ -14,8 +14,7 @@ Grants Microsoft Graph permissions for an auditor. ``` Grant-M365SecurityAuditConsent [-UserPrincipalNameForConsent] [-SkipGraphConnection] - [-SkipModuleCheck] [-SuppressRevertOutput] [-DoNotDisconnect] [-ProgressAction ] [-WhatIf] - [-Confirm] [] + [-SkipModuleCheck] [-SuppressRevertOutput] [-DoNotDisconnect] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -41,33 +40,18 @@ Grants Microsoft Graph permissions to user@example.com, skipping the connection ## PARAMETERS -### -DoNotDisconnect -If specified, does not disconnect from Microsoft Graph after granting consent. +### -UserPrincipalNameForConsent +Specify the UPN of the user to grant consent for. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named +Required: True +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` @@ -116,32 +100,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UserPrincipalNameForConsent -Specify the UPN of the user to grant consent for. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -DoNotDisconnect +If specified, does not disconnect from Microsoft Graph after granting consent. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -162,6 +131,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/help/Invoke-M365SecurityAudit.md b/help/Invoke-M365SecurityAudit.md index 706ab6f..21ad90a 100644 --- a/help/Invoke-M365SecurityAudit.md +++ b/help/Invoke-M365SecurityAudit.md @@ -1,4 +1,4 @@ ---- +--- external help file: M365FoundationsCISReport-help.xml Module Name: M365FoundationsCISReport online version: https://criticalsolutionsnetwork.github.io/M365FoundationsCISReport/#Invoke-M365SecurityAudit @@ -14,51 +14,47 @@ Invokes a security audit for Microsoft 365 environments. ### Default (Default) ``` -Invoke-M365SecurityAudit [-TenantAdminUrl ] [-M365DomainForPWPolicyTest ] [-DoNotConnect] - [-DoNotDisconnect] [-NoModuleCheck] [-DoNotConfirmConnections] [-ProgressAction ] [-WhatIf] - [-Confirm] [] +Invoke-M365SecurityAudit [-TenantAdminUrl ] [-DomainName ] [-DoNotConnect] [-DoNotDisconnect] + [-NoModuleCheck] [-DoNotConfirmConnections] [-WhatIf] [-Confirm] [] ``` ### ELevelFilter ``` -Invoke-M365SecurityAudit [-TenantAdminUrl ] [-M365DomainForPWPolicyTest ] -ELevel +Invoke-M365SecurityAudit [-TenantAdminUrl ] [-DomainName ] -ELevel -ProfileLevel [-DoNotConnect] [-DoNotDisconnect] [-NoModuleCheck] [-DoNotConfirmConnections] - [-ProgressAction ] [-WhatIf] [-Confirm] [] + [-WhatIf] [-Confirm] [] ``` ### IG1Filter ``` -Invoke-M365SecurityAudit [-TenantAdminUrl ] [-M365DomainForPWPolicyTest ] [-IncludeIG1] - [-DoNotConnect] [-DoNotDisconnect] [-NoModuleCheck] [-DoNotConfirmConnections] - [-ProgressAction ] [-WhatIf] [-Confirm] [] +Invoke-M365SecurityAudit [-TenantAdminUrl ] [-DomainName ] [-IncludeIG1] [-DoNotConnect] + [-DoNotDisconnect] [-NoModuleCheck] [-DoNotConfirmConnections] [-WhatIf] [-Confirm] [] ``` ### IG2Filter ``` -Invoke-M365SecurityAudit [-TenantAdminUrl ] [-M365DomainForPWPolicyTest ] [-IncludeIG2] - [-DoNotConnect] [-DoNotDisconnect] [-NoModuleCheck] [-DoNotConfirmConnections] - [-ProgressAction ] [-WhatIf] [-Confirm] [] +Invoke-M365SecurityAudit [-TenantAdminUrl ] [-DomainName ] [-IncludeIG2] [-DoNotConnect] + [-DoNotDisconnect] [-NoModuleCheck] [-DoNotConfirmConnections] [-WhatIf] [-Confirm] [] ``` ### IG3Filter ``` -Invoke-M365SecurityAudit [-TenantAdminUrl ] [-M365DomainForPWPolicyTest ] [-IncludeIG3] - [-DoNotConnect] [-DoNotDisconnect] [-NoModuleCheck] [-DoNotConfirmConnections] - [-ProgressAction ] [-WhatIf] [-Confirm] [] +Invoke-M365SecurityAudit [-TenantAdminUrl ] [-DomainName ] [-IncludeIG3] [-DoNotConnect] + [-DoNotDisconnect] [-NoModuleCheck] [-DoNotConfirmConnections] [-WhatIf] [-Confirm] [] ``` ### RecFilter ``` -Invoke-M365SecurityAudit [-TenantAdminUrl ] [-M365DomainForPWPolicyTest ] - -IncludeRecommendation [-DoNotConnect] [-DoNotDisconnect] [-NoModuleCheck] - [-DoNotConfirmConnections] [-ProgressAction ] [-WhatIf] [-Confirm] [] +Invoke-M365SecurityAudit [-TenantAdminUrl ] [-DomainName ] -IncludeRecommendation + [-DoNotConnect] [-DoNotDisconnect] [-NoModuleCheck] [-DoNotConfirmConnections] [-WhatIf] [-Confirm] + [] ``` ### SkipRecFilter ``` -Invoke-M365SecurityAudit [-TenantAdminUrl ] [-M365DomainForPWPolicyTest ] - -SkipRecommendation [-DoNotConnect] [-DoNotDisconnect] [-NoModuleCheck] [-DoNotConfirmConnections] - [-ProgressAction ] [-WhatIf] [-Confirm] [] +Invoke-M365SecurityAudit [-TenantAdminUrl ] [-DomainName ] -SkipRecommendation + [-DoNotConnect] [-DoNotDisconnect] [-NoModuleCheck] [-DoNotConfirmConnections] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -164,47 +160,33 @@ What if: Performing the operation "Invoke-M365SecurityAudit" on target "Microsof ## PARAMETERS -### -DoNotConfirmConnections -If specified, the cmdlet will not prompt for confirmation before proceeding with established connections and will disconnect from all of them. +### -TenantAdminUrl +The URL of the tenant admin. +If not specified, none of the SharePoint Online tests will run. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -DoNotConnect -If specified, the cmdlet will not establish a connection to Microsoft 365 services. +### -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. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DoNotDisconnect -If specified, the cmdlet will not disconnect from Microsoft 365 services after execution. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -225,6 +207,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProfileLevel +Specifies the profile level (L1 or L2) for the audit. +This parameter is optional and can be combined with the ELevel parameter. + +```yaml +Type: String +Parameter Sets: ELevelFilter +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -IncludeIG1 If specified, includes tests where IG1 is true. @@ -286,18 +284,48 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -M365DomainForPWPolicyTest -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. +### -SkipRecommendation +Specifies specific recommendations to exclude from the audit. +Accepts an array of recommendation numbers. ```yaml -Type: String +Type: String[] +Parameter Sets: SkipRecFilter +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DoNotConnect +If specified, the cmdlet will not establish a connection to Microsoft 365 services. + +```yaml +Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DoNotDisconnect +If specified, the cmdlet will not disconnect from Microsoft 365 services after execution. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -317,61 +345,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProfileLevel -Specifies the profile level (L1 or L2) for the audit. -This parameter is optional and can be combined with the ELevel parameter. +### -DoNotConfirmConnections +If specified, the cmdlet will not prompt for confirmation before proceeding with established connections and will disconnect from all of them. ```yaml -Type: String -Parameter Sets: ELevelFilter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: ActionPreference +Type: SwitchParameter Parameter Sets: (All) -Aliases: proga +Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -SkipRecommendation -Specifies specific recommendations to exclude from the audit. -Accepts an array of recommendation numbers. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml -Type: String[] -Parameter Sets: SkipRecFilter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TenantAdminUrl -The URL of the tenant admin. -If not specified, none of the SharePoint Online tests will run. - -```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: wi Required: False Position: Named @@ -395,22 +391,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/help/M365FoundationsCISReport.md b/help/M365FoundationsCISReport.md index 267b0ab..3c8e111 100644 --- a/help/M365FoundationsCISReport.md +++ b/help/M365FoundationsCISReport.md @@ -1,4 +1,4 @@ ---- +--- Module Name: M365FoundationsCISReport Module Guid: 0d064bfb-d1ce-484b-a173-993b55984dc9 Download Help Link: {{Please enter Link manually}} @@ -20,6 +20,9 @@ Retrieves user licenses and roles for administrative accounts from Microsoft 365 ### [Get-MFAStatus](Get-MFAStatus.md) Retrieves the MFA (Multi-Factor Authentication) status for Azure Active Directory users. +### [Grant-M365SecurityAuditConsent](Grant-M365SecurityAuditConsent.md) +Grants Microsoft Graph permissions for an auditor. + ### [Invoke-M365SecurityAudit](Invoke-M365SecurityAudit.md) Invokes a security audit for Microsoft 365 environments. diff --git a/help/Remove-RowsWithEmptyCSVStatus.md b/help/Remove-RowsWithEmptyCSVStatus.md index eca797b..4b0f57d 100644 --- a/help/Remove-RowsWithEmptyCSVStatus.md +++ b/help/Remove-RowsWithEmptyCSVStatus.md @@ -13,8 +13,7 @@ Removes rows from an Excel worksheet where the 'CSV_Status' column is empty and ## SYNTAX ``` -Remove-RowsWithEmptyCSVStatus [-FilePath] [-WorksheetName] - [-ProgressAction ] [] +Remove-RowsWithEmptyCSVStatus [-FilePath] [-WorksheetName] [] ``` ## DESCRIPTION @@ -46,21 +45,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -WorksheetName The name of the worksheet within the Excel file to be processed. diff --git a/help/Sync-CISExcelAndCsvData.md b/help/Sync-CISExcelAndCsvData.md index 663e3e4..758f362 100644 --- a/help/Sync-CISExcelAndCsvData.md +++ b/help/Sync-CISExcelAndCsvData.md @@ -1,4 +1,4 @@ ---- +--- external help file: M365FoundationsCISReport-help.xml Module Name: M365FoundationsCISReport online version: https://criticalsolutionsnetwork.github.io/M365FoundationsCISReport/#Sync-CISExcelAndCsvData @@ -14,7 +14,7 @@ Synchronizes and updates data in an Excel worksheet with new information from a ``` Sync-CISExcelAndCsvData [[-ExcelPath] ] [[-CsvPath] ] [[-SheetName] ] - [-ProgressAction ] [] + [] ``` ## DESCRIPTION @@ -32,22 +32,6 @@ Updates the 'AuditData' worksheet in 'excel.xlsx' with data from 'data.csv', add ## PARAMETERS -### -CsvPath -Specifies the path to the CSV file containing new data. -This parameter is mandatory. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ExcelPath Specifies the path to the Excel file to be updated. This parameter is mandatory. @@ -64,16 +48,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProgressAction -{{ Fill ProgressAction Description }} +### -CsvPath +Specifies the path to the CSV file containing new data. +This parameter is mandatory. ```yaml -Type: ActionPreference +Type: String Parameter Sets: (All) -Aliases: proga +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/source/en-US/M365FoundationsCISReport-help.xml b/source/en-US/M365FoundationsCISReport-help.xml index 4ea02c5..507ad97 100644 --- a/source/en-US/M365FoundationsCISReport-help.xml +++ b/source/en-US/M365FoundationsCISReport-help.xml @@ -39,22 +39,10 @@ None - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - Export-M365SecurityAuditTable - + ExportAllTests Switch to export all test results. @@ -77,17 +65,6 @@ None - - ExportOriginalTests - - Switch to export the original audit results to a CSV file. - - - SwitchParameter - - - False - ExportPath @@ -100,6 +77,17 @@ None + + ExportOriginalTests + + Switch to export the original audit results to a CSV file. + + + SwitchParameter + + + False + ExportToExcel @@ -111,18 +99,6 @@ False - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - Export-M365SecurityAuditTable @@ -150,22 +126,10 @@ None - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - Export-M365SecurityAuditTable - + ExportAllTests Switch to export all test results. @@ -188,17 +152,6 @@ None - - ExportOriginalTests - - Switch to export the original audit results to a CSV file. - - - SwitchParameter - - - False - ExportPath @@ -211,6 +164,17 @@ None + + ExportOriginalTests + + Switch to export the original audit results to a CSV file. + + + SwitchParameter + + + False + ExportToExcel @@ -222,18 +186,6 @@ False - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - @@ -261,7 +213,19 @@ None - + + 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". + + String + + String + + + None + + ExportAllTests Switch to export all test results. @@ -273,18 +237,6 @@ False - - ExportOriginalTests - - Switch to export the original audit results to a CSV file. - - SwitchParameter - - SwitchParameter - - - False - ExportPath @@ -297,6 +249,18 @@ None + + ExportOriginalTests + + Switch to export the original audit results to a CSV file. + + SwitchParameter + + SwitchParameter + + + False + ExportToExcel @@ -309,30 +273,6 @@ 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". - - String - - String - - - None - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - @@ -431,18 +371,6 @@ Get-AdminRoleUserLicense - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - SkipGraphConnection @@ -457,18 +385,6 @@ - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - SkipGraphConnection @@ -565,18 +481,6 @@ None - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - SkipMSOLConnectionChecks @@ -591,14 +495,14 @@ - - ProgressAction + + UserId - {{ Fill ProgressAction Description }} + 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. - ActionPreference + String - ActionPreference + String None @@ -615,18 +519,6 @@ False - - 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. - - String - - String - - - None - @@ -760,29 +652,6 @@ Retrieves the MFA status for the specified user with the UPN "example@domain.com None - - DoNotDisconnect - - If specified, does not disconnect from Microsoft Graph after granting consent. - - - SwitchParameter - - - False - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - SkipGraphConnection @@ -816,10 +685,10 @@ Retrieves the MFA status for the specified user with the UPN "example@domain.com False - - Confirm + + DoNotDisconnect - Prompts you for confirmation before running the cmdlet. + If specified, does not disconnect from Microsoft Graph after granting consent. SwitchParameter @@ -838,29 +707,28 @@ Retrieves the MFA status for the specified user with the UPN "example@domain.com False + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + - - DoNotDisconnect + + UserPrincipalNameForConsent - If specified, does not disconnect from Microsoft Graph after granting consent. + Specify the UPN of the user to grant consent for. - SwitchParameter + String - SwitchParameter - - - False - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference + String None @@ -901,22 +769,10 @@ Retrieves the MFA status for the specified user with the UPN "example@domain.com False - - UserPrincipalNameForConsent + + DoNotDisconnect - Specify the UPN of the user to grant consent for. - - String - - String - - - None - - - Confirm - - Prompts you for confirmation before running the cmdlet. + If specified, does not disconnect from Microsoft Graph after granting consent. SwitchParameter @@ -937,6 +793,18 @@ Retrieves the MFA status for the specified user with the UPN "example@domain.com False + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + @@ -993,37 +861,28 @@ Retrieves the MFA status for the specified user with the UPN "example@domain.com Invoke-M365SecurityAudit - DoNotConfirmConnections + TenantAdminUrl - If specified, the cmdlet will not prompt for confirmation before proceeding with established connections and will disconnect from all of them. + The URL of the tenant admin. If not specified, none of the SharePoint Online tests will run. + String - SwitchParameter + String - False + None - DoNotConnect + DomainName - If specified, the cmdlet will not establish a connection to Microsoft 365 services. + 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. + String - SwitchParameter + String - False - - - DoNotDisconnect - - If specified, the cmdlet will not disconnect from Microsoft 365 services after execution. - - - SwitchParameter - - - False + None ELevel @@ -1037,29 +896,6 @@ Retrieves the MFA status for the specified user with the UPN "example@domain.com None - - M365DomainForPWPolicyTest - - 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. - - String - - String - - - None - - - NoModuleCheck - - If specified, the cmdlet will not check for the presence of required modules. - - - SwitchParameter - - - False - ProfileLevel @@ -1072,66 +908,6 @@ Retrieves the MFA status for the specified user with the UPN "example@domain.com None - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - TenantAdminUrl - - The URL of the tenant admin. If not specified, none of the SharePoint Online tests will run. - - String - - String - - - None - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - SwitchParameter - - - False - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - SwitchParameter - - - False - - - - Invoke-M365SecurityAudit - - DoNotConfirmConnections - - If specified, the cmdlet will not prompt for confirmation before proceeding with established connections and will disconnect from all of them. - - - SwitchParameter - - - False - DoNotConnect @@ -1154,6 +930,77 @@ Retrieves the MFA status for the specified user with the UPN "example@domain.com False + + NoModuleCheck + + If specified, the cmdlet will not check for the presence of required modules. + + + SwitchParameter + + + False + + + DoNotConfirmConnections + + If specified, the cmdlet will not prompt for confirmation before proceeding with established connections and will disconnect from all of them. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + + Invoke-M365SecurityAudit + + TenantAdminUrl + + The URL of the tenant admin. If not specified, none of the SharePoint Online tests will run. + + String + + String + + + None + + + 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. + + String + + String + + + None + IncludeIG1 @@ -1165,89 +1012,6 @@ Retrieves the MFA status for the specified user with the UPN "example@domain.com False - - M365DomainForPWPolicyTest - - 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. - - String - - String - - - None - - - NoModuleCheck - - If specified, the cmdlet will not check for the presence of required modules. - - - SwitchParameter - - - False - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - TenantAdminUrl - - The URL of the tenant admin. If not specified, none of the SharePoint Online tests will run. - - String - - String - - - None - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - SwitchParameter - - - False - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - SwitchParameter - - - False - - - - Invoke-M365SecurityAudit - - DoNotConfirmConnections - - If specified, the cmdlet will not prompt for confirmation before proceeding with established connections and will disconnect from all of them. - - - SwitchParameter - - - False - DoNotConnect @@ -1270,6 +1034,77 @@ Retrieves the MFA status for the specified user with the UPN "example@domain.com False + + NoModuleCheck + + If specified, the cmdlet will not check for the presence of required modules. + + + SwitchParameter + + + False + + + DoNotConfirmConnections + + If specified, the cmdlet will not prompt for confirmation before proceeding with established connections and will disconnect from all of them. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + + Invoke-M365SecurityAudit + + TenantAdminUrl + + The URL of the tenant admin. If not specified, none of the SharePoint Online tests will run. + + String + + String + + + None + + + 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. + + String + + String + + + None + IncludeIG2 @@ -1281,89 +1116,6 @@ Retrieves the MFA status for the specified user with the UPN "example@domain.com False - - M365DomainForPWPolicyTest - - 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. - - String - - String - - - None - - - NoModuleCheck - - If specified, the cmdlet will not check for the presence of required modules. - - - SwitchParameter - - - False - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - TenantAdminUrl - - The URL of the tenant admin. If not specified, none of the SharePoint Online tests will run. - - String - - String - - - None - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - SwitchParameter - - - False - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - SwitchParameter - - - False - - - - Invoke-M365SecurityAudit - - DoNotConfirmConnections - - If specified, the cmdlet will not prompt for confirmation before proceeding with established connections and will disconnect from all of them. - - - SwitchParameter - - - False - DoNotConnect @@ -1386,6 +1138,77 @@ Retrieves the MFA status for the specified user with the UPN "example@domain.com False + + NoModuleCheck + + If specified, the cmdlet will not check for the presence of required modules. + + + SwitchParameter + + + False + + + DoNotConfirmConnections + + If specified, the cmdlet will not prompt for confirmation before proceeding with established connections and will disconnect from all of them. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + + Invoke-M365SecurityAudit + + TenantAdminUrl + + The URL of the tenant admin. If not specified, none of the SharePoint Online tests will run. + + String + + String + + + None + + + 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. + + String + + String + + + None + IncludeIG3 @@ -1397,89 +1220,6 @@ Retrieves the MFA status for the specified user with the UPN "example@domain.com False - - M365DomainForPWPolicyTest - - 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. - - String - - String - - - None - - - NoModuleCheck - - If specified, the cmdlet will not check for the presence of required modules. - - - SwitchParameter - - - False - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - TenantAdminUrl - - The URL of the tenant admin. If not specified, none of the SharePoint Online tests will run. - - String - - String - - - None - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - SwitchParameter - - - False - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - SwitchParameter - - - False - - - - Invoke-M365SecurityAudit - - DoNotConfirmConnections - - If specified, the cmdlet will not prompt for confirmation before proceeding with established connections and will disconnect from all of them. - - - SwitchParameter - - - False - DoNotConnect @@ -1502,6 +1242,77 @@ Retrieves the MFA status for the specified user with the UPN "example@domain.com False + + NoModuleCheck + + If specified, the cmdlet will not check for the presence of required modules. + + + SwitchParameter + + + False + + + DoNotConfirmConnections + + If specified, the cmdlet will not prompt for confirmation before proceeding with established connections and will disconnect from all of them. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + + Invoke-M365SecurityAudit + + TenantAdminUrl + + The URL of the tenant admin. If not specified, none of the SharePoint Online tests will run. + + String + + String + + + None + + + 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. + + String + + String + + + None + IncludeRecommendation @@ -1514,89 +1325,6 @@ Retrieves the MFA status for the specified user with the UPN "example@domain.com None - - M365DomainForPWPolicyTest - - 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. - - String - - String - - - None - - - NoModuleCheck - - If specified, the cmdlet will not check for the presence of required modules. - - - SwitchParameter - - - False - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - TenantAdminUrl - - The URL of the tenant admin. If not specified, none of the SharePoint Online tests will run. - - String - - String - - - None - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - SwitchParameter - - - False - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - SwitchParameter - - - False - - - - Invoke-M365SecurityAudit - - DoNotConfirmConnections - - If specified, the cmdlet will not prompt for confirmation before proceeding with established connections and will disconnect from all of them. - - - SwitchParameter - - - False - DoNotConnect @@ -1619,18 +1347,6 @@ Retrieves the MFA status for the specified user with the UPN "example@domain.com False - - M365DomainForPWPolicyTest - - 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. - - String - - String - - - None - NoModuleCheck @@ -1642,14 +1358,62 @@ Retrieves the MFA status for the specified user with the UPN "example@domain.com False - - ProgressAction + + DoNotConfirmConnections - {{ Fill ProgressAction Description }} + If specified, the cmdlet will not prompt for confirmation before proceeding with established connections and will disconnect from all of them. - ActionPreference - ActionPreference + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + + Invoke-M365SecurityAudit + + TenantAdminUrl + + The URL of the tenant admin. If not specified, none of the SharePoint Online tests will run. + + String + + String + + + None + + + 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. + + String + + String None @@ -1667,21 +1431,42 @@ Retrieves the MFA status for the specified user with the UPN "example@domain.com None - TenantAdminUrl + DoNotConnect - The URL of the tenant admin. If not specified, none of the SharePoint Online tests will run. + If specified, the cmdlet will not establish a connection to Microsoft 365 services. - String - String + SwitchParameter - None + False - - Confirm + + DoNotDisconnect - Prompts you for confirmation before running the cmdlet. + If specified, the cmdlet will not disconnect from Microsoft 365 services after execution. + + + SwitchParameter + + + False + + + NoModuleCheck + + If specified, the cmdlet will not check for the presence of required modules. + + + SwitchParameter + + + False + + + DoNotConfirmConnections + + If specified, the cmdlet will not prompt for confirmation before proceeding with established connections and will disconnect from all of them. SwitchParameter @@ -1700,44 +1485,43 @@ Retrieves the MFA status for the specified user with the UPN "example@domain.com False + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + - DoNotConfirmConnections + TenantAdminUrl - If specified, the cmdlet will not prompt for confirmation before proceeding with established connections and will disconnect from all of them. + The URL of the tenant admin. If not specified, none of the SharePoint Online tests will run. - SwitchParameter + String - SwitchParameter + String - False + None - DoNotConnect + DomainName - If specified, the cmdlet will not establish a connection to Microsoft 365 services. + 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. - SwitchParameter + String - SwitchParameter + String - False - - - DoNotDisconnect - - If specified, the cmdlet will not disconnect from Microsoft 365 services after execution. - - SwitchParameter - - SwitchParameter - - - False + None ELevel @@ -1751,6 +1535,18 @@ Retrieves the MFA status for the specified user with the UPN "example@domain.com None + + ProfileLevel + + Specifies the profile level (L1 or L2) for the audit. This parameter is optional and can be combined with the ELevel parameter. + + String + + String + + + None + IncludeIG1 @@ -1799,54 +1595,6 @@ Retrieves the MFA status for the specified user with the UPN "example@domain.com None - - M365DomainForPWPolicyTest - - 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. - - String - - String - - - None - - - NoModuleCheck - - If specified, the cmdlet will not check for the presence of required modules. - - SwitchParameter - - SwitchParameter - - - False - - - ProfileLevel - - Specifies the profile level (L1 or L2) for the audit. This parameter is optional and can be combined with the ELevel parameter. - - String - - String - - - None - - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - SkipRecommendation @@ -1860,21 +1608,45 @@ Retrieves the MFA status for the specified user with the UPN "example@domain.com None - TenantAdminUrl + DoNotConnect - The URL of the tenant admin. If not specified, none of the SharePoint Online tests will run. + If specified, the cmdlet will not establish a connection to Microsoft 365 services. - String + SwitchParameter - String + SwitchParameter - None + False - - Confirm + + DoNotDisconnect - Prompts you for confirmation before running the cmdlet. + If specified, the cmdlet will not disconnect from Microsoft 365 services after execution. + + SwitchParameter + + SwitchParameter + + + False + + + NoModuleCheck + + If specified, the cmdlet will not check for the presence of required modules. + + SwitchParameter + + SwitchParameter + + + False + + + DoNotConfirmConnections + + If specified, the cmdlet will not prompt for confirmation before proceeding with established connections and will disconnect from all of them. SwitchParameter @@ -1895,6 +1667,18 @@ Retrieves the MFA status for the specified user with the UPN "example@domain.com False + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + @@ -2038,18 +1822,6 @@ PS> $auditResults | Export-Csv -Path "auditResults.csv" -NoTypeInformation None - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - @@ -2065,18 +1837,6 @@ PS> $auditResults | Export-Csv -Path "auditResults.csv" -NoTypeInformation None - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - WorksheetName @@ -2160,33 +1920,9 @@ This command imports data from the "Sheet1" worksheet in the "Report.xlsx" file, None - - ProgressAction - - {{ Fill ProgressAction Description }} - - ActionPreference - - ActionPreference - - - None - - - CsvPath - - Specifies the path to the CSV file containing new data. This parameter is mandatory. - - String - - String - - - None - ExcelPath @@ -2199,14 +1935,14 @@ This command imports data from the "Sheet1" worksheet in the "Report.xlsx" file, None - - ProgressAction + + CsvPath - {{ Fill ProgressAction Description }} + Specifies the path to the CSV file containing new data. This parameter is mandatory. - ActionPreference + String - ActionPreference + String None