From 14f3889378bb36971c9ea21986722efc71c6f6d9 Mon Sep 17 00:00:00 2001 From: DrIOS <58635327+DrIOSX@users.noreply.github.com> Date: Mon, 1 Jul 2024 13:18:54 -0500 Subject: [PATCH] docs: Update Help/WikiFiles/HTML Help --- README.md | Bin 43530 -> 45446 bytes docs/index.html | Bin 114692 -> 117106 bytes help/Export-M365SecurityAuditTable.md | 5 +- .../Public/Export-M365SecurityAuditTable.ps1 | 55 ++++++++++-------- .../en-US/M365FoundationsCISReport-help.xml | 12 +++- 5 files changed, 43 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index e3d4e2297c4890edc2b96f0c77e978a1922818bf..4c04a533ac7e357cb0af9501d47f91d77568f386 100644 GIT binary patch delta 1442 zcmbVMU1(Eh82(NglPtB#$w`}}Imzki&uVJZ;wrQtU1e06NR(E^R$IHKHd)JJ?V8jT z5oyOzsHme)2Lq+C=!J*`%hxOMLPW$$sW5sWUWg)y2zGeW3lZIWPE4APt{Wq8&iB6g zzUO(~=Y793zGyh}(s1jB39n5tjDIVkyUT(LClpLcuKZ@UpB-c>JI;pi_KLeYPU|om zV7>H?vtc$!Kl+a)DAINf(`rzECNOthkZR_QsC#qFoe_jn<1f@p6-cQSy}4hgBG3A0im=93;Q*((17 z!rY}&Jd`S-HhcJ9yGfuU74k62j_AcCNc^e-(E44mF263?gcip}eDsNElo~NFTd*Yh z%x!78aBMH$5N0tJ!((%?R;)WrhD82W2C+a;YS2>`n23}SU}xTEPciEV;LTKh&AJW{ zoK8aT1cAq~-PWwjn(})|)~{JP?|vx7NS=r;#fqn9+q#0rs!NmdFFsnL5*@e#_V_f03A)NdD}*F}hx9`qDeWHByo^&_=a#kHiT z>Li^V)T#SPg4Tr0wDy0V(LTz=Ss%uNPAmjku;6V%MbU^5$KxN}8?+IK;=EnPNsqN$ zD?#(-7~v%Jc4yo=K|H;L-;0Y<3GUdv+~9Hv=JfT5;k-oS>Z_E~o@6djjvuU+kGac* zwOGH%vSKFb*RWx5`A~Q!Kw7)-d-3HQno{ibS}~jS!l(q-ql4h`BRC`QJ{Nvw6DRMt*qeR{md?PMn1R delta 626 zcmZpB%+z&-X~QbE$tD#BljpEiu^Ka&F_=z1AE-Eaft0}H1!5eN)kK9P6&UgviWop- zDMJZE0hlZX@)IZD&k>z`hFxs(1_7DL1!i`etvFm*Hp?aRF;1SsyJhk_QKiWasS=a; zC&8GTT?E(|Cm-Xpn*2?$X7Y_9x5-YzF_SOIa!lSKtN|8p6WKPIOF(I|fY_GF*WAq} zH&}5@&J%YM*8$oW!w}6-40J&eLncEWLpqQjJK0gfcd}D$!el;ayUAN5D^x+QOk&7l zNM%R{s#IV|gStHt$S#KJ%bDCLAUk;;pUUI_8JWqq3^jndFHQCl;+nifNMLe+GS}o4 zd{UDWRCP87$S5%qZzO*j&}sP$xj?I&8G;$YCdc=>0*#KFJWXy6vhl1?Syf%I0~{uU z9I$EfJtZ$>RZvIhO)gQkU@YFeUon#rSsHGLK19LfhwHaa)>60HJV$L06C@7)S#nIa zbF4%ZJ`Jlkvg;tEeYG&S(bg-cIz?- zZn2q5B%#~My!;@hApwa&1G#F6803c%;;+pZ!w*ylBYs5$!ViD&!}GrDyRVQ)Oq2We z+;h)!o^#G~Z+s%>!E8?Anzez|uv+#Ut#$ORWA#iTYb$G_)kQ1qUikA@D~_Kwd|-k+ z{JEm`scmd8^U=8>7Us9!fTCw3WOT7X7NBp0jj&<*k&{Kql8=qhzhPyK^5Z+fgkIaG zS$pQwU1@(e>tjLIgD_|2wfi9(rMMOY70vwW`(VJYY=%|o9a!qk<5N!XV7L7!IPs2s zU#?RnfD2(`V9Q-0Ql|X_L{UyE z5g-N7cbx2Dg?N~fhsYXL_EoyF6{cMouZI$;B}oc}uu@8d1##%ADU}?9dBFTV&EjC? zcRF4_4UHO!#rQ@)7_*jY1>Y8wT0$aGKbG;h1ANCQScP_5F$k%#NjYNA8KEkIEP$Up zUxNSG9jQ}6NB|~1d01AZ$1mF-&9*#~E3th_NrSlYQps$KlqIVnjDNQp(d~7Lz~?8I zLfWddV&1IF&rG|VXwBH12-wfVSY0WJR6S&E&u zd=iyLO?~(9W}XN^A?jPkQi)8c1CjK2*G1z)n_i7Ds{>k5gFH-G$OCfw#pIc1Tm^E)OWM`BgPv7OIsfFgd<3C{9rwt?x`o7A?bGCWclJ3wca&b=Ln0=(!d6rT-` z0$zVfQW5Z-xpKU_RpS0hD6UkMp(<(RcFA&-b(Iz#f8iL|Qdj!HnL)#MV|@1si11rZ zD54n*v0gNFnDFCQbym5Mup-|T{S7NSqol5YGGmL^j1^lp^AjC(&nL!@5aNT}B@xps z(Bj=?Qahx+0IRygXF901q|YVJdp+=27Bsjt3qBc#@|9$A)Ul3(uqK2h?g}&@?0y&ZdnI(f9>8-R1Aeoo zc}>B){!4%`1uN-I+N&mSlJ`scBT=lu?;up3T}YE*6vxle=9ZbpQnP6>Sxm9jX6e*5=g6fQfZXh6BD~0fBk6-KB&6eXQr>lQ-t(O2|9{T!ocH^r`u2!= z;+4S)W;hNOj>kA2gA&j~F@J4bE#=6S@bZ#@+(s+SozYNHgEmVKeh9G64?{2r1MwK7 zu1Yga7U<~Yw4F>wEjygMd~k^sJ>Y|Yyi$sF^uZWX#qD&ipoOJ5O8QNFhvew63(Mix zsbaM@2gO9$ON?hUQ8p|*Ctjf9+J|E(^i?*b)mlk(&X*wRtI}wXSworSF$z`Z(OR2^ zW~+@;QIr&?1`Fc~@%dB_iiL_ClxNa$WZfhl*13=tDkSQh|1D-_E`@jmz4yKx)9QPO+MF(|^`_ghz6F7w8vf*u@7rZ{-e8KkTP!VkMvzNs5e#O%J{SV#DPk~W*VK&6L-QPOQI-Li|QSb zuR0XQrCvXPyLvt=x$)^ F=|8lE36=l= diff --git a/help/Export-M365SecurityAuditTable.md b/help/Export-M365SecurityAuditTable.md index 858ea30..07eb7cf 100644 --- a/help/Export-M365SecurityAuditTable.md +++ b/help/Export-M365SecurityAuditTable.md @@ -190,10 +190,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### [CISAuditResult[]], [string] +### [CISAuditResult[]] - An array of CISAuditResult objects. +### [string] - A path to a CSV file. ## OUTPUTS -### [PSCustomObject] +### [PSCustomObject] - A custom object containing the path to the zip file and its hash. ## NOTES ## RELATED LINKS diff --git a/source/Public/Export-M365SecurityAuditTable.ps1 b/source/Public/Export-M365SecurityAuditTable.ps1 index e1c20fd..e194998 100644 --- a/source/Public/Export-M365SecurityAuditTable.ps1 +++ b/source/Public/Export-M365SecurityAuditTable.ps1 @@ -1,47 +1,52 @@ <# .SYNOPSIS - Exports M365 security audit results to a CSV file or outputs a specific test result as an object. + Exports Microsoft 365 security audit results to CSV or Excel files and supports outputting specific test results as objects. .DESCRIPTION - This function exports M365 security audit results from either an array of CISAuditResult objects or a CSV file. - It can export all results to a specified path or output a specific test result as an object. + 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. .PARAMETER AuditResults - An array of CISAuditResult objects containing the audit results. + An array of CISAuditResult objects containing the audit results. This parameter is mandatory when exporting from audit results. .PARAMETER CsvPath - The path to a CSV file containing the audit results. + The path to a CSV file containing the audit results. This parameter is mandatory when exporting from a CSV file. .PARAMETER 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". + 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. .PARAMETER ExportAllTests - Switch to export all test results. + Switch to export all test results. When specified, all test results are exported to the specified path. .PARAMETER ExportPath - The path where the CSV files will be exported. + The path where the CSV or Excel files will be exported. This parameter is mandatory when exporting all tests. .PARAMETER ExportOriginalTests - Switch to export the original audit results to a CSV file. + Switch to export the original audit results to a CSV file. When specified, the original test results are exported along with the processed results. .PARAMETER ExportToExcel - Switch to export the results to an Excel file. + Switch to export the results to an Excel file. When specified, results are exported in Excel format. .INPUTS - [CISAuditResult[]], [string] + [CISAuditResult[]] - An array of CISAuditResult objects. + [string] - A path to a CSV file. .OUTPUTS - [PSCustomObject] + [PSCustomObject] - A custom object containing the path to the zip file and its hash. .EXAMPLE - Export-M365SecurityAuditTable -AuditResults $object -OutputTestNumber 6.1.2 - # Output object for a single test number from audit results + 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 - Export-M365SecurityAuditTable -ExportAllTests -AuditResults $object -ExportPath "C:\temp" - # Export all results from audit results to the specified path + Export-M365SecurityAuditTable -ExportAllTests -AuditResults $object -ExportPath "C:\temp" + # Exports all audit results to the specified path in CSV format. .EXAMPLE - Export-M365SecurityAuditTable -CsvPath "C:\temp\auditresultstoday1.csv" -OutputTestNumber 6.1.2 - # Output object for a single test number from CSV + 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 - Export-M365SecurityAuditTable -ExportAllTests -CsvPath "C:\temp\auditresultstoday1.csv" -ExportPath "C:\temp" - # Export all results from CSV to the specified path + 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 - Export-M365SecurityAuditTable -ExportAllTests -AuditResults $object -ExportPath "C:\temp" -ExportOriginalTests - # Export all results from audit results to the specified path along with the original tests + 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 - Export-M365SecurityAuditTable -ExportAllTests -CsvPath "C:\temp\auditresultstoday1.csv" -ExportPath "C:\temp" -ExportOriginalTests - # Export all results from CSV to the specified path along with the original tests + 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 + Export-M365SecurityAuditTable -ExportAllTests -AuditResults $object -ExportPath "C:\temp" -ExportToExcel + # Exports all audit results to the specified path in Excel format. .LINK - https://criticalsolutionsnetwork.github.io/M365FoundationsCISReport/#Export-M365SecurityAuditTable + https://criticalsolutionsnetwork.github.io/M365FoundationsCISReport/#Export-M365SecurityAuditTable #> function Export-M365SecurityAuditTable { [CmdletBinding()] diff --git a/source/en-US/M365FoundationsCISReport-help.xml b/source/en-US/M365FoundationsCISReport-help.xml index dce77ce..d9a795e 100644 --- a/source/en-US/M365FoundationsCISReport-help.xml +++ b/source/en-US/M365FoundationsCISReport-help.xml @@ -277,7 +277,15 @@ - [CISAuditResult[]], [string] + [CISAuditResult[]] - An array of CISAuditResult objects. + + + + + + + + [string] - A path to a CSV file. @@ -287,7 +295,7 @@ - [PSCustomObject] + [PSCustomObject] - A custom object containing the path to the zip file and its hash.