Get-TestimoXRuleOverview

Namespace TestimoX.PowerShell

Outputs

System.String TestimoX.Execution.RuleInventoryEntry TestimoX.Execution.RuleOverview

Lists all discovered rules with metadata or emits copy/paste‑ready names.

Examples

Authored help example

Example 1: List the full discovered rule overview across built-in C# and PowerShell rules.

PS>


Get-TestimoXRuleOverview

Example 2: Emit only enabled PowerShell-backed rules and narrow the list by a name filter.

PS>


Get-TestimoXRuleOverview -Type PowerShell -EnabledOnly -Filter RecycleBin

Example 3: Generate copy/paste-ready enum entries for embedding into C# rule selections.

PS>


Get-TestimoXRuleOverview -Type CSharp -NameOnly -AsSnippet -Indent 8

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.

Syntax

Get-TestimoXRuleOverview [-AsSnippet] [-EnabledOnly] [-Filter <string>] [-Indent <int>] [-Inventory] [-NameOnly] [-PowerShellRulesDirectory <string>] [-Profile <AdSecurityAssessment>] [-Type <string>] [<CommonParameters>]

Parameters

AsSnippet SwitchParameter optionalposition: namedpipeline: false: When used with NameOnly, outputs lines with indentation and commas.
EnabledOnly SwitchParameter optionalposition: namedpipeline: false: Return only rules that are enabled by default.
Filter string optionalposition: namedpipeline: false: Optional substring filter applied to Name and DisplayName (case‑insensitive).
Indent int optionalposition: namedpipeline: false: Indentation used by AsSnippet lines.
Inventory SwitchParameter optionalposition: namedpipeline: false: Emit migration inventory instead of the compact overview.
NameOnly SwitchParameter optionalposition: namedpipeline: false: Emits only qualified enum names instead of table rows.
PowerShellRulesDirectory string optionalposition: namedpipeline: false: Optional path to a directory containing user PowerShell rules (.ps1). Overrides TESTIMOX_PS_RULES_DIR.
Profile RuleSelectionProfile optionalposition: namedpipeline: falsevalues: 1: Optional curated profile used to classify inventory rows into assessment areas. Possible values: None, AdSecurityAssessment; Possible values: AdSecurityAssessment
Type string optionalposition: namedpipeline: false: Limits results to a specific source: Both, CSharp or PowerShell.

Outputs

System.String, TestimoX.Execution.RuleInventoryEntry, TestimoX.Execution.RuleOverview