From 03b5bb47e2e0f0a134d11436b7ad3ce38487dbe2 Mon Sep 17 00:00:00 2001 From: DrIOS <58635327+DrIOSX@users.noreply.github.com> Date: Sat, 8 Jun 2024 18:12:01 -0500 Subject: [PATCH] docs: Update HelpE --- README.md | Bin 24766 -> 29808 bytes docs/index.html | Bin 67100 -> 72076 bytes source/Public/Invoke-M365SecurityAudit.ps1 | 60 +++++++++++++++++++++ 3 files changed, 60 insertions(+) diff --git a/README.md b/README.md index c306c67966493af5bd0379e9fdd60538062d3929..f4582578d955466e7a3f3679d84212bce701d59c 100644 GIT binary patch delta 4153 zcmeHKOHUL*5Uxou5DX%L4XjEstl=R6%r0nfNl+rI5Eprc#RsAzEDtlVWFHz6lhwqd z34}g-@CTR}=Wg_mm~ivx!ILMysjdb_HtzN)F(?(fqV>-#tB!_R89 zQ$OH!*POekp2Q<+ZP0EmP>$AVlUB*5WlGZuIaDB5y}H%hmZLt*+Ehoia(7cVO+uQd zEqTV3)zEq0Xv|{X!Oa$V&RlVfZa}h5uFSEu1SR3?DQ-RI*G*8r(Nk|b!u7m9Nzu~W zNKNPj>&Mmh>GMU6ZU&Z?M8jCpZ(bWk6#C{l_RiWljuL47`Ua^BX<8(#J&G|$#`yh_ zvG(m2${=~YaGs$Jq{W4rgPFW?svC=}qFv63$t)xe^t5rm>le_Qfelxn`6ZRcykd-= z(__lQ=Q5S2pQRH;2y(d0_f2B71P7b)G|>2arC}sW*Iy`2$er!8jN`|=1QP?j*#gPVkO|F(hJDOL|RJCL6W#iq+n#!i}W0*7jdy9DK9`b zk2S0xlY)IjxK!Ih>uy7r>KXds)ebgUttMAoqUNS)j zZMmPugCnjZf0dP|pQS-t{&#Jux>C}YDiz;7t}SOSOb7cUc7tG_q+p+PaX|PN`=lDX z+vW8PeLZ%Q47xEmwaT%^4!RM4%KxMr6KX2;TI~$IQH#T;LKRP|o;w`d@7FS(Svq)H zu}*M5m{8NHa04@x99SfqEFF=p%gjn~N*OE{KaQb6e13&SYcFirVfApX9YR{2DY;gva&W=gAS z??Fg?Zm&A431P)FBn)ctC&%=u!`9$G4|GfIhih#e_4N-{KDha z9;yfNDti+|FJ6Trc<>+uyb0o=e}Lb-H8p`$@K7kYEbr}mGjC?To!Q6x-o}!9 z$#OsW>N!g>3Q+|82%UNT{oOLZh=us$+HwA|qWP*+p*)#%pESymK{KRNl?puh#%EOM zGSnpkUXPYmNUGxtl?(b$Dv^FVZks3A6ag?jx}U$7|86_(p3aC5OqUS07^soPU0=d1z$UI z@p*%a$U~5_c+cT$3s|K?B0hCUMP4QIAOsbFJ31H$PAkV{EYe|ObOaY557DMzR)DU; zdjH^MkzAuX-J>$x=cqH0q8*34f~QrK3`SYlo6<|vVM)3H`!J2cgMgI}GLaG+x_G&Y zm_5A~*i{ zZvS>$+Uf;Y*T^)qt41(JRAE~`T@`sT)X$MYssZ zM+4UTXE~Q;u0&n>UhaZXXBRlTVE^ud7bv&#%nZ-vGDC0c$)C}9L6Fm;Sma~!Dfah>;8t2WDR5w zj9jhH!){htwfMT+PK5s2TvxvV}YkFWxBfa7n&+?RBF?YUe<%D8&Tr9`w(&wF_+)$bax^h>oK>+@#X_yrUF BajpOW delta 110 zcmeC#%rd8kWx_pPa|SC0BL+h-X|eJ3{z;q9%=pDP`H6MUWIs=%$>(Mqnk=?p%j6IF zER$bYJ53gN?gkUzEVYaWq|j~hgC%a0@4RZ6G_z;&w$~1mTUJYLezS&yadV1Y3G-&R HEpDj*WgIfP diff --git a/source/Public/Invoke-M365SecurityAudit.ps1 b/source/Public/Invoke-M365SecurityAudit.ps1 index bd4e675..abdaa72 100644 --- a/source/Public/Invoke-M365SecurityAudit.ps1 +++ b/source/Public/Invoke-M365SecurityAudit.ps1 @@ -28,18 +28,77 @@ .PARAMETER NoModuleCheck If specified, the cmdlet will not check for the presence of required modules. .EXAMPLE + PS> 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 PS> Invoke-M365SecurityAudit -TenantAdminUrl "https://contoso-admin.sharepoint.com" -M365DomainForPWPolicyTest "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 PS> Invoke-M365SecurityAudit -TenantAdminUrl "https://contoso-admin.sharepoint.com" -M365DomainForPWPolicyTest "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 PS> Invoke-M365SecurityAudit -TenantAdminUrl "https://contoso-admin.sharepoint.com" -M365DomainForPWPolicyTest "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 PS> $auditResults = Invoke-M365SecurityAudit -TenantAdminUrl "https://contoso-admin.sharepoint.com" -M365DomainForPWPolicyTest "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 + PS> 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". .INPUTS None. You cannot pipe objects to Invoke-M365SecurityAudit. .OUTPUTS @@ -55,6 +114,7 @@ .LINK https://criticalsolutionsnetwork.github.io/M365FoundationsCISReport/#Invoke-M365SecurityAudit #> + function Invoke-M365SecurityAudit { [CmdletBinding(SupportsShouldProcess = $true, DefaultParameterSetName = 'Default')] [OutputType([CISAuditResult[]])]