docs: Add wiki help docs
This commit is contained in:
@@ -1,4 +1,4 @@
|
||||
---
|
||||
---
|
||||
external help file: M365FoundationsCISReport-help.xml
|
||||
Module Name: M365FoundationsCISReport
|
||||
online version: https://criticalsolutionsnetwork.github.io/M365FoundationsCISReport/#Export-M365SecurityAuditTable
|
||||
@@ -15,24 +15,25 @@ Exports M365 security audit results to a CSV file or outputs a specific test res
|
||||
### OutputObjectFromAuditResultsSingle
|
||||
```
|
||||
Export-M365SecurityAuditTable [-AuditResults] <CISAuditResult[]> [-OutputTestNumber] <String>
|
||||
[<CommonParameters>]
|
||||
[-ProgressAction <ActionPreference>] [<CommonParameters>]
|
||||
```
|
||||
|
||||
### ExportAllResultsFromAuditResults
|
||||
```
|
||||
Export-M365SecurityAuditTable [-AuditResults] <CISAuditResult[]> [-ExportAllTests] -ExportPath <String>
|
||||
[-ExportOriginalTests] [-ExportToExcel] [<CommonParameters>]
|
||||
[-ExportOriginalTests] [-ExportToExcel] [-ProgressAction <ActionPreference>] [<CommonParameters>]
|
||||
```
|
||||
|
||||
### OutputObjectFromCsvSingle
|
||||
```
|
||||
Export-M365SecurityAuditTable [-CsvPath] <String> [-OutputTestNumber] <String> [<CommonParameters>]
|
||||
Export-M365SecurityAuditTable [-CsvPath] <String> [-OutputTestNumber] <String>
|
||||
[-ProgressAction <ActionPreference>] [<CommonParameters>]
|
||||
```
|
||||
|
||||
### ExportAllResultsFromCsv
|
||||
```
|
||||
Export-M365SecurityAuditTable [-CsvPath] <String> [-ExportAllTests] -ExportPath <String> [-ExportOriginalTests]
|
||||
[-ExportToExcel] [<CommonParameters>]
|
||||
[-ExportToExcel] [-ProgressAction <ActionPreference>] [<CommonParameters>]
|
||||
```
|
||||
|
||||
## DESCRIPTION
|
||||
@@ -44,44 +45,38 @@ It can export all results to a specified path or output a specific test result a
|
||||
### EXAMPLE 1
|
||||
```
|
||||
Export-M365SecurityAuditTable -AuditResults $object -OutputTestNumber 6.1.2
|
||||
```
|
||||
|
||||
# Output object for a single test number from audit results
|
||||
```
|
||||
|
||||
### EXAMPLE 2
|
||||
```
|
||||
Export-M365SecurityAuditTable -ExportAllTests -AuditResults $object -ExportPath "C:\temp"
|
||||
```
|
||||
|
||||
# Export all results from audit results to the specified path
|
||||
```
|
||||
|
||||
### EXAMPLE 3
|
||||
```
|
||||
Export-M365SecurityAuditTable -CsvPath "C:\temp\auditresultstoday1.csv" -OutputTestNumber 6.1.2
|
||||
```
|
||||
|
||||
# Output object for a single test number from CSV
|
||||
```
|
||||
|
||||
### EXAMPLE 4
|
||||
```
|
||||
Export-M365SecurityAuditTable -ExportAllTests -CsvPath "C:\temp\auditresultstoday1.csv" -ExportPath "C:\temp"
|
||||
```
|
||||
|
||||
# Export all results from CSV to the specified path
|
||||
```
|
||||
|
||||
### EXAMPLE 5
|
||||
```
|
||||
Export-M365SecurityAuditTable -ExportAllTests -AuditResults $object -ExportPath "C:\temp" -ExportOriginalTests
|
||||
```
|
||||
|
||||
# Export all results from audit results to the specified path along with the original tests
|
||||
```
|
||||
|
||||
### EXAMPLE 6
|
||||
```
|
||||
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
|
||||
```
|
||||
|
||||
## PARAMETERS
|
||||
|
||||
@@ -115,6 +110,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.
|
||||
|
||||
@@ -130,21 +141,6 @@ 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
|
||||
Default value: False
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -ExportPath
|
||||
The path where the CSV files will be exported.
|
||||
|
||||
@@ -160,6 +156,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: False
|
||||
Position: Named
|
||||
Default value: False
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -ExportToExcel
|
||||
Switch to export the results to an Excel file.
|
||||
|
||||
@@ -175,17 +186,16 @@ 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".
|
||||
### -ProgressAction
|
||||
{{ Fill ProgressAction Description }}
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: OutputObjectFromAuditResultsSingle, OutputObjectFromCsvSingle
|
||||
Aliases:
|
||||
Type: ActionPreference
|
||||
Parameter Sets: (All)
|
||||
Aliases: proga
|
||||
|
||||
Required: True
|
||||
Position: 2
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
|
||||
Reference in New Issue
Block a user