API Reference
ToolingRuleRunRequest
Request contract for tooling-oriented rule execution.
Inheritance
- Object
- ToolingRuleRunRequest
Constructors
public ToolingRuleRunRequest() #Inherited Methods
Properties
public IReadOnlyList<String> RuleNames { get; set; } #Optional explicit rule names to execute.
public IReadOnlyList<String> RuleNamePatterns { get; set; } #Optional wildcard patterns used to select rules by name/display name.
public Boolean RunAllEnabledWhenNoSelection { get; set; } #When true and no explicit names/patterns are provided, execute all enabled rules.
public String Query { get; set; } #Optional case-insensitive substring matched against rule name, display name, and summary.
public IReadOnlyList<String> Categories { get; set; } #Optional category-name filters (any-match, case-insensitive).
public IReadOnlyList<String> Tags { get; set; } #Optional tag filters (any-match, case-insensitive).
public IReadOnlyList<RuleSourceType> SourceTypes { get; set; } #Optional rule source-type filters.
public ToolingRuleOrigin RuleOrigin { get; set; } #Optional origin filter.
public Boolean IncludeDisabled { get; set; } #Include disabled rules for pattern-based and run-all selection. Explicit rule names are always honored when found.
public Boolean IncludeDeprecated { get; set; } #Include deprecated rules for selector-based discovery.
public Boolean FailWhenMissingRuleNames { get; set; } #When true, return without execution if any explicit RuleNames are missing.
public Boolean IncludeRuleData { get; set; } #Include raw rule result payloads.
public Boolean IncludeFilteredRuleData { get; set; } #Include filtered rule result payloads.
public Boolean IncludeExcludedRuleData { get; set; } #Include excluded rule result payloads.
public Boolean IncludeStreams { get; set; } #Include PowerShell information/warning/error streams.
public Boolean IncludeTestResults { get; set; } #Include per-test outcomes.
public Boolean IncludeExecutionParameters { get; set; } #Include effective execution parameters captured per rule.
public Nullable<Int32> MaxItemsPerDataSeries { get; set; } #Optional maximum number of items returned per data series. Null means no tool-level cap.
public Int32 SerializationDepth { get; set; } #Maximum object graph depth used when converting nested runtime values to JSON-safe structures.
public String PowerShellRulesDirectory { get; set; } #Optional directory with additional PowerShell rules.
public ExecutionConfiguration Configuration { get; set; } #Optional execution configuration override.
public IReadOnlyList<String> IncludeDomains { get; set; } #Optional discovery/query scope include domains.
public IReadOnlyList<String> ExcludeDomains { get; set; } #Optional discovery/query scope exclude domains.
public IReadOnlyList<String> IncludeDomainControllers { get; set; } #Optional discovery/query scope include domain controllers.
public IReadOnlyList<String> ExcludeDomainControllers { get; set; } #Optional discovery/query scope exclude domain controllers.
public Boolean IncludeTrustedDomains { get; set; } #When true, discovery includes trusted domains.
public Boolean IncludeSupersededRules { get; set; } #When true, do not suppress rules marked as superseded.