en-AU/PSRule-help.xml
|
<?xml version="1.0" encoding="utf-8"?> <helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Assert-PSRule</command:name> <command:verb>Assert</command:verb> <command:noun>PSRule</command:noun> <maml:description> <maml:para>Evaluate objects against matching rules and assert any failures.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Evaluate objects against matching rules and assert any failures. Objects can be specified directly from the pipeline or provided from file.</maml:para> <maml:para>The commands `Invoke-PSRule` and `Assert-PSRule` provide similar functionality, as differ as follows:</maml:para> <maml:para>- `Invoke-PSRule` writes results as structured objects</maml:para> <maml:para>- `Assert-PSRule` writes results as a formatted string.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Assert-PSRule</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="p"> <maml:name>Path</maml:name> <maml:description> <maml:para>One or more paths to search for rule definitions within. If no sources are specified by `-Path`, `-Module`, or options, the current working directory is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$PWD</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="f"> <maml:name>InputPath</maml:name> <maml:description> <maml:para>Instead of processing objects from the pipeline, import objects file the specified file paths.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Format</maml:name> <maml:description> <maml:para>Configures the input format for when a string is passed in as a target object.</maml:para> <maml:para>When the `-InputObject` parameter or pipeline input is used, strings are treated as plain text by default. Set this option to either `Yaml`, `Json`, `Markdown`, `PowerShellData` to have PSRule deserialize the object.</maml:para> <maml:para>When the `-InputPath` parameter is used with a file path or URL. If the `Detect` format is used, the file extension will be used to automatically detect the format. When `-InputPath` is not used, `Detect` is the same as `None`.</maml:para> <maml:para>When this option is set to `File` PSRule scans the path and subdirectories specified by `-InputPath`. Files are treated as objects instead of being deserialized. Additional, PSRule uses the file extension as the object type. When files have no extension the whole file name is used.</maml:para> <maml:para>See `about_PSRule_Options` for details.</maml:para> <maml:para>This parameter takes precedence over the `Input.Format` option if set.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">None</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Yaml</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Json</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Markdown</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">PowerShellData</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">File</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Detect</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">InputFormat</command:parameterValue> <dev:type> <maml:name>InputFormat</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Detect</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Baseline</maml:name> <maml:description> <maml:para>Specifies an explicit baseline by name to use for evaluating rules. Baselines can contain filters and custom configuration that overrides the defaults.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BaselineOption</command:parameterValue> <dev:type> <maml:name>BaselineOption</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Convention</maml:name> <maml:description> <maml:para>Specifies conventions by name to execute in the pipeline when processing objects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Culture</maml:name> <maml:description> <maml:para>Specifies the culture to use for rule documentation and messages. By default, the culture of PowerShell is used.</maml:para> <maml:para>This option does not affect the culture used for the PSRule engine, which always uses the culture of PowerShell.</maml:para> <maml:para>The PowerShell cmdlet `Get-Culture` shows the current culture of PowerShell.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="m"> <maml:name>Module</maml:name> <maml:description> <maml:para>Search for rule definitions within a module. If no sources are specified by `-Path`, `-Module`, or options, the current working directory is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="n"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of a specific rule to evaluate. If this parameter is not specified all rules in search paths will be evaluated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ObjectPath</maml:name> <maml:description> <maml:para>The name of a property to use instead of the pipeline object. If the property specified by `ObjectPath` is a collection or an array, then each item in evaluated separately.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TargetType</maml:name> <maml:description> <maml:para>Filters input objects by TargetType.</maml:para> <maml:para>If specified, only objects with the specified TargetType are processed. Objects that do not match TargetType are ignored. If multiple values are specified, only one TargetType must match. This parameter is not case-sensitive.</maml:para> <maml:para>By default, all objects are processed.</maml:para> <maml:para>This parameter if set, overrides the `Input.TargetType` option.</maml:para> <maml:para>To change the field TargetType is bound to set the `Binding.TargetType` option. For details see the about_PSRule_Options help topic.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Option</maml:name> <maml:description> <maml:para>Additional options that configure execution. A `PSRuleOption` can be created by using the `New-PSRuleOption` cmdlet. Alternatively, a hashtable or path to YAML file can be specified with options.</maml:para> <maml:para>For more information on PSRule options see about_PSRule_Options.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSRuleOption</command:parameterValue> <dev:type> <maml:name>PSRuleOption</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OutputPath</maml:name> <maml:description> <maml:para>Specifies the output file path to write results. Directories along the file path will automatically be created if they do not exist.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="o"> <maml:name>OutputFormat</maml:name> <maml:description> <maml:para>Configures the format that output is written. This parameter has no affect when `-OutputPath` is not specified.</maml:para> <maml:para>The following format options are available:</maml:para> <maml:para>- None - Output is presented as an object using PowerShell defaults. This is the default. - Yaml - Output is serialized as YAML.</maml:para> <maml:para>- Json - Output is serialized as JSON.</maml:para> <maml:para>- Markdown - Output is serialized as Markdown.</maml:para> <maml:para>- NUnit3 - Output is serialized as NUnit3 (XML).</maml:para> <maml:para>- Csv - Output is serialized as a comma separated values (CSV).</maml:para> <maml:para></maml:para> <maml:para>The `Wide` format is not applicable to `Assert-PSRule`.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">None</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Yaml</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Json</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Markdown</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">NUnit3</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Csv</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">OutputFormat</command:parameterValue> <dev:type> <maml:name>OutputFormat</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Style</maml:name> <maml:description> <maml:para>Configures the style that results will be presented in.</maml:para> <maml:para>The following styles are available:</maml:para> <maml:para>- Client - Output is written to the host directly in green/ red to indicate outcome.</maml:para> <maml:para>- Plain - Output is written as an unformatted string.</maml:para> <maml:para>This option can be redirected to a file. - AzurePipelines - Output is written for integration Azure Pipelines.</maml:para> <maml:para>- GitHubActions - Output is written for integration GitHub Actions.</maml:para> <maml:para>- VisualStudioCode - Output is written for integration with Visual Studio Code.</maml:para> <maml:para>- Detect - Output style will be detected by checking the environment variables.</maml:para> <maml:para>This is the default.</maml:para> <maml:para>Detect uses the following logic:</maml:para> <maml:para>1. If the `TF_BUILD` environment variable is set to `true`, `AzurePipelines` will be used. 2. If the `GITHUB_ACTIONS` environment variable is set to `true`, `GitHubActions` will be used. 3. If the `TERM_PROGRAM` environment variable is set to `vscode`, `VisualStudioCode` will be used. 4. Use `Client`.</maml:para> <maml:para>Each of these styles outputs to the host. To capture output as a string redirect the information stream. For example: `6>&1`</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Client</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Plain</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AzurePipelines</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">GitHubActions</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">VisualStudioCode</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Detect</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">OutputStyle</command:parameterValue> <dev:type> <maml:name>OutputStyle</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Client</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>As</maml:name> <maml:description> <maml:para>The type of results to produce. Detailed results are generated by default.</maml:para> <maml:para>The following result formats are available:</maml:para> <maml:para>- `Detail` - Returns pass/ fail results for each rule per object.</maml:para> <maml:para>- `Summary` - Failure or errors are shown but passing results are summarized.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Detail</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Summary</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ResultFormat</command:parameterValue> <dev:type> <maml:name>ResultFormat</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Detail</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Outcome</maml:name> <maml:description> <maml:para>Filter output to only show rule results with a specific outcome.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Pass</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Fail</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Error</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">None</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Processed</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">All</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">RuleOutcome</command:parameterValue> <dev:type> <maml:name>RuleOutcome</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Pass, Fail, Error</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tag</maml:name> <maml:description> <maml:para>Only get rules with the specified tags set. If this parameter is not specified all rules in search paths will be returned.</maml:para> <maml:para>When more than one tag is used, all tags must match. Tags are not case sensitive. A tag value of `*` may be used to filter rules to any rule with the tag set, regardless of tag value.</maml:para> <maml:para>An array of tag values can be used to match a rule with either value. i.e. `severity = important, critical` matches rules with a category of either `important` or `critical`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResultVariable</maml:name> <maml:description> <maml:para>Stores output result objects in the specified variable.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Assert-PSRule</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="p"> <maml:name>Path</maml:name> <maml:description> <maml:para>One or more paths to search for rule definitions within. If no sources are specified by `-Path`, `-Module`, or options, the current working directory is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$PWD</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Format</maml:name> <maml:description> <maml:para>Configures the input format for when a string is passed in as a target object.</maml:para> <maml:para>When the `-InputObject` parameter or pipeline input is used, strings are treated as plain text by default. Set this option to either `Yaml`, `Json`, `Markdown`, `PowerShellData` to have PSRule deserialize the object.</maml:para> <maml:para>When the `-InputPath` parameter is used with a file path or URL. If the `Detect` format is used, the file extension will be used to automatically detect the format. When `-InputPath` is not used, `Detect` is the same as `None`.</maml:para> <maml:para>When this option is set to `File` PSRule scans the path and subdirectories specified by `-InputPath`. Files are treated as objects instead of being deserialized. Additional, PSRule uses the file extension as the object type. When files have no extension the whole file name is used.</maml:para> <maml:para>See `about_PSRule_Options` for details.</maml:para> <maml:para>This parameter takes precedence over the `Input.Format` option if set.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">None</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Yaml</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Json</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Markdown</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">PowerShellData</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">File</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Detect</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">InputFormat</command:parameterValue> <dev:type> <maml:name>InputFormat</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Detect</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Baseline</maml:name> <maml:description> <maml:para>Specifies an explicit baseline by name to use for evaluating rules. Baselines can contain filters and custom configuration that overrides the defaults.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BaselineOption</command:parameterValue> <dev:type> <maml:name>BaselineOption</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Convention</maml:name> <maml:description> <maml:para>Specifies conventions by name to execute in the pipeline when processing objects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Culture</maml:name> <maml:description> <maml:para>Specifies the culture to use for rule documentation and messages. By default, the culture of PowerShell is used.</maml:para> <maml:para>This option does not affect the culture used for the PSRule engine, which always uses the culture of PowerShell.</maml:para> <maml:para>The PowerShell cmdlet `Get-Culture` shows the current culture of PowerShell.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="m"> <maml:name>Module</maml:name> <maml:description> <maml:para>Search for rule definitions within a module. If no sources are specified by `-Path`, `-Module`, or options, the current working directory is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="n"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of a specific rule to evaluate. If this parameter is not specified all rules in search paths will be evaluated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ObjectPath</maml:name> <maml:description> <maml:para>The name of a property to use instead of the pipeline object. If the property specified by `ObjectPath` is a collection or an array, then each item in evaluated separately.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TargetType</maml:name> <maml:description> <maml:para>Filters input objects by TargetType.</maml:para> <maml:para>If specified, only objects with the specified TargetType are processed. Objects that do not match TargetType are ignored. If multiple values are specified, only one TargetType must match. This parameter is not case-sensitive.</maml:para> <maml:para>By default, all objects are processed.</maml:para> <maml:para>This parameter if set, overrides the `Input.TargetType` option.</maml:para> <maml:para>To change the field TargetType is bound to set the `Binding.TargetType` option. For details see the about_PSRule_Options help topic.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Option</maml:name> <maml:description> <maml:para>Additional options that configure execution. A `PSRuleOption` can be created by using the `New-PSRuleOption` cmdlet. Alternatively, a hashtable or path to YAML file can be specified with options.</maml:para> <maml:para>For more information on PSRule options see about_PSRule_Options.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSRuleOption</command:parameterValue> <dev:type> <maml:name>PSRuleOption</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OutputPath</maml:name> <maml:description> <maml:para>Specifies the output file path to write results. Directories along the file path will automatically be created if they do not exist.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="o"> <maml:name>OutputFormat</maml:name> <maml:description> <maml:para>Configures the format that output is written. This parameter has no affect when `-OutputPath` is not specified.</maml:para> <maml:para>The following format options are available:</maml:para> <maml:para>- None - Output is presented as an object using PowerShell defaults. This is the default. - Yaml - Output is serialized as YAML.</maml:para> <maml:para>- Json - Output is serialized as JSON.</maml:para> <maml:para>- Markdown - Output is serialized as Markdown.</maml:para> <maml:para>- NUnit3 - Output is serialized as NUnit3 (XML).</maml:para> <maml:para>- Csv - Output is serialized as a comma separated values (CSV).</maml:para> <maml:para></maml:para> <maml:para>The `Wide` format is not applicable to `Assert-PSRule`.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">None</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Yaml</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Json</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Markdown</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">NUnit3</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Csv</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">OutputFormat</command:parameterValue> <dev:type> <maml:name>OutputFormat</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Style</maml:name> <maml:description> <maml:para>Configures the style that results will be presented in.</maml:para> <maml:para>The following styles are available:</maml:para> <maml:para>- Client - Output is written to the host directly in green/ red to indicate outcome.</maml:para> <maml:para>- Plain - Output is written as an unformatted string.</maml:para> <maml:para>This option can be redirected to a file. - AzurePipelines - Output is written for integration Azure Pipelines.</maml:para> <maml:para>- GitHubActions - Output is written for integration GitHub Actions.</maml:para> <maml:para>- VisualStudioCode - Output is written for integration with Visual Studio Code.</maml:para> <maml:para>- Detect - Output style will be detected by checking the environment variables.</maml:para> <maml:para>This is the default.</maml:para> <maml:para>Detect uses the following logic:</maml:para> <maml:para>1. If the `TF_BUILD` environment variable is set to `true`, `AzurePipelines` will be used. 2. If the `GITHUB_ACTIONS` environment variable is set to `true`, `GitHubActions` will be used. 3. If the `TERM_PROGRAM` environment variable is set to `vscode`, `VisualStudioCode` will be used. 4. Use `Client`.</maml:para> <maml:para>Each of these styles outputs to the host. To capture output as a string redirect the information stream. For example: `6>&1`</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Client</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Plain</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AzurePipelines</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">GitHubActions</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">VisualStudioCode</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Detect</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">OutputStyle</command:parameterValue> <dev:type> <maml:name>OutputStyle</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Client</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>As</maml:name> <maml:description> <maml:para>The type of results to produce. Detailed results are generated by default.</maml:para> <maml:para>The following result formats are available:</maml:para> <maml:para>- `Detail` - Returns pass/ fail results for each rule per object.</maml:para> <maml:para>- `Summary` - Failure or errors are shown but passing results are summarized.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Detail</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Summary</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ResultFormat</command:parameterValue> <dev:type> <maml:name>ResultFormat</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Detail</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Outcome</maml:name> <maml:description> <maml:para>Filter output to only show rule results with a specific outcome.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Pass</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Fail</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Error</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">None</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Processed</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">All</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">RuleOutcome</command:parameterValue> <dev:type> <maml:name>RuleOutcome</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Pass, Fail, Error</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tag</maml:name> <maml:description> <maml:para>Only get rules with the specified tags set. If this parameter is not specified all rules in search paths will be returned.</maml:para> <maml:para>When more than one tag is used, all tags must match. Tags are not case sensitive. A tag value of `*` may be used to filter rules to any rule with the tag set, regardless of tag value.</maml:para> <maml:para>An array of tag values can be used to match a rule with either value. i.e. `severity = important, critical` matches rules with a category of either `important` or `critical`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="TargetObject"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The pipeline object to process rules for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResultVariable</maml:name> <maml:description> <maml:para>Stores output result objects in the specified variable.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="f"> <maml:name>InputPath</maml:name> <maml:description> <maml:para>Instead of processing objects from the pipeline, import objects file the specified file paths.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Format</maml:name> <maml:description> <maml:para>Configures the input format for when a string is passed in as a target object.</maml:para> <maml:para>When the `-InputObject` parameter or pipeline input is used, strings are treated as plain text by default. Set this option to either `Yaml`, `Json`, `Markdown`, `PowerShellData` to have PSRule deserialize the object.</maml:para> <maml:para>When the `-InputPath` parameter is used with a file path or URL. If the `Detect` format is used, the file extension will be used to automatically detect the format. When `-InputPath` is not used, `Detect` is the same as `None`.</maml:para> <maml:para>When this option is set to `File` PSRule scans the path and subdirectories specified by `-InputPath`. Files are treated as objects instead of being deserialized. Additional, PSRule uses the file extension as the object type. When files have no extension the whole file name is used.</maml:para> <maml:para>See `about_PSRule_Options` for details.</maml:para> <maml:para>This parameter takes precedence over the `Input.Format` option if set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">InputFormat</command:parameterValue> <dev:type> <maml:name>InputFormat</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Detect</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Baseline</maml:name> <maml:description> <maml:para>Specifies an explicit baseline by name to use for evaluating rules. Baselines can contain filters and custom configuration that overrides the defaults.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BaselineOption</command:parameterValue> <dev:type> <maml:name>BaselineOption</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Convention</maml:name> <maml:description> <maml:para>Specifies conventions by name to execute in the pipeline when processing objects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Culture</maml:name> <maml:description> <maml:para>Specifies the culture to use for rule documentation and messages. By default, the culture of PowerShell is used.</maml:para> <maml:para>This option does not affect the culture used for the PSRule engine, which always uses the culture of PowerShell.</maml:para> <maml:para>The PowerShell cmdlet `Get-Culture` shows the current culture of PowerShell.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="m"> <maml:name>Module</maml:name> <maml:description> <maml:para>Search for rule definitions within a module. If no sources are specified by `-Path`, `-Module`, or options, the current working directory is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="n"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of a specific rule to evaluate. If this parameter is not specified all rules in search paths will be evaluated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ObjectPath</maml:name> <maml:description> <maml:para>The name of a property to use instead of the pipeline object. If the property specified by `ObjectPath` is a collection or an array, then each item in evaluated separately.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TargetType</maml:name> <maml:description> <maml:para>Filters input objects by TargetType.</maml:para> <maml:para>If specified, only objects with the specified TargetType are processed. Objects that do not match TargetType are ignored. If multiple values are specified, only one TargetType must match. This parameter is not case-sensitive.</maml:para> <maml:para>By default, all objects are processed.</maml:para> <maml:para>This parameter if set, overrides the `Input.TargetType` option.</maml:para> <maml:para>To change the field TargetType is bound to set the `Binding.TargetType` option. For details see the about_PSRule_Options help topic.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Option</maml:name> <maml:description> <maml:para>Additional options that configure execution. A `PSRuleOption` can be created by using the `New-PSRuleOption` cmdlet. Alternatively, a hashtable or path to YAML file can be specified with options.</maml:para> <maml:para>For more information on PSRule options see about_PSRule_Options.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSRuleOption</command:parameterValue> <dev:type> <maml:name>PSRuleOption</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OutputPath</maml:name> <maml:description> <maml:para>Specifies the output file path to write results. Directories along the file path will automatically be created if they do not exist.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="o"> <maml:name>OutputFormat</maml:name> <maml:description> <maml:para>Configures the format that output is written. This parameter has no affect when `-OutputPath` is not specified.</maml:para> <maml:para>The following format options are available:</maml:para> <maml:para>- None - Output is presented as an object using PowerShell defaults. This is the default. - Yaml - Output is serialized as YAML.</maml:para> <maml:para>- Json - Output is serialized as JSON.</maml:para> <maml:para>- Markdown - Output is serialized as Markdown.</maml:para> <maml:para>- NUnit3 - Output is serialized as NUnit3 (XML).</maml:para> <maml:para>- Csv - Output is serialized as a comma separated values (CSV).</maml:para> <maml:para></maml:para> <maml:para>The `Wide` format is not applicable to `Assert-PSRule`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">OutputFormat</command:parameterValue> <dev:type> <maml:name>OutputFormat</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Style</maml:name> <maml:description> <maml:para>Configures the style that results will be presented in.</maml:para> <maml:para>The following styles are available:</maml:para> <maml:para>- Client - Output is written to the host directly in green/ red to indicate outcome.</maml:para> <maml:para>- Plain - Output is written as an unformatted string.</maml:para> <maml:para>This option can be redirected to a file. - AzurePipelines - Output is written for integration Azure Pipelines.</maml:para> <maml:para>- GitHubActions - Output is written for integration GitHub Actions.</maml:para> <maml:para>- VisualStudioCode - Output is written for integration with Visual Studio Code.</maml:para> <maml:para>- Detect - Output style will be detected by checking the environment variables.</maml:para> <maml:para>This is the default.</maml:para> <maml:para>Detect uses the following logic:</maml:para> <maml:para>1. If the `TF_BUILD` environment variable is set to `true`, `AzurePipelines` will be used. 2. If the `GITHUB_ACTIONS` environment variable is set to `true`, `GitHubActions` will be used. 3. If the `TERM_PROGRAM` environment variable is set to `vscode`, `VisualStudioCode` will be used. 4. Use `Client`.</maml:para> <maml:para>Each of these styles outputs to the host. To capture output as a string redirect the information stream. For example: `6>&1`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">OutputStyle</command:parameterValue> <dev:type> <maml:name>OutputStyle</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Client</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>As</maml:name> <maml:description> <maml:para>The type of results to produce. Detailed results are generated by default.</maml:para> <maml:para>The following result formats are available:</maml:para> <maml:para>- `Detail` - Returns pass/ fail results for each rule per object.</maml:para> <maml:para>- `Summary` - Failure or errors are shown but passing results are summarized.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ResultFormat</command:parameterValue> <dev:type> <maml:name>ResultFormat</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Detail</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Outcome</maml:name> <maml:description> <maml:para>Filter output to only show rule results with a specific outcome.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RuleOutcome</command:parameterValue> <dev:type> <maml:name>RuleOutcome</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Pass, Fail, Error</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="p"> <maml:name>Path</maml:name> <maml:description> <maml:para>One or more paths to search for rule definitions within. If no sources are specified by `-Path`, `-Module`, or options, the current working directory is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$PWD</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tag</maml:name> <maml:description> <maml:para>Only get rules with the specified tags set. If this parameter is not specified all rules in search paths will be returned.</maml:para> <maml:para>When more than one tag is used, all tags must match. Tags are not case sensitive. A tag value of `*` may be used to filter rules to any rule with the tag set, regardless of tag value.</maml:para> <maml:para>An array of tag values can be used to match a rule with either value. i.e. `severity = important, critical` matches rules with a category of either `important` or `critical`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="TargetObject"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The pipeline object to process rules for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResultVariable</maml:name> <maml:description> <maml:para>Stores output result objects in the specified variable.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> </dev:type> <maml:description> <maml:para>You can pipe any object to Assert-PSRule .</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>@{ Name = 'Item 1' } | Assert-PSRule;</dev:code> <dev:remarks> <maml:para>Evaluate a simple hashtable on the pipeline against rules loaded from the current working path.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code># Define objects to validate $items = @(); $items += [PSCustomObject]@{ Name = 'Fridge' }; $items += [PSCustomObject]@{ Name = 'Apple' }; # Validate each item using rules saved in current working path $items | Assert-PSRule -Path .\docs\scenarios\fruit\ -> Fridge : System.Management.Automation.PSCustomObject [FAIL] isFruit -> Apple : System.Management.Automation.PSCustomObject [PASS] isFruit Assert-PSRule : One or more rules reported failure. At line:1 char:10 + $items | Assert-PSRule -Path .\docs\scenarios\fruit\ + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + CategoryInfo : InvalidData: (:) [Assert-PSRule], FailPipelineException + FullyQualifiedErrorId : PSRule.Fail,Assert-PSRule</dev:code> <dev:remarks> <maml:para>Evaluate an array of objects on the pipeline against rules loaded a specified relative path.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>$items | Assert-PSRule -Module PSRule.Rules.Azure -o NUnit3 -OutputPath .\reports\results.xml</dev:code> <dev:remarks> <maml:para>Evaluate items from a pre-installed rules module PSRule.Rules.Azure. Additionally save the results as a NUnit report.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>$items | Assert-PSRule -Path .\docs\scenarios\fruit\ -ResultVariable resultRecords;</dev:code> <dev:remarks> <maml:para>Evaluate items and additionally save the results into a variable `resultRecords`.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://microsoft.github.io/PSRule/v1/commands/PSRule/en-US/Assert-PSRule/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-PSRule</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-PSRule</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Test-PSRuleTarget</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Export-PSRuleBaseline</command:name> <command:verb>Export</command:verb> <command:noun>PSRuleBaseline</command:noun> <maml:description> <maml:para>Exports a list of baselines.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Exports a list of baselines to a file.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Export-PSRuleBaseline</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="p"> <maml:name>Path</maml:name> <maml:description> <maml:para>One or more paths to search for baselines within. If no sources are specified by `-Path`, `-Module`, or options, the current working directory is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$PWD</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="m"> <maml:name>Module</maml:name> <maml:description> <maml:para>Search for baselines definitions within a module. If no sources are specified by `-Path`, `-Module`, or options, the current working directory is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="named" aliases="n"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of a specific baseline to list. If this parameter is not specified all baselines in search paths will be listed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Option</maml:name> <maml:description> <maml:para>Additional options that configure execution. A `PSRuleOption` can be created by using the `New-PSRuleOption` cmdlet. Alternatively a hashtable or path to YAML file can be specified with options.</maml:para> <maml:para>For more information on PSRule options see about_PSRule_Options.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSRuleOption</command:parameterValue> <dev:type> <maml:name>PSRuleOption</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Culture</maml:name> <maml:description> <maml:para>Specifies the culture to use for documentation and messages. By default, the culture of PowerShell is used.</maml:para> <maml:para>This option does not affect the culture used for the PSRule engine, which always uses the culture of PowerShell.</maml:para> <maml:para>The PowerShell cmdlet `Get-Culture` shows the current culture of PowerShell.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="o"> <maml:name>OutputFormat</maml:name> <maml:description> <maml:para>Configures the format that output is presented in.</maml:para> <maml:para>The following format options are available:</maml:para> <maml:para>- Yaml - Output is serialized as YAML. This is the default.</maml:para> <maml:para>- Json - Output is serialized as JSON.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Yaml</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Json</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">OutputFormat</command:parameterValue> <dev:type> <maml:name>OutputFormat</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Yaml</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OutputEncoding</maml:name> <maml:description> <maml:para>Sets the option `Output.Encoding`. The `Output.Encoding` option configured the encoding used to write results to file.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Default</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">UTF8</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">UTF7</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Unicode</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">UTF32</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ASCII</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">OutputEncoding</command:parameterValue> <dev:type> <maml:name>OutputEncoding</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OutputPath</maml:name> <maml:description> <maml:para>Sets the option `Output.Path`. The `Output.Path` option configures the output path the results are written to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="m"> <maml:name>Module</maml:name> <maml:description> <maml:para>Search for baselines definitions within a module. If no sources are specified by `-Path`, `-Module`, or options, the current working directory is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="p"> <maml:name>Path</maml:name> <maml:description> <maml:para>One or more paths to search for baselines within. If no sources are specified by `-Path`, `-Module`, or options, the current working directory is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$PWD</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="named" aliases="n"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of a specific baseline to list. If this parameter is not specified all baselines in search paths will be listed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Option</maml:name> <maml:description> <maml:para>Additional options that configure execution. A `PSRuleOption` can be created by using the `New-PSRuleOption` cmdlet. Alternatively a hashtable or path to YAML file can be specified with options.</maml:para> <maml:para>For more information on PSRule options see about_PSRule_Options.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSRuleOption</command:parameterValue> <dev:type> <maml:name>PSRuleOption</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Culture</maml:name> <maml:description> <maml:para>Specifies the culture to use for documentation and messages. By default, the culture of PowerShell is used.</maml:para> <maml:para>This option does not affect the culture used for the PSRule engine, which always uses the culture of PowerShell.</maml:para> <maml:para>The PowerShell cmdlet `Get-Culture` shows the current culture of PowerShell.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="o"> <maml:name>OutputFormat</maml:name> <maml:description> <maml:para>Configures the format that output is presented in.</maml:para> <maml:para>The following format options are available:</maml:para> <maml:para>- Yaml - Output is serialized as YAML. This is the default.</maml:para> <maml:para>- Json - Output is serialized as JSON.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">OutputFormat</command:parameterValue> <dev:type> <maml:name>OutputFormat</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Yaml</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OutputEncoding</maml:name> <maml:description> <maml:para>Sets the option `Output.Encoding`. The `Output.Encoding` option configured the encoding used to write results to file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">OutputEncoding</command:parameterValue> <dev:type> <maml:name>OutputEncoding</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OutputPath</maml:name> <maml:description> <maml:para>Sets the option `Output.Path`. The `Output.Path` option configures the output path the results are written to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Export-PSRuleBaseline -Module PSRule.Rules.Azure -OutputFormat Yaml -OutputPath Baseline.Rule.yml</dev:code> <dev:remarks> <maml:para>Exports list of baselines from `PSRule.Rules.Azure` module to file `Baseline.Rule.yml` in YAML output format.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://microsoft.github.io/PSRule/v1/commands/PSRule/en-US/Export-PSRuleBaseline/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-PSRuleBaseline</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-PSRule</command:name> <command:verb>Get</command:verb> <command:noun>PSRule</command:noun> <maml:description> <maml:para>Get a list of rule definitions.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get a list of matching rule definitions within the search path.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PSRule</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="p"> <maml:name>Path</maml:name> <maml:description> <maml:para>One or more paths to search for rule definitions within. If no sources are specified by `-Path`, `-Module`, or options, the current working directory is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$PWD</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="n"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of a specific rule to list. If this parameter is not specified all rules in search paths will be listed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tag</maml:name> <maml:description> <maml:para>Only get rules with the specified tags set. If this parameter is not specified all rules in search paths will be returned.</maml:para> <maml:para>When more than one tag is used, all tags must match. Tags are not case sensitive. A tag value of `*` may be used to filter rules to any rule with the tag set, regardless of tag value.</maml:para> <maml:para>An array of tag values can be used to match a rule with either value. i.e. `severity = important, critical` matches rules with a category of either `important` or `critical`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Option</maml:name> <maml:description> <maml:para>Additional options that configure execution. A `PSRuleOption` can be created by using the `New-PSRuleOption` cmdlet. Alternatively a hashtable or path to YAML file can be specified with options.</maml:para> <maml:para>For more information on PSRule options see about_PSRule_Options.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSRuleOption</command:parameterValue> <dev:type> <maml:name>PSRuleOption</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ListAvailable</maml:name> <maml:description> <maml:para>Look for modules containing rule definitions including modules that are currently not imported.</maml:para> <maml:para>This switch is used with the `-Module` parameter.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="m"> <maml:name>Module</maml:name> <maml:description> <maml:para>Search for rule definitions within a module. If no sources are specified by `-Path`, `-Module`, or options, the current working directory is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Culture</maml:name> <maml:description> <maml:para>Specifies the culture to use for documentation and messages. By default, the culture of PowerShell is used.</maml:para> <maml:para>This option does not affect the culture used for the PSRule engine, which always uses the culture of PowerShell.</maml:para> <maml:para>The PowerShell cmdlet `Get-Culture` shows the current culture of PowerShell.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="o"> <maml:name>OutputFormat</maml:name> <maml:description> <maml:para>Configures the format that output is presented in.</maml:para> <maml:para>The following format options are available:</maml:para> <maml:para>- None - Output is presented as an object using PowerShell defaults. This is the default.</maml:para> <maml:para>- Wide - Output is presented using the wide table format, which includes tags and wraps columns.</maml:para> <maml:para>- Yaml - Output is serialized as YAML.</maml:para> <maml:para>- Json - Output is serialized as JSON.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">None</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Wide</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Yaml</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Json</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">OutputFormat</command:parameterValue> <dev:type> <maml:name>OutputFormat</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeDependencies</maml:name> <maml:description> <maml:para>When this switch is specified, dependencies of the rules that meet the `-Name` and `-Tag` filters are included even if they would normally be excluded.</maml:para> <maml:para>This switch has no affect when getting an unfiltered list of rules.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Baseline</maml:name> <maml:description> <maml:para>When specified, rules are filtered so that only rules that are included in the baselines are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BaselineOption</command:parameterValue> <dev:type> <maml:name>BaselineOption</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="n"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of a specific rule to list. If this parameter is not specified all rules in search paths will be listed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="p"> <maml:name>Path</maml:name> <maml:description> <maml:para>One or more paths to search for rule definitions within. If no sources are specified by `-Path`, `-Module`, or options, the current working directory is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$PWD</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tag</maml:name> <maml:description> <maml:para>Only get rules with the specified tags set. If this parameter is not specified all rules in search paths will be returned.</maml:para> <maml:para>When more than one tag is used, all tags must match. Tags are not case sensitive. A tag value of `*` may be used to filter rules to any rule with the tag set, regardless of tag value.</maml:para> <maml:para>An array of tag values can be used to match a rule with either value. i.e. `severity = important, critical` matches rules with a category of either `important` or `critical`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Option</maml:name> <maml:description> <maml:para>Additional options that configure execution. A `PSRuleOption` can be created by using the `New-PSRuleOption` cmdlet. Alternatively a hashtable or path to YAML file can be specified with options.</maml:para> <maml:para>For more information on PSRule options see about_PSRule_Options.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSRuleOption</command:parameterValue> <dev:type> <maml:name>PSRuleOption</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ListAvailable</maml:name> <maml:description> <maml:para>Look for modules containing rule definitions including modules that are currently not imported.</maml:para> <maml:para>This switch is used with the `-Module` parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="m"> <maml:name>Module</maml:name> <maml:description> <maml:para>Search for rule definitions within a module. If no sources are specified by `-Path`, `-Module`, or options, the current working directory is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Culture</maml:name> <maml:description> <maml:para>Specifies the culture to use for documentation and messages. By default, the culture of PowerShell is used.</maml:para> <maml:para>This option does not affect the culture used for the PSRule engine, which always uses the culture of PowerShell.</maml:para> <maml:para>The PowerShell cmdlet `Get-Culture` shows the current culture of PowerShell.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="o"> <maml:name>OutputFormat</maml:name> <maml:description> <maml:para>Configures the format that output is presented in.</maml:para> <maml:para>The following format options are available:</maml:para> <maml:para>- None - Output is presented as an object using PowerShell defaults. This is the default.</maml:para> <maml:para>- Wide - Output is presented using the wide table format, which includes tags and wraps columns.</maml:para> <maml:para>- Yaml - Output is serialized as YAML.</maml:para> <maml:para>- Json - Output is serialized as JSON.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">OutputFormat</command:parameterValue> <dev:type> <maml:name>OutputFormat</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeDependencies</maml:name> <maml:description> <maml:para>When this switch is specified, dependencies of the rules that meet the `-Name` and `-Tag` filters are included even if they would normally be excluded.</maml:para> <maml:para>This switch has no affect when getting an unfiltered list of rules.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Baseline</maml:name> <maml:description> <maml:para>When specified, rules are filtered so that only rules that are included in the baselines are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BaselineOption</command:parameterValue> <dev:type> <maml:name>BaselineOption</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PSRule.Rules.Rule</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-PSRule; RuleName ModuleName Synopsis -------- ---------- -------- isFruit An example rule</dev:code> <dev:remarks> <maml:para>Get a list of rule definitions from the current working path.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-PSRule -Module PSRule.Rules.Azure; RuleName ModuleName Synopsis -------- ---------- -------- Azure.ACR.AdminUser PSRule.Rules.Azure Use Azure AD accounts instead of using the registry adm… Azure.ACR.MinSku PSRule.Rules.Azure ACR should use the Premium or Standard SKU for producti… Azure.AKS.MinNodeCount PSRule.Rules.Azure AKS clusters should have minimum number of nodes for fa… Azure.AKS.Version PSRule.Rules.Azure AKS clusters should meet the minimum version. Azure.AKS.UseRBAC PSRule.Rules.Azure AKS cluster should use role-based access control (RBAC).</dev:code> <dev:remarks> <maml:para>Get a list of rule definitions included in the module `PSRule.Rules.Azure`.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Get-PSRule -Module PSRule.Rules.Azure -OutputFormat Wide; RuleName ModuleName Synopsis Tag -------- ---------- -------- --- Azure.ACR.AdminUser PSRule.Rules.Azure Use Azure AD accounts severity='Critical' instead of using the category='Security registry admin user. configuration' Azure.ACR.MinSku PSRule.Rules.Azure ACR should use the Premium severity='Important' or Standard SKU for category='Performance' production deployments. Azure.AKS.MinNodeCount PSRule.Rules.Azure AKS clusters should have severity='Important' minimum number of nodes for category='Reliability' failover and updates. Azure.AKS.Version PSRule.Rules.Azure AKS clusters should meet severity='Important' the minimum version. category='Operations management' Azure.AKS.UseRBAC PSRule.Rules.Azure AKS cluster should use severity='Important' role-based access control category='Security (RBAC). configuration'</dev:code> <dev:remarks> <maml:para>Get a list of rule definitions included in the module `PSRule.Rules.Azure` including tags with line wrapping.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://microsoft.github.io/PSRule/v1/commands/PSRule/en-US/Get-PSRule/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-PSRule</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-PSRuleBaseline</command:name> <command:verb>Get</command:verb> <command:noun>PSRuleBaseline</command:noun> <maml:description> <maml:para>Get a list of baselines.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get a list of matching baselines within the search path.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PSRuleBaseline</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="p"> <maml:name>Path</maml:name> <maml:description> <maml:para>One or more paths to search for baselines within. If no sources are specified by `-Path`, `-Module`, or options, the current working directory is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$PWD</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="m"> <maml:name>Module</maml:name> <maml:description> <maml:para>Search for baselines definitions within a module. If no sources are specified by `-Path`, `-Module`, or options, the current working directory is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ListAvailable</maml:name> <maml:description> <maml:para>Look for modules containing baselines including modules that are currently not imported.</maml:para> <maml:para>This switch is used with the `-Module` parameter.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="n"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of a specific baseline to list. If this parameter is not specified all baselines in search paths will be listed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Option</maml:name> <maml:description> <maml:para>Additional options that configure execution. A `PSRuleOption` can be created by using the `New-PSRuleOption` cmdlet. Alternatively a hashtable or path to YAML file can be specified with options.</maml:para> <maml:para>For more information on PSRule options see about_PSRule_Options.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSRuleOption</command:parameterValue> <dev:type> <maml:name>PSRuleOption</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Culture</maml:name> <maml:description> <maml:para>Specifies the culture to use for documentation and messages. By default, the culture of PowerShell is used.</maml:para> <maml:para>This option does not affect the culture used for the PSRule engine, which always uses the culture of PowerShell.</maml:para> <maml:para>The PowerShell cmdlet `Get-Culture` shows the current culture of PowerShell.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="o"> <maml:name>OutputFormat</maml:name> <maml:description> <maml:para>Configures the format that output is presented in.</maml:para> <maml:para>The following format options are available:</maml:para> <maml:para>- None - Output is presented as an object using PowerShell defaults. This is the default.</maml:para> <maml:para>- Yaml - Output is serialized as YAML.</maml:para> <maml:para>- Json - Output is serialized as JSON.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">None</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Yaml</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Json</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">OutputFormat</command:parameterValue> <dev:type> <maml:name>OutputFormat</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="m"> <maml:name>Module</maml:name> <maml:description> <maml:para>Search for baselines definitions within a module. If no sources are specified by `-Path`, `-Module`, or options, the current working directory is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ListAvailable</maml:name> <maml:description> <maml:para>Look for modules containing baselines including modules that are currently not imported.</maml:para> <maml:para>This switch is used with the `-Module` parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="p"> <maml:name>Path</maml:name> <maml:description> <maml:para>One or more paths to search for baselines within. If no sources are specified by `-Path`, `-Module`, or options, the current working directory is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$PWD</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="n"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of a specific baseline to list. If this parameter is not specified all baselines in search paths will be listed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Option</maml:name> <maml:description> <maml:para>Additional options that configure execution. A `PSRuleOption` can be created by using the `New-PSRuleOption` cmdlet. Alternatively a hashtable or path to YAML file can be specified with options.</maml:para> <maml:para>For more information on PSRule options see about_PSRule_Options.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSRuleOption</command:parameterValue> <dev:type> <maml:name>PSRuleOption</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Culture</maml:name> <maml:description> <maml:para>Specifies the culture to use for documentation and messages. By default, the culture of PowerShell is used.</maml:para> <maml:para>This option does not affect the culture used for the PSRule engine, which always uses the culture of PowerShell.</maml:para> <maml:para>The PowerShell cmdlet `Get-Culture` shows the current culture of PowerShell.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="o"> <maml:name>OutputFormat</maml:name> <maml:description> <maml:para>Configures the format that output is presented in.</maml:para> <maml:para>The following format options are available:</maml:para> <maml:para>- None - Output is presented as an object using PowerShell defaults. This is the default.</maml:para> <maml:para>- Yaml - Output is serialized as YAML.</maml:para> <maml:para>- Json - Output is serialized as JSON.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">OutputFormat</command:parameterValue> <dev:type> <maml:name>OutputFormat</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PSRule.Definitions.Baseline</maml:name> </dev:type> <maml:description> <maml:para>This is the default.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>When you use `-OutputFormat Yaml` or `-OutputFormat Json`.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-PSRuleBaseline;</dev:code> <dev:remarks> <maml:para>Get a list of baselines from the current working path.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://microsoft.github.io/PSRule/v1/commands/PSRule/en-US/Get-PSRuleBaseline/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-PSRule</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-PSRuleHelp</command:name> <command:verb>Get</command:verb> <command:noun>PSRuleHelp</command:noun> <maml:description> <maml:para>Displays information about a rule.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-PSRuleHelp` cmdlet display information about a rule.</maml:para> <maml:para>By default, this cmdlet will look for rules in the current path and loaded modules. To get help for a specific rule or module use the `-Name` or `-Module` parameters.</maml:para> <maml:para>If the rule has an online version of the documentation, use the `-Online` parameter to view it in your default web browser.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PSRuleHelp</maml:name> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="1" aliases="n"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the rule to get documentation for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="p"> <maml:name>Path</maml:name> <maml:description> <maml:para>A path to check documentation for. By default, help from the current working path and loaded modules is listed. Results can be filtered by using `-Name`, `-Path` or `-Module`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="m"> <maml:name>Module</maml:name> <maml:description> <maml:para>Limit returned information to rules in the specified module. By default, help from the current working path and loaded modules is listed. Results can be filtered by using `-Name`, `-Path` or `-Module`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Culture</maml:name> <maml:description> <maml:para>Specifies the culture to use for rule documentation and messages. By default, the culture of PowerShell is used.</maml:para> <maml:para>This option does not affect the culture used for the PSRule engine, which always uses the culture of PowerShell.</maml:para> <maml:para>The PowerShell cmdlet `Get-Culture` shows the current culture of PowerShell.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Online</maml:name> <maml:description> <maml:para>Instead of displaying documentation within PowerShell, browse to the online version using the default web browser.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Full</maml:name> <maml:description> <maml:para>Display additional information such as notes and links.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Option</maml:name> <maml:description> <maml:para>Additional options that configure execution. A `PSRuleOption` can be created by using the `New-PSRuleOption` cmdlet. Alternatively a hashtable or path to YAML file can be specified with options.</maml:para> <maml:para>For more information on PSRule options see about_PSRule_Options.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSRuleOption</command:parameterValue> <dev:type> <maml:name>PSRuleOption</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="1" aliases="n"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the rule to get documentation for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="p"> <maml:name>Path</maml:name> <maml:description> <maml:para>A path to check documentation for. By default, help from the current working path and loaded modules is listed. Results can be filtered by using `-Name`, `-Path` or `-Module`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="m"> <maml:name>Module</maml:name> <maml:description> <maml:para>Limit returned information to rules in the specified module. By default, help from the current working path and loaded modules is listed. Results can be filtered by using `-Name`, `-Path` or `-Module`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Culture</maml:name> <maml:description> <maml:para>Specifies the culture to use for rule documentation and messages. By default, the culture of PowerShell is used.</maml:para> <maml:para>This option does not affect the culture used for the PSRule engine, which always uses the culture of PowerShell.</maml:para> <maml:para>The PowerShell cmdlet `Get-Culture` shows the current culture of PowerShell.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Online</maml:name> <maml:description> <maml:para>Instead of displaying documentation within PowerShell, browse to the online version using the default web browser.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Full</maml:name> <maml:description> <maml:para>Display additional information such as notes and links.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Option</maml:name> <maml:description> <maml:para>Additional options that configure execution. A `PSRuleOption` can be created by using the `New-PSRuleOption` cmdlet. Alternatively a hashtable or path to YAML file can be specified with options.</maml:para> <maml:para>For more information on PSRule options see about_PSRule_Options.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSRuleOption</command:parameterValue> <dev:type> <maml:name>PSRuleOption</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PSRule.Rules.RuleHelpInfo</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-PSRuleHelp;</dev:code> <dev:remarks> <maml:para>Get a list of rule help within the current path or loaded modules.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-PSRuleHelp Azure.ACR.AdminUser;</dev:code> <dev:remarks> <maml:para>Get rule documentation for the rule `Azure.ACR.AdminUser`.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Get-PSRuleHelp Azure.ACR.AdminUser -Online;</dev:code> <dev:remarks> <maml:para>Browse to the online version of documentation for `Azure.ACR.AdminUser` using the default web browser.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://microsoft.github.io/PSRule/v1/commands/PSRule/en-US/Get-PSRuleHelp/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-PSRuleTarget</command:name> <command:verb>Get</command:verb> <command:noun>PSRuleTarget</command:noun> <maml:description> <maml:para>Get a list of target objects.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get a list of target objects from input.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PSRuleTarget</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="f"> <maml:name>InputPath</maml:name> <maml:description> <maml:para>Instead of processing objects from the pipeline, import objects file the specified file paths.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Format</maml:name> <maml:description> <maml:para>Configures the input format for when a string is passed in as a target object.</maml:para> <maml:para>When the `-InputObject` parameter or pipeline input is used, strings are treated as plain text by default. Set this option to either `Yaml`, `Json`, `Markdown`, `PowerShellData` to have PSRule deserialize the object.</maml:para> <maml:para>When the `-InputPath` parameter is used with a file path or URL. If the `Detect` format is used, the file extension will be used to automatically detect the format. When `-InputPath` is not used, `Detect` is the same as `None`.</maml:para> <maml:para>See `about_PSRule_Options` for details.</maml:para> <maml:para>This parameter takes precedence over the `Input.Format` option if set.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">None</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Yaml</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Json</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Markdown</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">PowerShellData</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">File</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Detect</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">InputFormat</command:parameterValue> <dev:type> <maml:name>InputFormat</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Detect</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Option</maml:name> <maml:description> <maml:para>Additional options that configure execution. A `PSRuleOption` can be created by using the `New-PSRuleOption` cmdlet. Alternatively, a hashtable or path to YAML file can be specified with options.</maml:para> <maml:para>For more information on PSRule options see about_PSRule_Options.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSRuleOption</command:parameterValue> <dev:type> <maml:name>PSRuleOption</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ObjectPath</maml:name> <maml:description> <maml:para>The name of a property to use instead of the pipeline object. If the property specified by `ObjectPath` is a collection or an array, then each item in evaluated separately.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PSRuleTarget</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Format</maml:name> <maml:description> <maml:para>Configures the input format for when a string is passed in as a target object.</maml:para> <maml:para>When the `-InputObject` parameter or pipeline input is used, strings are treated as plain text by default. Set this option to either `Yaml`, `Json`, `Markdown`, `PowerShellData` to have PSRule deserialize the object.</maml:para> <maml:para>When the `-InputPath` parameter is used with a file path or URL. If the `Detect` format is used, the file extension will be used to automatically detect the format. When `-InputPath` is not used, `Detect` is the same as `None`.</maml:para> <maml:para>See `about_PSRule_Options` for details.</maml:para> <maml:para>This parameter takes precedence over the `Input.Format` option if set.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">None</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Yaml</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Json</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Markdown</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">PowerShellData</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">File</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Detect</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">InputFormat</command:parameterValue> <dev:type> <maml:name>InputFormat</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Detect</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Option</maml:name> <maml:description> <maml:para>Additional options that configure execution. A `PSRuleOption` can be created by using the `New-PSRuleOption` cmdlet. Alternatively, a hashtable or path to YAML file can be specified with options.</maml:para> <maml:para>For more information on PSRule options see about_PSRule_Options.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSRuleOption</command:parameterValue> <dev:type> <maml:name>PSRuleOption</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ObjectPath</maml:name> <maml:description> <maml:para>The name of a property to use instead of the pipeline object. If the property specified by `ObjectPath` is a collection or an array, then each item in evaluated separately.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="TargetObject"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The pipeline object to process rules for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="f"> <maml:name>InputPath</maml:name> <maml:description> <maml:para>Instead of processing objects from the pipeline, import objects file the specified file paths.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Format</maml:name> <maml:description> <maml:para>Configures the input format for when a string is passed in as a target object.</maml:para> <maml:para>When the `-InputObject` parameter or pipeline input is used, strings are treated as plain text by default. Set this option to either `Yaml`, `Json`, `Markdown`, `PowerShellData` to have PSRule deserialize the object.</maml:para> <maml:para>When the `-InputPath` parameter is used with a file path or URL. If the `Detect` format is used, the file extension will be used to automatically detect the format. When `-InputPath` is not used, `Detect` is the same as `None`.</maml:para> <maml:para>See `about_PSRule_Options` for details.</maml:para> <maml:para>This parameter takes precedence over the `Input.Format` option if set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">InputFormat</command:parameterValue> <dev:type> <maml:name>InputFormat</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Detect</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Option</maml:name> <maml:description> <maml:para>Additional options that configure execution. A `PSRuleOption` can be created by using the `New-PSRuleOption` cmdlet. Alternatively, a hashtable or path to YAML file can be specified with options.</maml:para> <maml:para>For more information on PSRule options see about_PSRule_Options.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSRuleOption</command:parameterValue> <dev:type> <maml:name>PSRuleOption</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ObjectPath</maml:name> <maml:description> <maml:para>The name of a property to use instead of the pipeline object. If the property specified by `ObjectPath` is a collection or an array, then each item in evaluated separately.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="TargetObject"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The pipeline object to process rules for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-PSRuleTarget -InputPath .\resources.json;</dev:code> <dev:remarks> <maml:para>Get target objects from `resources.json`.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://microsoft.github.io/PSRule/v1/commands/PSRule/en-US/Get-PSRuleTarget/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-PSRule</command:name> <command:verb>Invoke</command:verb> <command:noun>PSRule</command:noun> <maml:description> <maml:para>Evaluate objects against matching rules and output the results.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Evaluate objects against matching rules and output the results. Objects can be specified directly from the pipeline or provided from file.</maml:para> <maml:para>The commands `Invoke-PSRule` and `Assert-PSRule` provide similar functionality, as differ as follows:</maml:para> <maml:para>- `Invoke-PSRule` writes results as structured objects</maml:para> <maml:para>- `Assert-PSRule` writes results as a formatted string.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-PSRule</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="p"> <maml:name>Path</maml:name> <maml:description> <maml:para>One or more paths to search for rule definitions within. If no sources are specified by `-Path`, `-Module`, or options, the current working directory is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$PWD</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="n"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of a specific rule to evaluate. If this parameter is not specified all rules in search paths will be evaluated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Outcome</maml:name> <maml:description> <maml:para>Filter output to only show rule results with a specific outcome.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Pass</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Fail</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Error</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">None</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Processed</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">All</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">RuleOutcome</command:parameterValue> <dev:type> <maml:name>RuleOutcome</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Pass, Fail, Error</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tag</maml:name> <maml:description> <maml:para>Only get rules with the specified tags set. If this parameter is not specified all rules in search paths will be returned.</maml:para> <maml:para>When more than one tag is used, all tags must match. Tags are not case sensitive. A tag value of `*` may be used to filter rules to any rule with the tag set, regardless of tag value.</maml:para> <maml:para>An array of tag values can be used to match a rule with either value. i.e. `severity = important, critical` matches rules with a category of either `important` or `critical`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="TargetObject"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The pipeline object to process rules for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Option</maml:name> <maml:description> <maml:para>Additional options that configure execution. A `PSRuleOption` can be created by using the `New-PSRuleOption` cmdlet. Alternatively, a hashtable or path to YAML file can be specified with options.</maml:para> <maml:para>For more information on PSRule options see about_PSRule_Options.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSRuleOption</command:parameterValue> <dev:type> <maml:name>PSRuleOption</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>As</maml:name> <maml:description> <maml:para>The type of results to produce. Detailed results are generated by default.</maml:para> <maml:para>The following result formats are available:</maml:para> <maml:para>- `Detail` - Returns pass/ fail results for each rule per object.</maml:para> <maml:para>- `Summary` - Returns summarized results for the rule and the worst outcome.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Detail</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Summary</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ResultFormat</command:parameterValue> <dev:type> <maml:name>ResultFormat</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Detail</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Format</maml:name> <maml:description> <maml:para>Configures the input format for when a string is passed in as a target object.</maml:para> <maml:para>When the `-InputObject` parameter or pipeline input is used, strings are treated as plain text by default. Set this option to either `Yaml`, `Json`, `Markdown`, `PowerShellData` to have PSRule deserialize the object.</maml:para> <maml:para>When the `-InputPath` parameter is used with a file path or URL. If the `Detect` format is used, the file extension will be used to automatically detect the format. When `-InputPath` is not used, `Detect` is the same as `None`.</maml:para> <maml:para>When this option is set to `File` PSRule scans the path and subdirectories specified by `-InputPath`. Files are treated as objects instead of being deserialized. Additional, PSRule uses the file extension as the object type. When files have no extension the whole file name is used.</maml:para> <maml:para>See `about_PSRule_Options` for details.</maml:para> <maml:para>This parameter takes precedence over the `Input.Format` option if set.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">None</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Yaml</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Json</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Markdown</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">PowerShellData</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">File</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Detect</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">InputFormat</command:parameterValue> <dev:type> <maml:name>InputFormat</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Detect</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Baseline</maml:name> <maml:description> <maml:para>Specifies an explicit baseline by name to use for evaluating rules. Baselines can contain filters and custom configuration that overrides the defaults.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BaselineOption</command:parameterValue> <dev:type> <maml:name>BaselineOption</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Convention</maml:name> <maml:description> <maml:para>Specifies conventions by name to execute in the pipeline when processing objects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Culture</maml:name> <maml:description> <maml:para>Specifies the culture to use for rule documentation and messages. By default, the culture of PowerShell is used.</maml:para> <maml:para>This option does not affect the culture used for the PSRule engine, which always uses the culture of PowerShell.</maml:para> <maml:para>The PowerShell cmdlet `Get-Culture` shows the current culture of PowerShell.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ObjectPath</maml:name> <maml:description> <maml:para>The name of a property to use instead of the pipeline object. If the property specified by `ObjectPath` is a collection or an array, then each item in evaluated separately.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TargetType</maml:name> <maml:description> <maml:para>Filters input objects by TargetType.</maml:para> <maml:para>If specified, only objects with the specified TargetType are processed. Objects that do not match TargetType are ignored. If multiple values are specified, only one TargetType must match. This parameter is not case-sensitive.</maml:para> <maml:para>By default, all objects are processed.</maml:para> <maml:para>This parameter if set, overrides the `Input.TargetType` option.</maml:para> <maml:para>To change the field TargetType is bound to set the `Binding.TargetType` option. For details see the about_PSRule_Options help topic.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="m"> <maml:name>Module</maml:name> <maml:description> <maml:para>Search for rule definitions within a module. If no sources are specified by `-Path`, `-Module`, or options, the current working directory is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OutputPath</maml:name> <maml:description> <maml:para>Specifies the output file path to write results. Directories along the file path will automatically be created if they do not exist.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="o"> <maml:name>OutputFormat</maml:name> <maml:description> <maml:para>Configures the format that output is presented in.</maml:para> <maml:para>The following format options are available:</maml:para> <maml:para>- None - Output is presented as an object using PowerShell defaults. This is the default. - Yaml - Output is serialized as YAML.</maml:para> <maml:para>- Json - Output is serialized as JSON.</maml:para> <maml:para>- Markdown - Output is serialized as Markdown.</maml:para> <maml:para>- NUnit3 - Output is serialized as NUnit3 (XML).</maml:para> <maml:para>- Csv - Output is serialized as a comma separated values (CSV).</maml:para> <maml:para>- Wide - Output is presented using the wide table format, which includes reason and wraps columns.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">None</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Yaml</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Json</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Markdown</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">NUnit3</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Csv</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Wide</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">OutputFormat</command:parameterValue> <dev:type> <maml:name>OutputFormat</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Invoke-PSRule</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="p"> <maml:name>Path</maml:name> <maml:description> <maml:para>One or more paths to search for rule definitions within. If no sources are specified by `-Path`, `-Module`, or options, the current working directory is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$PWD</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="n"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of a specific rule to evaluate. If this parameter is not specified all rules in search paths will be evaluated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Outcome</maml:name> <maml:description> <maml:para>Filter output to only show rule results with a specific outcome.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Pass</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Fail</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Error</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">None</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Processed</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">All</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">RuleOutcome</command:parameterValue> <dev:type> <maml:name>RuleOutcome</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Pass, Fail, Error</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tag</maml:name> <maml:description> <maml:para>Only get rules with the specified tags set. If this parameter is not specified all rules in search paths will be returned.</maml:para> <maml:para>When more than one tag is used, all tags must match. Tags are not case sensitive. A tag value of `*` may be used to filter rules to any rule with the tag set, regardless of tag value.</maml:para> <maml:para>An array of tag values can be used to match a rule with either value. i.e. `severity = important, critical` matches rules with a category of either `important` or `critical`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Option</maml:name> <maml:description> <maml:para>Additional options that configure execution. A `PSRuleOption` can be created by using the `New-PSRuleOption` cmdlet. Alternatively, a hashtable or path to YAML file can be specified with options.</maml:para> <maml:para>For more information on PSRule options see about_PSRule_Options.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSRuleOption</command:parameterValue> <dev:type> <maml:name>PSRuleOption</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>As</maml:name> <maml:description> <maml:para>The type of results to produce. Detailed results are generated by default.</maml:para> <maml:para>The following result formats are available:</maml:para> <maml:para>- `Detail` - Returns pass/ fail results for each rule per object.</maml:para> <maml:para>- `Summary` - Returns summarized results for the rule and the worst outcome.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Detail</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Summary</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ResultFormat</command:parameterValue> <dev:type> <maml:name>ResultFormat</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Detail</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Format</maml:name> <maml:description> <maml:para>Configures the input format for when a string is passed in as a target object.</maml:para> <maml:para>When the `-InputObject` parameter or pipeline input is used, strings are treated as plain text by default. Set this option to either `Yaml`, `Json`, `Markdown`, `PowerShellData` to have PSRule deserialize the object.</maml:para> <maml:para>When the `-InputPath` parameter is used with a file path or URL. If the `Detect` format is used, the file extension will be used to automatically detect the format. When `-InputPath` is not used, `Detect` is the same as `None`.</maml:para> <maml:para>When this option is set to `File` PSRule scans the path and subdirectories specified by `-InputPath`. Files are treated as objects instead of being deserialized. Additional, PSRule uses the file extension as the object type. When files have no extension the whole file name is used.</maml:para> <maml:para>See `about_PSRule_Options` for details.</maml:para> <maml:para>This parameter takes precedence over the `Input.Format` option if set.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">None</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Yaml</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Json</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Markdown</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">PowerShellData</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">File</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Detect</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">InputFormat</command:parameterValue> <dev:type> <maml:name>InputFormat</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Detect</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Baseline</maml:name> <maml:description> <maml:para>Specifies an explicit baseline by name to use for evaluating rules. Baselines can contain filters and custom configuration that overrides the defaults.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BaselineOption</command:parameterValue> <dev:type> <maml:name>BaselineOption</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Convention</maml:name> <maml:description> <maml:para>Specifies conventions by name to execute in the pipeline when processing objects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Culture</maml:name> <maml:description> <maml:para>Specifies the culture to use for rule documentation and messages. By default, the culture of PowerShell is used.</maml:para> <maml:para>This option does not affect the culture used for the PSRule engine, which always uses the culture of PowerShell.</maml:para> <maml:para>The PowerShell cmdlet `Get-Culture` shows the current culture of PowerShell.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ObjectPath</maml:name> <maml:description> <maml:para>The name of a property to use instead of the pipeline object. If the property specified by `ObjectPath` is a collection or an array, then each item in evaluated separately.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TargetType</maml:name> <maml:description> <maml:para>Filters input objects by TargetType.</maml:para> <maml:para>If specified, only objects with the specified TargetType are processed. Objects that do not match TargetType are ignored. If multiple values are specified, only one TargetType must match. This parameter is not case-sensitive.</maml:para> <maml:para>By default, all objects are processed.</maml:para> <maml:para>This parameter if set, overrides the `Input.TargetType` option.</maml:para> <maml:para>To change the field TargetType is bound to set the `Binding.TargetType` option. For details see the about_PSRule_Options help topic.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="m"> <maml:name>Module</maml:name> <maml:description> <maml:para>Search for rule definitions within a module. If no sources are specified by `-Path`, `-Module`, or options, the current working directory is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="f"> <maml:name>InputPath</maml:name> <maml:description> <maml:para>Instead of processing objects from the pipeline, import objects file the specified file paths.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OutputPath</maml:name> <maml:description> <maml:para>Specifies the output file path to write results. Directories along the file path will automatically be created if they do not exist.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="o"> <maml:name>OutputFormat</maml:name> <maml:description> <maml:para>Configures the format that output is presented in.</maml:para> <maml:para>The following format options are available:</maml:para> <maml:para>- None - Output is presented as an object using PowerShell defaults. This is the default. - Yaml - Output is serialized as YAML.</maml:para> <maml:para>- Json - Output is serialized as JSON.</maml:para> <maml:para>- Markdown - Output is serialized as Markdown.</maml:para> <maml:para>- NUnit3 - Output is serialized as NUnit3 (XML).</maml:para> <maml:para>- Csv - Output is serialized as a comma separated values (CSV).</maml:para> <maml:para>- Wide - Output is presented using the wide table format, which includes reason and wraps columns.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">None</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Yaml</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Json</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Markdown</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">NUnit3</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Csv</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Wide</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">OutputFormat</command:parameterValue> <dev:type> <maml:name>OutputFormat</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="n"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of a specific rule to evaluate. If this parameter is not specified all rules in search paths will be evaluated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="p"> <maml:name>Path</maml:name> <maml:description> <maml:para>One or more paths to search for rule definitions within. If no sources are specified by `-Path`, `-Module`, or options, the current working directory is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$PWD</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Outcome</maml:name> <maml:description> <maml:para>Filter output to only show rule results with a specific outcome.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RuleOutcome</command:parameterValue> <dev:type> <maml:name>RuleOutcome</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Pass, Fail, Error</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tag</maml:name> <maml:description> <maml:para>Only get rules with the specified tags set. If this parameter is not specified all rules in search paths will be returned.</maml:para> <maml:para>When more than one tag is used, all tags must match. Tags are not case sensitive. A tag value of `*` may be used to filter rules to any rule with the tag set, regardless of tag value.</maml:para> <maml:para>An array of tag values can be used to match a rule with either value. i.e. `severity = important, critical` matches rules with a category of either `important` or `critical`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="TargetObject"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The pipeline object to process rules for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Option</maml:name> <maml:description> <maml:para>Additional options that configure execution. A `PSRuleOption` can be created by using the `New-PSRuleOption` cmdlet. Alternatively, a hashtable or path to YAML file can be specified with options.</maml:para> <maml:para>For more information on PSRule options see about_PSRule_Options.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSRuleOption</command:parameterValue> <dev:type> <maml:name>PSRuleOption</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>As</maml:name> <maml:description> <maml:para>The type of results to produce. Detailed results are generated by default.</maml:para> <maml:para>The following result formats are available:</maml:para> <maml:para>- `Detail` - Returns pass/ fail results for each rule per object.</maml:para> <maml:para>- `Summary` - Returns summarized results for the rule and the worst outcome.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ResultFormat</command:parameterValue> <dev:type> <maml:name>ResultFormat</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Detail</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Format</maml:name> <maml:description> <maml:para>Configures the input format for when a string is passed in as a target object.</maml:para> <maml:para>When the `-InputObject` parameter or pipeline input is used, strings are treated as plain text by default. Set this option to either `Yaml`, `Json`, `Markdown`, `PowerShellData` to have PSRule deserialize the object.</maml:para> <maml:para>When the `-InputPath` parameter is used with a file path or URL. If the `Detect` format is used, the file extension will be used to automatically detect the format. When `-InputPath` is not used, `Detect` is the same as `None`.</maml:para> <maml:para>When this option is set to `File` PSRule scans the path and subdirectories specified by `-InputPath`. Files are treated as objects instead of being deserialized. Additional, PSRule uses the file extension as the object type. When files have no extension the whole file name is used.</maml:para> <maml:para>See `about_PSRule_Options` for details.</maml:para> <maml:para>This parameter takes precedence over the `Input.Format` option if set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">InputFormat</command:parameterValue> <dev:type> <maml:name>InputFormat</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Detect</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Baseline</maml:name> <maml:description> <maml:para>Specifies an explicit baseline by name to use for evaluating rules. Baselines can contain filters and custom configuration that overrides the defaults.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BaselineOption</command:parameterValue> <dev:type> <maml:name>BaselineOption</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Convention</maml:name> <maml:description> <maml:para>Specifies conventions by name to execute in the pipeline when processing objects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Culture</maml:name> <maml:description> <maml:para>Specifies the culture to use for rule documentation and messages. By default, the culture of PowerShell is used.</maml:para> <maml:para>This option does not affect the culture used for the PSRule engine, which always uses the culture of PowerShell.</maml:para> <maml:para>The PowerShell cmdlet `Get-Culture` shows the current culture of PowerShell.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ObjectPath</maml:name> <maml:description> <maml:para>The name of a property to use instead of the pipeline object. If the property specified by `ObjectPath` is a collection or an array, then each item in evaluated separately.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TargetType</maml:name> <maml:description> <maml:para>Filters input objects by TargetType.</maml:para> <maml:para>If specified, only objects with the specified TargetType are processed. Objects that do not match TargetType are ignored. If multiple values are specified, only one TargetType must match. This parameter is not case-sensitive.</maml:para> <maml:para>By default, all objects are processed.</maml:para> <maml:para>This parameter if set, overrides the `Input.TargetType` option.</maml:para> <maml:para>To change the field TargetType is bound to set the `Binding.TargetType` option. For details see the about_PSRule_Options help topic.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="m"> <maml:name>Module</maml:name> <maml:description> <maml:para>Search for rule definitions within a module. If no sources are specified by `-Path`, `-Module`, or options, the current working directory is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="f"> <maml:name>InputPath</maml:name> <maml:description> <maml:para>Instead of processing objects from the pipeline, import objects file the specified file paths.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OutputPath</maml:name> <maml:description> <maml:para>Specifies the output file path to write results. Directories along the file path will automatically be created if they do not exist.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="o"> <maml:name>OutputFormat</maml:name> <maml:description> <maml:para>Configures the format that output is presented in.</maml:para> <maml:para>The following format options are available:</maml:para> <maml:para>- None - Output is presented as an object using PowerShell defaults. This is the default. - Yaml - Output is serialized as YAML.</maml:para> <maml:para>- Json - Output is serialized as JSON.</maml:para> <maml:para>- Markdown - Output is serialized as Markdown.</maml:para> <maml:para>- NUnit3 - Output is serialized as NUnit3 (XML).</maml:para> <maml:para>- Csv - Output is serialized as a comma separated values (CSV).</maml:para> <maml:para>- Wide - Output is presented using the wide table format, which includes reason and wraps columns.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">OutputFormat</command:parameterValue> <dev:type> <maml:name>OutputFormat</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> </dev:type> <maml:description> <maml:para>You can pipe any object to Invoke-PSRule .</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PSRule.Rules.RuleRecord</maml:name> </dev:type> <maml:description> <maml:para>This is the default.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>PSRule.Rules.RuleSummaryRecord</maml:name> </dev:type> <maml:description> <maml:para>When you use the `-As Summary`. Otherwise, it returns a `RuleRecord` object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>@{ Name = 'Item 1' } | Invoke-PSRule;</dev:code> <dev:remarks> <maml:para>Evaluate a simple hashtable on the pipeline against rules loaded from the current working path.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code># Define objects to validate $items = @(); $items += [PSCustomObject]@{ Name = 'Fridge' }; $items += [PSCustomObject]@{ Name = 'Apple' }; # Validate each item using rules saved in current working path $items | Invoke-PSRule; TargetName: Fridge RuleName Outcome Recommendation -------- ------- -------------- isFruit Fail Fruit is only Apple, Orange and Pear TargetName: Apple RuleName Outcome Recommendation -------- ------- -------------- isFruit Pass Fruit is only Apple, Orange and Pear</dev:code> <dev:remarks> <maml:para>Evaluate an array of objects on the pipeline against rules loaded from the current working path.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code># Define objects to validate $items = @(); $items += [PSCustomObject]@{ Name = 'Fridge' }; $items += [PSCustomObject]@{ Name = 'Apple' }; # Validate each item and only return failing results $items | Invoke-PSRule -Outcome Fail; TargetName: Fridge RuleName Outcome Recommendation -------- ------- -------------- isFruit Fail Fruit is only Apple, Orange and Pear</dev:code> <dev:remarks> <maml:para>Evaluate an array of objects, only failing object results are returned.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code># Define objects to validate $items = @(); $items += [PSCustomObject]@{ Name = 'Fridge' }; $items += [PSCustomObject]@{ Name = 'Apple' }; # Validate each item and show rule summary $items | Invoke-PSRule -As Summary; RuleName Pass Fail Outcome -------- ---- ---- ------- isFruit 1 1 Fail</dev:code> <dev:remarks> <maml:para>Evaluate an array of objects. The results for each rule is returned as a summary. Outcome is represented as the worst outcome.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://microsoft.github.io/PSRule/v1/commands/PSRule/en-US/Invoke-PSRule/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-PSRule</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Assert-PSRule</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Test-PSRuleTarget</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-PSRuleOption</command:name> <command:verb>New</command:verb> <command:noun>PSRuleOption</command:noun> <maml:description> <maml:para>Create options to configure PSRule execution.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The New-PSRuleOption cmdlet creates an options object that can be passed to PSRule cmdlets to configure execution.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-PSRuleOption</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Option</maml:name> <maml:description> <maml:para>Additional options that configure execution. Option also accepts a hashtable to configure options. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSRuleOption</command:parameterValue> <dev:type> <maml:name>PSRuleOption</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SuppressTargetName</maml:name> <maml:description> <maml:para>Configures suppression for a list of objects by TargetName. SuppressTargetName also accepts a hashtable to configure rule suppression. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SuppressionOption</command:parameterValue> <dev:type> <maml:name>SuppressionOption</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BindTargetName</maml:name> <maml:description> <maml:para>Configures a custom function to use to bind TargetName of an object. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BindTargetName[]</command:parameterValue> <dev:type> <maml:name>BindTargetName[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="BaselineConfiguration"> <maml:name>Configuration</maml:name> <maml:description> <maml:para>Configures a set of baseline configuration values that can be used in rule definitions instead of using hard coded values. Configuration also accepts a hashtable of configuration values as key/ value pairs. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ConfigurationOption</command:parameterValue> <dev:type> <maml:name>ConfigurationOption</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BindTargetType</maml:name> <maml:description> <maml:para>Configures a custom function to use to bind TargetType of an object. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BindTargetName[]</command:parameterValue> <dev:type> <maml:name>BindTargetName[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BindingIgnoreCase</maml:name> <maml:description> <maml:para>Sets the option `Binding.IgnoreCase`. The option `Binding.IgnoreCase` determines if binding operations are case-sensitive or not. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BindingField</maml:name> <maml:description> <maml:para>Sets the option `Binding.Field`. The option specified one or more custom field bindings. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BindingNameSeparator</maml:name> <maml:description> <maml:para>Sets the option `Binding.NameSeparator`. This option specifies the separator to use for qualified names. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BindingPreferTargetInfo</maml:name> <maml:description> <maml:para>Sets the option `Binding.PreferTargetInfo`. This option specifies if automatic binding is preferred over configured binding options. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="ConventionInclude"> <maml:name>Convention</maml:name> <maml:description> <maml:para>Sets the `Option.ConventionInclude` option. This option specifies the name of conventions to execute in the pipeline when processing objects. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="BindingTargetName"> <maml:name>TargetName</maml:name> <maml:description> <maml:para>Sets the option `Binding.TargetName`. This option specifies one or more properties of TargetObject to use to bind TargetName to. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="BindingTargetType"> <maml:name>TargetType</maml:name> <maml:description> <maml:para>Sets the option `Binding.TargetType`. This option specifies one or more properties of TargetObject to use to bind TargetType to. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BindingUseQualifiedName</maml:name> <maml:description> <maml:para>Sets the option `Binding.UseQualifiedName`. This option specifies is qualified target names are used. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="ExecutionInconclusiveWarning"> <maml:name>InconclusiveWarning</maml:name> <maml:description> <maml:para>Sets the option `Execution.InconclusiveWarning`. The `Execution.InconclusiveWarning` option determines if a warning is generated when the outcome of a rule is inconclusive. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="ExecutionNotProcessedWarning"> <maml:name>NotProcessedWarning</maml:name> <maml:description> <maml:para>Sets the option `Execution.NotProcessedWarning`. The `Execution.NotProcessedWarning` option determines if a warning is generated when an object is not processed by any rule. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeModule</maml:name> <maml:description> <maml:para>Sets the `Include.Module` option to include additional module sources. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludePath</maml:name> <maml:description> <maml:para>Sets the `Include.Path` option to include additional standalone sources. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="InputFormat"> <maml:name>Format</maml:name> <maml:description> <maml:para>Sets the `Input.Format` option to configure the input format for when a string is passed in as a target object. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">None</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Yaml</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Json</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Markdown</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">PowerShellData</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">File</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Detect</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">InputFormat</command:parameterValue> <dev:type> <maml:name>InputFormat</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>InputIgnoreGitPath</maml:name> <maml:description> <maml:para>Sets the `Input.IgnoreGitPath` option to determine if files within the .git path are ignored. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>InputIgnoreRepositoryCommon</maml:name> <maml:description> <maml:para>Sets the `Input.IgnoreRepositoryCommon` option to determine if files common repository files are ignored. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="InputObjectPath"> <maml:name>ObjectPath</maml:name> <maml:description> <maml:para>Sets the `Input.ObjectPath` option to use an object path to use instead of the pipeline object. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>InputPathIgnore</maml:name> <maml:description> <maml:para>Sets the `Input.PathIgnore` option. If specified, files that match the path spec will not be processed. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>InputTargetType</maml:name> <maml:description> <maml:para>Sets the `Input.TargetType` option to only process objects with the specified TargetType. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LoggingLimitDebug</maml:name> <maml:description> <maml:para>Sets the `Logging.LimitDebug` option to limit debug messages to a list of named debug scopes. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LoggingLimitVerbose</maml:name> <maml:description> <maml:para>Sets the `Logging.LimitVerbose` option to limit verbose messages to a list of named verbose scopes. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LoggingRuleFail</maml:name> <maml:description> <maml:para>Sets the `Logging.RuleFail` option to generate an informational message for each rule fail. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">OutcomeLogStream</command:parameterValue> <dev:type> <maml:name>OutcomeLogStream</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LoggingRulePass</maml:name> <maml:description> <maml:para>Sets the `Logging.RulePass` option to generate an informational message for each rule pass. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">OutcomeLogStream</command:parameterValue> <dev:type> <maml:name>OutcomeLogStream</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OutputAs</maml:name> <maml:description> <maml:para>Sets the option `Output.As`. The `Output.As` option configures the type of results to produce, either detail or summary.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ResultFormat</command:parameterValue> <dev:type> <maml:name>ResultFormat</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OutputBanner</maml:name> <maml:description> <maml:para>Sets the option `Output.Banner`. The `Output.Banner` option configure information displayed with PSRule banner. This option is only applicable when using `Assert-PSRule` cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BannerFormat</command:parameterValue> <dev:type> <maml:name>BannerFormat</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OutputCulture</maml:name> <maml:description> <maml:para>Sets the option `Output.Culture`. The `Output.Culture` option configures the culture used to generated output. When multiple cultures are specified, the first matching culture will be used. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OutputEncoding</maml:name> <maml:description> <maml:para>Sets the option `Output.Encoding`. The `Output.Encoding` option configured the encoding used to write results to file.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Default</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">UTF8</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">UTF7</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Unicode</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">UTF32</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ASCII</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">OutputEncoding</command:parameterValue> <dev:type> <maml:name>OutputEncoding</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OutputFooter</maml:name> <maml:description> <maml:para>Sets the option `Output.Footer`. The `Output.Footer` option configures the information displayed for PSRule footer. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">FooterFormat</command:parameterValue> <dev:type> <maml:name>FooterFormat</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OutputFormat</maml:name> <maml:description> <maml:para>Sets the option `Output.Format`. The `Output.Format` option configures the format that results will be presented in. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">None</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Yaml</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Json</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Markdown</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">NUnit3</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Csv</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Wide</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">OutputFormat</command:parameterValue> <dev:type> <maml:name>OutputFormat</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Outcome"> <maml:name>OutputOutcome</maml:name> <maml:description> <maml:para>Sets the `Output.Outcome` option. This option can be set to include or exclude output results. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RuleOutcome</command:parameterValue> <dev:type> <maml:name>RuleOutcome</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Processed</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OutputPath</maml:name> <maml:description> <maml:para>Sets the option `Output.Path`. The `Output.Path` option configures an output file path to write results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OutputStyle</maml:name> <maml:description> <maml:para>Sets the option `Option.Style`. The `Output.Style` option configures the style that results will be presented in.</maml:para> <maml:para>This option only applies to `Assert-PSRule`.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Client</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Plain</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AzurePipelines</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">GitHubActions</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">OutputStyle</command:parameterValue> <dev:type> <maml:name>OutputStyle</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Client</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="JsonIndent"> <maml:name>OutputJsonIndent</maml:name> <maml:description> <maml:para>Sets the option `Output.JsonIndent`. The `Output.JsonIndent` option configures indentation for JSON output.</maml:para> <maml:para>This option only applies to `Get-PSRule`, `Invoke-PSRule` and `Assert-PSRule` cmdlets.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">0</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">1</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">2</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">3</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">4</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RuleIncludeLocal</maml:name> <maml:description> <maml:para>Sets the option `Rule.IncludeLocal`. The `Rule.IncludeLocal` option configures if local rules are automatically included. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-PSRuleOption</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>The path to a YAML file containing options. By default the current working path (`$PWD`) is used.</maml:para> <maml:para>Either a directory or file path can be specified. When a directory is used, `ps-rule.yaml` will be used as the file name.</maml:para> <maml:para>If the `-Path` parameter is specified and the file does not exist, an exception will be generated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$PWD</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SuppressTargetName</maml:name> <maml:description> <maml:para>Configures suppression for a list of objects by TargetName. SuppressTargetName also accepts a hashtable to configure rule suppression. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SuppressionOption</command:parameterValue> <dev:type> <maml:name>SuppressionOption</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BindTargetName</maml:name> <maml:description> <maml:para>Configures a custom function to use to bind TargetName of an object. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BindTargetName[]</command:parameterValue> <dev:type> <maml:name>BindTargetName[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="BaselineConfiguration"> <maml:name>Configuration</maml:name> <maml:description> <maml:para>Configures a set of baseline configuration values that can be used in rule definitions instead of using hard coded values. Configuration also accepts a hashtable of configuration values as key/ value pairs. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ConfigurationOption</command:parameterValue> <dev:type> <maml:name>ConfigurationOption</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BindTargetType</maml:name> <maml:description> <maml:para>Configures a custom function to use to bind TargetType of an object. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BindTargetName[]</command:parameterValue> <dev:type> <maml:name>BindTargetName[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BindingIgnoreCase</maml:name> <maml:description> <maml:para>Sets the option `Binding.IgnoreCase`. The option `Binding.IgnoreCase` determines if binding operations are case-sensitive or not. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BindingField</maml:name> <maml:description> <maml:para>Sets the option `Binding.Field`. The option specified one or more custom field bindings. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BindingNameSeparator</maml:name> <maml:description> <maml:para>Sets the option `Binding.NameSeparator`. This option specifies the separator to use for qualified names. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BindingPreferTargetInfo</maml:name> <maml:description> <maml:para>Sets the option `Binding.PreferTargetInfo`. This option specifies if automatic binding is preferred over configured binding options. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="ConventionInclude"> <maml:name>Convention</maml:name> <maml:description> <maml:para>Sets the `Option.ConventionInclude` option. This option specifies the name of conventions to execute in the pipeline when processing objects. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="BindingTargetName"> <maml:name>TargetName</maml:name> <maml:description> <maml:para>Sets the option `Binding.TargetName`. This option specifies one or more properties of TargetObject to use to bind TargetName to. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="BindingTargetType"> <maml:name>TargetType</maml:name> <maml:description> <maml:para>Sets the option `Binding.TargetType`. This option specifies one or more properties of TargetObject to use to bind TargetType to. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BindingUseQualifiedName</maml:name> <maml:description> <maml:para>Sets the option `Binding.UseQualifiedName`. This option specifies is qualified target names are used. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="ExecutionInconclusiveWarning"> <maml:name>InconclusiveWarning</maml:name> <maml:description> <maml:para>Sets the option `Execution.InconclusiveWarning`. The `Execution.InconclusiveWarning` option determines if a warning is generated when the outcome of a rule is inconclusive. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="ExecutionNotProcessedWarning"> <maml:name>NotProcessedWarning</maml:name> <maml:description> <maml:para>Sets the option `Execution.NotProcessedWarning`. The `Execution.NotProcessedWarning` option determines if a warning is generated when an object is not processed by any rule. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeModule</maml:name> <maml:description> <maml:para>Sets the `Include.Module` option to include additional module sources. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludePath</maml:name> <maml:description> <maml:para>Sets the `Include.Path` option to include additional standalone sources. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="InputFormat"> <maml:name>Format</maml:name> <maml:description> <maml:para>Sets the `Input.Format` option to configure the input format for when a string is passed in as a target object. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">None</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Yaml</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Json</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Markdown</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">PowerShellData</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">File</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Detect</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">InputFormat</command:parameterValue> <dev:type> <maml:name>InputFormat</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>InputIgnoreGitPath</maml:name> <maml:description> <maml:para>Sets the `Input.IgnoreGitPath` option to determine if files within the .git path are ignored. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>InputIgnoreRepositoryCommon</maml:name> <maml:description> <maml:para>Sets the `Input.IgnoreRepositoryCommon` option to determine if files common repository files are ignored. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="InputObjectPath"> <maml:name>ObjectPath</maml:name> <maml:description> <maml:para>Sets the `Input.ObjectPath` option to use an object path to use instead of the pipeline object. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>InputPathIgnore</maml:name> <maml:description> <maml:para>Sets the `Input.PathIgnore` option. If specified, files that match the path spec will not be processed. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>InputTargetType</maml:name> <maml:description> <maml:para>Sets the `Input.TargetType` option to only process objects with the specified TargetType. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LoggingLimitDebug</maml:name> <maml:description> <maml:para>Sets the `Logging.LimitDebug` option to limit debug messages to a list of named debug scopes. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LoggingLimitVerbose</maml:name> <maml:description> <maml:para>Sets the `Logging.LimitVerbose` option to limit verbose messages to a list of named verbose scopes. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LoggingRuleFail</maml:name> <maml:description> <maml:para>Sets the `Logging.RuleFail` option to generate an informational message for each rule fail. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">OutcomeLogStream</command:parameterValue> <dev:type> <maml:name>OutcomeLogStream</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LoggingRulePass</maml:name> <maml:description> <maml:para>Sets the `Logging.RulePass` option to generate an informational message for each rule pass. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">OutcomeLogStream</command:parameterValue> <dev:type> <maml:name>OutcomeLogStream</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OutputAs</maml:name> <maml:description> <maml:para>Sets the option `Output.As`. The `Output.As` option configures the type of results to produce, either detail or summary.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ResultFormat</command:parameterValue> <dev:type> <maml:name>ResultFormat</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OutputBanner</maml:name> <maml:description> <maml:para>Sets the option `Output.Banner`. The `Output.Banner` option configure information displayed with PSRule banner. This option is only applicable when using `Assert-PSRule` cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BannerFormat</command:parameterValue> <dev:type> <maml:name>BannerFormat</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OutputCulture</maml:name> <maml:description> <maml:para>Sets the option `Output.Culture`. The `Output.Culture` option configures the culture used to generated output. When multiple cultures are specified, the first matching culture will be used. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OutputEncoding</maml:name> <maml:description> <maml:para>Sets the option `Output.Encoding`. The `Output.Encoding` option configured the encoding used to write results to file.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Default</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">UTF8</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">UTF7</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Unicode</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">UTF32</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ASCII</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">OutputEncoding</command:parameterValue> <dev:type> <maml:name>OutputEncoding</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OutputFooter</maml:name> <maml:description> <maml:para>Sets the option `Output.Footer`. The `Output.Footer` option configures the information displayed for PSRule footer. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">FooterFormat</command:parameterValue> <dev:type> <maml:name>FooterFormat</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OutputFormat</maml:name> <maml:description> <maml:para>Sets the option `Output.Format`. The `Output.Format` option configures the format that results will be presented in. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">None</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Yaml</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Json</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Markdown</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">NUnit3</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Csv</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Wide</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">OutputFormat</command:parameterValue> <dev:type> <maml:name>OutputFormat</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Outcome"> <maml:name>OutputOutcome</maml:name> <maml:description> <maml:para>Sets the `Output.Outcome` option. This option can be set to include or exclude output results. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RuleOutcome</command:parameterValue> <dev:type> <maml:name>RuleOutcome</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Processed</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OutputPath</maml:name> <maml:description> <maml:para>Sets the option `Output.Path`. The `Output.Path` option configures an output file path to write results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OutputStyle</maml:name> <maml:description> <maml:para>Sets the option `Option.Style`. The `Output.Style` option configures the style that results will be presented in.</maml:para> <maml:para>This option only applies to `Assert-PSRule`.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Client</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Plain</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AzurePipelines</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">GitHubActions</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">OutputStyle</command:parameterValue> <dev:type> <maml:name>OutputStyle</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Client</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="JsonIndent"> <maml:name>OutputJsonIndent</maml:name> <maml:description> <maml:para>Sets the option `Output.JsonIndent`. The `Output.JsonIndent` option configures indentation for JSON output.</maml:para> <maml:para>This option only applies to `Get-PSRule`, `Invoke-PSRule` and `Assert-PSRule` cmdlets.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">0</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">1</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">2</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">3</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">4</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RuleIncludeLocal</maml:name> <maml:description> <maml:para>Sets the option `Rule.IncludeLocal`. The `Rule.IncludeLocal` option configures if local rules are automatically included. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-PSRuleOption</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Default</maml:name> <maml:description> <maml:para>When specified, defaults are used for any options not overridden.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SuppressTargetName</maml:name> <maml:description> <maml:para>Configures suppression for a list of objects by TargetName. SuppressTargetName also accepts a hashtable to configure rule suppression. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SuppressionOption</command:parameterValue> <dev:type> <maml:name>SuppressionOption</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BindTargetName</maml:name> <maml:description> <maml:para>Configures a custom function to use to bind TargetName of an object. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BindTargetName[]</command:parameterValue> <dev:type> <maml:name>BindTargetName[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="BaselineConfiguration"> <maml:name>Configuration</maml:name> <maml:description> <maml:para>Configures a set of baseline configuration values that can be used in rule definitions instead of using hard coded values. Configuration also accepts a hashtable of configuration values as key/ value pairs. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ConfigurationOption</command:parameterValue> <dev:type> <maml:name>ConfigurationOption</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BindTargetType</maml:name> <maml:description> <maml:para>Configures a custom function to use to bind TargetType of an object. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BindTargetName[]</command:parameterValue> <dev:type> <maml:name>BindTargetName[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BindingIgnoreCase</maml:name> <maml:description> <maml:para>Sets the option `Binding.IgnoreCase`. The option `Binding.IgnoreCase` determines if binding operations are case-sensitive or not. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BindingField</maml:name> <maml:description> <maml:para>Sets the option `Binding.Field`. The option specified one or more custom field bindings. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BindingNameSeparator</maml:name> <maml:description> <maml:para>Sets the option `Binding.NameSeparator`. This option specifies the separator to use for qualified names. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BindingPreferTargetInfo</maml:name> <maml:description> <maml:para>Sets the option `Binding.PreferTargetInfo`. This option specifies if automatic binding is preferred over configured binding options. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="ConventionInclude"> <maml:name>Convention</maml:name> <maml:description> <maml:para>Sets the `Option.ConventionInclude` option. This option specifies the name of conventions to execute in the pipeline when processing objects. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="BindingTargetName"> <maml:name>TargetName</maml:name> <maml:description> <maml:para>Sets the option `Binding.TargetName`. This option specifies one or more properties of TargetObject to use to bind TargetName to. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="BindingTargetType"> <maml:name>TargetType</maml:name> <maml:description> <maml:para>Sets the option `Binding.TargetType`. This option specifies one or more properties of TargetObject to use to bind TargetType to. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BindingUseQualifiedName</maml:name> <maml:description> <maml:para>Sets the option `Binding.UseQualifiedName`. This option specifies is qualified target names are used. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="ExecutionInconclusiveWarning"> <maml:name>InconclusiveWarning</maml:name> <maml:description> <maml:para>Sets the option `Execution.InconclusiveWarning`. The `Execution.InconclusiveWarning` option determines if a warning is generated when the outcome of a rule is inconclusive. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="ExecutionNotProcessedWarning"> <maml:name>NotProcessedWarning</maml:name> <maml:description> <maml:para>Sets the option `Execution.NotProcessedWarning`. The `Execution.NotProcessedWarning` option determines if a warning is generated when an object is not processed by any rule. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeModule</maml:name> <maml:description> <maml:para>Sets the `Include.Module` option to include additional module sources. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludePath</maml:name> <maml:description> <maml:para>Sets the `Include.Path` option to include additional standalone sources. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="InputFormat"> <maml:name>Format</maml:name> <maml:description> <maml:para>Sets the `Input.Format` option to configure the input format for when a string is passed in as a target object. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">None</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Yaml</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Json</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Markdown</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">PowerShellData</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">File</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Detect</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">InputFormat</command:parameterValue> <dev:type> <maml:name>InputFormat</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>InputIgnoreGitPath</maml:name> <maml:description> <maml:para>Sets the `Input.IgnoreGitPath` option to determine if files within the .git path are ignored. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>InputIgnoreRepositoryCommon</maml:name> <maml:description> <maml:para>Sets the `Input.IgnoreRepositoryCommon` option to determine if files common repository files are ignored. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="InputObjectPath"> <maml:name>ObjectPath</maml:name> <maml:description> <maml:para>Sets the `Input.ObjectPath` option to use an object path to use instead of the pipeline object. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>InputPathIgnore</maml:name> <maml:description> <maml:para>Sets the `Input.PathIgnore` option. If specified, files that match the path spec will not be processed. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>InputTargetType</maml:name> <maml:description> <maml:para>Sets the `Input.TargetType` option to only process objects with the specified TargetType. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LoggingLimitDebug</maml:name> <maml:description> <maml:para>Sets the `Logging.LimitDebug` option to limit debug messages to a list of named debug scopes. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LoggingLimitVerbose</maml:name> <maml:description> <maml:para>Sets the `Logging.LimitVerbose` option to limit verbose messages to a list of named verbose scopes. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LoggingRuleFail</maml:name> <maml:description> <maml:para>Sets the `Logging.RuleFail` option to generate an informational message for each rule fail. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">OutcomeLogStream</command:parameterValue> <dev:type> <maml:name>OutcomeLogStream</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LoggingRulePass</maml:name> <maml:description> <maml:para>Sets the `Logging.RulePass` option to generate an informational message for each rule pass. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">OutcomeLogStream</command:parameterValue> <dev:type> <maml:name>OutcomeLogStream</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OutputAs</maml:name> <maml:description> <maml:para>Sets the option `Output.As`. The `Output.As` option configures the type of results to produce, either detail or summary.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ResultFormat</command:parameterValue> <dev:type> <maml:name>ResultFormat</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OutputBanner</maml:name> <maml:description> <maml:para>Sets the option `Output.Banner`. The `Output.Banner` option configure information displayed with PSRule banner. This option is only applicable when using `Assert-PSRule` cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BannerFormat</command:parameterValue> <dev:type> <maml:name>BannerFormat</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OutputCulture</maml:name> <maml:description> <maml:para>Sets the option `Output.Culture`. The `Output.Culture` option configures the culture used to generated output. When multiple cultures are specified, the first matching culture will be used. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OutputEncoding</maml:name> <maml:description> <maml:para>Sets the option `Output.Encoding`. The `Output.Encoding` option configured the encoding used to write results to file.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Default</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">UTF8</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">UTF7</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Unicode</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">UTF32</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ASCII</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">OutputEncoding</command:parameterValue> <dev:type> <maml:name>OutputEncoding</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OutputFooter</maml:name> <maml:description> <maml:para>Sets the option `Output.Footer`. The `Output.Footer` option configures the information displayed for PSRule footer. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">FooterFormat</command:parameterValue> <dev:type> <maml:name>FooterFormat</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OutputFormat</maml:name> <maml:description> <maml:para>Sets the option `Output.Format`. The `Output.Format` option configures the format that results will be presented in. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">None</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Yaml</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Json</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Markdown</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">NUnit3</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Csv</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Wide</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">OutputFormat</command:parameterValue> <dev:type> <maml:name>OutputFormat</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Outcome"> <maml:name>OutputOutcome</maml:name> <maml:description> <maml:para>Sets the `Output.Outcome` option. This option can be set to include or exclude output results. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RuleOutcome</command:parameterValue> <dev:type> <maml:name>RuleOutcome</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Processed</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OutputPath</maml:name> <maml:description> <maml:para>Sets the option `Output.Path`. The `Output.Path` option configures an output file path to write results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OutputStyle</maml:name> <maml:description> <maml:para>Sets the option `Option.Style`. The `Output.Style` option configures the style that results will be presented in.</maml:para> <maml:para>This option only applies to `Assert-PSRule`.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Client</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Plain</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AzurePipelines</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">GitHubActions</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">OutputStyle</command:parameterValue> <dev:type> <maml:name>OutputStyle</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Client</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="JsonIndent"> <maml:name>OutputJsonIndent</maml:name> <maml:description> <maml:para>Sets the option `Output.JsonIndent`. The `Output.JsonIndent` option configures indentation for JSON output.</maml:para> <maml:para>This option only applies to `Get-PSRule`, `Invoke-PSRule` and `Assert-PSRule` cmdlets.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">0</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">1</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">2</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">3</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">4</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RuleIncludeLocal</maml:name> <maml:description> <maml:para>Sets the option `Rule.IncludeLocal`. The `Rule.IncludeLocal` option configures if local rules are automatically included. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Option</maml:name> <maml:description> <maml:para>Additional options that configure execution. Option also accepts a hashtable to configure options. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSRuleOption</command:parameterValue> <dev:type> <maml:name>PSRuleOption</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>The path to a YAML file containing options. By default the current working path (`$PWD`) is used.</maml:para> <maml:para>Either a directory or file path can be specified. When a directory is used, `ps-rule.yaml` will be used as the file name.</maml:para> <maml:para>If the `-Path` parameter is specified and the file does not exist, an exception will be generated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$PWD</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Default</maml:name> <maml:description> <maml:para>When specified, defaults are used for any options not overridden.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SuppressTargetName</maml:name> <maml:description> <maml:para>Configures suppression for a list of objects by TargetName. SuppressTargetName also accepts a hashtable to configure rule suppression. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SuppressionOption</command:parameterValue> <dev:type> <maml:name>SuppressionOption</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BindTargetName</maml:name> <maml:description> <maml:para>Configures a custom function to use to bind TargetName of an object. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BindTargetName[]</command:parameterValue> <dev:type> <maml:name>BindTargetName[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="BaselineConfiguration"> <maml:name>Configuration</maml:name> <maml:description> <maml:para>Configures a set of baseline configuration values that can be used in rule definitions instead of using hard coded values. Configuration also accepts a hashtable of configuration values as key/ value pairs. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ConfigurationOption</command:parameterValue> <dev:type> <maml:name>ConfigurationOption</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BindTargetType</maml:name> <maml:description> <maml:para>Configures a custom function to use to bind TargetType of an object. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BindTargetName[]</command:parameterValue> <dev:type> <maml:name>BindTargetName[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BindingIgnoreCase</maml:name> <maml:description> <maml:para>Sets the option `Binding.IgnoreCase`. The option `Binding.IgnoreCase` determines if binding operations are case-sensitive or not. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BindingField</maml:name> <maml:description> <maml:para>Sets the option `Binding.Field`. The option specified one or more custom field bindings. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BindingNameSeparator</maml:name> <maml:description> <maml:para>Sets the option `Binding.NameSeparator`. This option specifies the separator to use for qualified names. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BindingPreferTargetInfo</maml:name> <maml:description> <maml:para>Sets the option `Binding.PreferTargetInfo`. This option specifies if automatic binding is preferred over configured binding options. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="ConventionInclude"> <maml:name>Convention</maml:name> <maml:description> <maml:para>Sets the `Option.ConventionInclude` option. This option specifies the name of conventions to execute in the pipeline when processing objects. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="BindingTargetName"> <maml:name>TargetName</maml:name> <maml:description> <maml:para>Sets the option `Binding.TargetName`. This option specifies one or more properties of TargetObject to use to bind TargetName to. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="BindingTargetType"> <maml:name>TargetType</maml:name> <maml:description> <maml:para>Sets the option `Binding.TargetType`. This option specifies one or more properties of TargetObject to use to bind TargetType to. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BindingUseQualifiedName</maml:name> <maml:description> <maml:para>Sets the option `Binding.UseQualifiedName`. This option specifies is qualified target names are used. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="ExecutionInconclusiveWarning"> <maml:name>InconclusiveWarning</maml:name> <maml:description> <maml:para>Sets the option `Execution.InconclusiveWarning`. The `Execution.InconclusiveWarning` option determines if a warning is generated when the outcome of a rule is inconclusive. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="ExecutionNotProcessedWarning"> <maml:name>NotProcessedWarning</maml:name> <maml:description> <maml:para>Sets the option `Execution.NotProcessedWarning`. The `Execution.NotProcessedWarning` option determines if a warning is generated when an object is not processed by any rule. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeModule</maml:name> <maml:description> <maml:para>Sets the `Include.Module` option to include additional module sources. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludePath</maml:name> <maml:description> <maml:para>Sets the `Include.Path` option to include additional standalone sources. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="InputFormat"> <maml:name>Format</maml:name> <maml:description> <maml:para>Sets the `Input.Format` option to configure the input format for when a string is passed in as a target object. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">InputFormat</command:parameterValue> <dev:type> <maml:name>InputFormat</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>InputIgnoreGitPath</maml:name> <maml:description> <maml:para>Sets the `Input.IgnoreGitPath` option to determine if files within the .git path are ignored. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>InputIgnoreRepositoryCommon</maml:name> <maml:description> <maml:para>Sets the `Input.IgnoreRepositoryCommon` option to determine if files common repository files are ignored. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="InputObjectPath"> <maml:name>ObjectPath</maml:name> <maml:description> <maml:para>Sets the `Input.ObjectPath` option to use an object path to use instead of the pipeline object. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>InputPathIgnore</maml:name> <maml:description> <maml:para>Sets the `Input.PathIgnore` option. If specified, files that match the path spec will not be processed. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>InputTargetType</maml:name> <maml:description> <maml:para>Sets the `Input.TargetType` option to only process objects with the specified TargetType. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LoggingLimitDebug</maml:name> <maml:description> <maml:para>Sets the `Logging.LimitDebug` option to limit debug messages to a list of named debug scopes. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LoggingLimitVerbose</maml:name> <maml:description> <maml:para>Sets the `Logging.LimitVerbose` option to limit verbose messages to a list of named verbose scopes. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LoggingRuleFail</maml:name> <maml:description> <maml:para>Sets the `Logging.RuleFail` option to generate an informational message for each rule fail. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">OutcomeLogStream</command:parameterValue> <dev:type> <maml:name>OutcomeLogStream</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LoggingRulePass</maml:name> <maml:description> <maml:para>Sets the `Logging.RulePass` option to generate an informational message for each rule pass. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">OutcomeLogStream</command:parameterValue> <dev:type> <maml:name>OutcomeLogStream</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OutputAs</maml:name> <maml:description> <maml:para>Sets the option `Output.As`. The `Output.As` option configures the type of results to produce, either detail or summary.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ResultFormat</command:parameterValue> <dev:type> <maml:name>ResultFormat</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OutputBanner</maml:name> <maml:description> <maml:para>Sets the option `Output.Banner`. The `Output.Banner` option configure information displayed with PSRule banner. This option is only applicable when using `Assert-PSRule` cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BannerFormat</command:parameterValue> <dev:type> <maml:name>BannerFormat</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OutputCulture</maml:name> <maml:description> <maml:para>Sets the option `Output.Culture`. The `Output.Culture` option configures the culture used to generated output. When multiple cultures are specified, the first matching culture will be used. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OutputEncoding</maml:name> <maml:description> <maml:para>Sets the option `Output.Encoding`. The `Output.Encoding` option configured the encoding used to write results to file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">OutputEncoding</command:parameterValue> <dev:type> <maml:name>OutputEncoding</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OutputFooter</maml:name> <maml:description> <maml:para>Sets the option `Output.Footer`. The `Output.Footer` option configures the information displayed for PSRule footer. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">FooterFormat</command:parameterValue> <dev:type> <maml:name>FooterFormat</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OutputFormat</maml:name> <maml:description> <maml:para>Sets the option `Output.Format`. The `Output.Format` option configures the format that results will be presented in. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">OutputFormat</command:parameterValue> <dev:type> <maml:name>OutputFormat</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Outcome"> <maml:name>OutputOutcome</maml:name> <maml:description> <maml:para>Sets the `Output.Outcome` option. This option can be set to include or exclude output results. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RuleOutcome</command:parameterValue> <dev:type> <maml:name>RuleOutcome</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Processed</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OutputPath</maml:name> <maml:description> <maml:para>Sets the option `Output.Path`. The `Output.Path` option configures an output file path to write results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OutputStyle</maml:name> <maml:description> <maml:para>Sets the option `Option.Style`. The `Output.Style` option configures the style that results will be presented in.</maml:para> <maml:para>This option only applies to `Assert-PSRule`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">OutputStyle</command:parameterValue> <dev:type> <maml:name>OutputStyle</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Client</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="JsonIndent"> <maml:name>OutputJsonIndent</maml:name> <maml:description> <maml:para>Sets the option `Output.JsonIndent`. The `Output.JsonIndent` option configures indentation for JSON output.</maml:para> <maml:para>This option only applies to `Get-PSRule`, `Invoke-PSRule` and `Assert-PSRule` cmdlets.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RuleIncludeLocal</maml:name> <maml:description> <maml:para>Sets the option `Rule.IncludeLocal`. The `Rule.IncludeLocal` option configures if local rules are automatically included. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PSRule.Configuration.PSRuleOption</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$option = New-PSRuleOption -Option @{ 'execution.mode' = 'ConstrainedLanguage' } @{ Name = 'Item 1' } | Invoke-PSRule -Option $option</dev:code> <dev:remarks> <maml:para>Create an options object and run rules in constrained mode.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$option = New-PSRuleOption -SuppressTargetName @{ 'storageAccounts.UseHttps' = 'TestObject1', 'TestObject3' };</dev:code> <dev:remarks> <maml:para>Create an options object that suppresses `TestObject1` and `TestObject3` for a rule named `storageAccounts.UseHttps`.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code># Create a custom function that returns a TargetName string $bindFn = { param ($TargetObject) $otherName = $TargetObject.PSObject.Properties['OtherName']; if ($otherName -eq $Null) { return $Null } return $otherName.Value; } # Specify the binding function script block code to execute $option = New-PSRuleOption -BindTargetName $bindFn;</dev:code> <dev:remarks> <maml:para>Creates an options object that uses a custom function to bind the TargetName of an object.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>$option = New-PSRuleOption -Configuration @{ 'appServiceMinInstanceCount' = 2 };</dev:code> <dev:remarks> <maml:para>Create an options object that sets the `appServiceMinInstanceCount` baseline configuration option to `2`.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://microsoft.github.io/PSRule/v1/commands/PSRule/en-US/New-PSRuleOption/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-PSRule</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-PSRuleOption</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-PSRuleOption</command:name> <command:verb>Set</command:verb> <command:noun>PSRuleOption</command:noun> <maml:description> <maml:para>Sets options that configure PSRule execution.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Sets options that configure PSRule execution.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-PSRuleOption</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>The path to a YAML file where options will be set. By default the current working path (`$PWD`) is used.</maml:para> <maml:para>Either a directory or file path can be specified. When a directory is used, `ps-rule.yaml` will be used as the file name.</maml:para> <maml:para>The file will be created if it does not exist. If the file already exists it will be merged with the existing options and overwritten .</maml:para> <maml:para>If the directory does not exist an error will be generated. To force the creation of the directory path use the `-Force` switch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$PWD</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Option</maml:name> <maml:description> <maml:para>An options object to use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSRuleOption</command:parameterValue> <dev:type> <maml:name>PSRuleOption</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Use this option to return the options object to the pipeline instead of saving to disk.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Force creation of directory path for Path parameter, when the directory does not already exist.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AllowClobber</maml:name> <maml:description> <maml:para>Overwrite YAML files that contain comments.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BindingIgnoreCase</maml:name> <maml:description> <maml:para>Sets the option `Binding.IgnoreCase`. The option `Binding.IgnoreCase` determines if binding operations are case-sensitive or not. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BindingField</maml:name> <maml:description> <maml:para>Sets the option `Binding.Field`. The option specified one or more custom field bindings. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BindingNameSeparator</maml:name> <maml:description> <maml:para>Sets the option `Binding.NameSeparator`. This option specifies the separator to use for qualified names. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BindingPreferTargetInfo</maml:name> <maml:description> <maml:para>Sets the option `Binding.PreferTargetInfo`. This option specifies if automatic binding is preferred over configured binding options. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="ConventionInclude"> <maml:name>Convention</maml:name> <maml:description> <maml:para>Sets the `Option.ConventionInclude` option. This option specifies the name of conventions to execute in the pipeline when processing objects. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="BindingTargetName"> <maml:name>TargetName</maml:name> <maml:description> <maml:para>Sets the option `Binding.TargetName`. This option specifies one or more properties of TargetObject to use to bind TargetName to. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="BindingTargetType"> <maml:name>TargetType</maml:name> <maml:description> <maml:para>Sets the option `Binding.TargetType`. This option specifies one or more properties of TargetObject to use to bind TargetType to. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BindingUseQualifiedName</maml:name> <maml:description> <maml:para>Sets the option `Binding.UseQualifiedName`. This option specifies is qualified target names are used. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="ExecutionInconclusiveWarning"> <maml:name>InconclusiveWarning</maml:name> <maml:description> <maml:para>Sets the option `Execution.InconclusiveWarning`. The `Execution.InconclusiveWarning` option determines if a warning is generated when the outcome of a rule is inconclusive. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="ExecutionNotProcessedWarning"> <maml:name>NotProcessedWarning</maml:name> <maml:description> <maml:para>Sets the `Execution.NotProcessedWarning` option. The `Execution.NotProcessedWarning` option determines if a warning is generated when an object is not processed by any rule. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeModule</maml:name> <maml:description> <maml:para>Sets the `Include.Module` option to include additional module sources. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludePath</maml:name> <maml:description> <maml:para>Sets the `Include.Path` option to include additional standalone sources. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="InputFormat"> <maml:name>Format</maml:name> <maml:description> <maml:para>Sets the `Input.Format` option to configure the input format for when a string is passed in as a target object. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">None</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Yaml</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Json</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Markdown</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">PowerShellData</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">File</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Detect</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">InputFormat</command:parameterValue> <dev:type> <maml:name>InputFormat</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Detect</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>InputIgnoreGitPath</maml:name> <maml:description> <maml:para>Sets the `Input.IgnoreGitPath` option to determine if files within the .git path are ignored. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>InputIgnoreRepositoryCommon</maml:name> <maml:description> <maml:para>Sets the `Input.IgnoreRepositoryCommon` option to determine if files common repository files are ignored. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="InputObjectPath"> <maml:name>ObjectPath</maml:name> <maml:description> <maml:para>Sets the `Input.ObjectPath` option to use an object path to use instead of the pipeline object. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>InputPathIgnore</maml:name> <maml:description> <maml:para>Sets the `Input.PathIgnore` option. If specified, files that match the path spec will not be processed. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>InputTargetType</maml:name> <maml:description> <maml:para>Sets the `Input.TargetType` option to only process objects with the specified TargetType.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LoggingLimitDebug</maml:name> <maml:description> <maml:para>Sets the `Logging.LimitDebug` option to limit debug messages to a list of named debug scopes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LoggingLimitVerbose</maml:name> <maml:description> <maml:para>Sets the `Logging.LimitVerbose` option to limit verbose messages to a list of named verbose scopes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LoggingRuleFail</maml:name> <maml:description> <maml:para>Sets the `Logging.RuleFail` option to generate an informational message for each rule fail.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">None</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Error</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Warning</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Information</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">OutcomeLogStream</command:parameterValue> <dev:type> <maml:name>OutcomeLogStream</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LoggingRulePass</maml:name> <maml:description> <maml:para>Sets the `Logging.RulePass` option to generate an informational message for each rule pass.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">None</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Error</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Warning</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Information</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">OutcomeLogStream</command:parameterValue> <dev:type> <maml:name>OutcomeLogStream</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OutputAs</maml:name> <maml:description> <maml:para>Sets the option `Output.As`. The `Output.As` option configures the type of results to produce, either detail or summary.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Detail</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Summary</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ResultFormat</command:parameterValue> <dev:type> <maml:name>ResultFormat</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Detail</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OutputBanner</maml:name> <maml:description> <maml:para>Sets the option `Output.Banner`. The `Output.Banner` option configure information displayed with PSRule banner. This option is only applicable when using `Assert-PSRule` cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BannerFormat</command:parameterValue> <dev:type> <maml:name>BannerFormat</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OutputCulture</maml:name> <maml:description> <maml:para>Sets the option `Output.Culture`. The `Output.Culture` option configures the culture used to generated output. When multiple cultures are specified, the first matching culture will be used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OutputEncoding</maml:name> <maml:description> <maml:para>Sets the option `Output.Encoding`. The `Output.Encoding` option configured the encoding used to write results to file.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Default</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">UTF8</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">UTF7</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Unicode</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">UTF32</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ASCII</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">OutputEncoding</command:parameterValue> <dev:type> <maml:name>OutputEncoding</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OutputFooter</maml:name> <maml:description> <maml:para>Sets the option `Output.Footer`. The `Output.Footer` option configures the information displayed for PSRule footer. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">FooterFormat</command:parameterValue> <dev:type> <maml:name>FooterFormat</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OutputFormat</maml:name> <maml:description> <maml:para>Sets the option `Output.Format`. The `Output.Format` option configures the format that results will be presented in.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">None</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Yaml</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Json</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Markdown</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">NUnit3</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Csv</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Wide</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">OutputFormat</command:parameterValue> <dev:type> <maml:name>OutputFormat</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Outcome"> <maml:name>OutputOutcome</maml:name> <maml:description> <maml:para>Sets the `Output.Outcome` option. This option can be set to include or exclude output results. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RuleOutcome</command:parameterValue> <dev:type> <maml:name>RuleOutcome</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Processed</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OutputPath</maml:name> <maml:description> <maml:para>Sets the option `Output.Path`. The `Output.Path` option configures an output file path to write results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OutputStyle</maml:name> <maml:description> <maml:para>Sets the option `Option.Style`. The `Output.Style` option configures the style that results will be presented in.</maml:para> <maml:para>This option only applies to `Assert-PSRule`.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Client</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Plain</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AzurePipelines</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">GitHubActions</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">OutputStyle</command:parameterValue> <dev:type> <maml:name>OutputStyle</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Client</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="JsonIndent"> <maml:name>OutputJsonIndent</maml:name> <maml:description> <maml:para>Sets the option `Output.JsonIndent`. The `Output.JsonIndent` option configures indentation for JSON output.</maml:para> <maml:para>This option only applies to `Get-PSRule`, `Invoke-PSRule` and `Assert-PSRule` cmdlets.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">0</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">1</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">2</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">3</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">4</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RuleIncludeLocal</maml:name> <maml:description> <maml:para>Sets the option `Rule.IncludeLocal`. The `Rule.IncludeLocal` option configures if local rules are automatically included. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>The path to a YAML file where options will be set. By default the current working path (`$PWD`) is used.</maml:para> <maml:para>Either a directory or file path can be specified. When a directory is used, `ps-rule.yaml` will be used as the file name.</maml:para> <maml:para>The file will be created if it does not exist. If the file already exists it will be merged with the existing options and overwritten .</maml:para> <maml:para>If the directory does not exist an error will be generated. To force the creation of the directory path use the `-Force` switch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$PWD</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Option</maml:name> <maml:description> <maml:para>An options object to use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSRuleOption</command:parameterValue> <dev:type> <maml:name>PSRuleOption</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Use this option to return the options object to the pipeline instead of saving to disk.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Force creation of directory path for Path parameter, when the directory does not already exist.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AllowClobber</maml:name> <maml:description> <maml:para>Overwrite YAML files that contain comments.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BindingIgnoreCase</maml:name> <maml:description> <maml:para>Sets the option `Binding.IgnoreCase`. The option `Binding.IgnoreCase` determines if binding operations are case-sensitive or not. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BindingField</maml:name> <maml:description> <maml:para>Sets the option `Binding.Field`. The option specified one or more custom field bindings. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BindingNameSeparator</maml:name> <maml:description> <maml:para>Sets the option `Binding.NameSeparator`. This option specifies the separator to use for qualified names. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BindingPreferTargetInfo</maml:name> <maml:description> <maml:para>Sets the option `Binding.PreferTargetInfo`. This option specifies if automatic binding is preferred over configured binding options. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="ConventionInclude"> <maml:name>Convention</maml:name> <maml:description> <maml:para>Sets the `Option.ConventionInclude` option. This option specifies the name of conventions to execute in the pipeline when processing objects. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="BindingTargetName"> <maml:name>TargetName</maml:name> <maml:description> <maml:para>Sets the option `Binding.TargetName`. This option specifies one or more properties of TargetObject to use to bind TargetName to. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="BindingTargetType"> <maml:name>TargetType</maml:name> <maml:description> <maml:para>Sets the option `Binding.TargetType`. This option specifies one or more properties of TargetObject to use to bind TargetType to. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BindingUseQualifiedName</maml:name> <maml:description> <maml:para>Sets the option `Binding.UseQualifiedName`. This option specifies is qualified target names are used. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="ExecutionInconclusiveWarning"> <maml:name>InconclusiveWarning</maml:name> <maml:description> <maml:para>Sets the option `Execution.InconclusiveWarning`. The `Execution.InconclusiveWarning` option determines if a warning is generated when the outcome of a rule is inconclusive. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="ExecutionNotProcessedWarning"> <maml:name>NotProcessedWarning</maml:name> <maml:description> <maml:para>Sets the `Execution.NotProcessedWarning` option. The `Execution.NotProcessedWarning` option determines if a warning is generated when an object is not processed by any rule. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeModule</maml:name> <maml:description> <maml:para>Sets the `Include.Module` option to include additional module sources. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludePath</maml:name> <maml:description> <maml:para>Sets the `Include.Path` option to include additional standalone sources. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="InputFormat"> <maml:name>Format</maml:name> <maml:description> <maml:para>Sets the `Input.Format` option to configure the input format for when a string is passed in as a target object. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">InputFormat</command:parameterValue> <dev:type> <maml:name>InputFormat</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Detect</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>InputIgnoreGitPath</maml:name> <maml:description> <maml:para>Sets the `Input.IgnoreGitPath` option to determine if files within the .git path are ignored. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>InputIgnoreRepositoryCommon</maml:name> <maml:description> <maml:para>Sets the `Input.IgnoreRepositoryCommon` option to determine if files common repository files are ignored. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="InputObjectPath"> <maml:name>ObjectPath</maml:name> <maml:description> <maml:para>Sets the `Input.ObjectPath` option to use an object path to use instead of the pipeline object. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>InputPathIgnore</maml:name> <maml:description> <maml:para>Sets the `Input.PathIgnore` option. If specified, files that match the path spec will not be processed. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>InputTargetType</maml:name> <maml:description> <maml:para>Sets the `Input.TargetType` option to only process objects with the specified TargetType.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LoggingLimitDebug</maml:name> <maml:description> <maml:para>Sets the `Logging.LimitDebug` option to limit debug messages to a list of named debug scopes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LoggingLimitVerbose</maml:name> <maml:description> <maml:para>Sets the `Logging.LimitVerbose` option to limit verbose messages to a list of named verbose scopes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LoggingRuleFail</maml:name> <maml:description> <maml:para>Sets the `Logging.RuleFail` option to generate an informational message for each rule fail.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">OutcomeLogStream</command:parameterValue> <dev:type> <maml:name>OutcomeLogStream</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LoggingRulePass</maml:name> <maml:description> <maml:para>Sets the `Logging.RulePass` option to generate an informational message for each rule pass.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">OutcomeLogStream</command:parameterValue> <dev:type> <maml:name>OutcomeLogStream</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OutputAs</maml:name> <maml:description> <maml:para>Sets the option `Output.As`. The `Output.As` option configures the type of results to produce, either detail or summary.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ResultFormat</command:parameterValue> <dev:type> <maml:name>ResultFormat</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Detail</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OutputBanner</maml:name> <maml:description> <maml:para>Sets the option `Output.Banner`. The `Output.Banner` option configure information displayed with PSRule banner. This option is only applicable when using `Assert-PSRule` cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BannerFormat</command:parameterValue> <dev:type> <maml:name>BannerFormat</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OutputCulture</maml:name> <maml:description> <maml:para>Sets the option `Output.Culture`. The `Output.Culture` option configures the culture used to generated output. When multiple cultures are specified, the first matching culture will be used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OutputEncoding</maml:name> <maml:description> <maml:para>Sets the option `Output.Encoding`. The `Output.Encoding` option configured the encoding used to write results to file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">OutputEncoding</command:parameterValue> <dev:type> <maml:name>OutputEncoding</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OutputFooter</maml:name> <maml:description> <maml:para>Sets the option `Output.Footer`. The `Output.Footer` option configures the information displayed for PSRule footer. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">FooterFormat</command:parameterValue> <dev:type> <maml:name>FooterFormat</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OutputFormat</maml:name> <maml:description> <maml:para>Sets the option `Output.Format`. The `Output.Format` option configures the format that results will be presented in.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">OutputFormat</command:parameterValue> <dev:type> <maml:name>OutputFormat</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Outcome"> <maml:name>OutputOutcome</maml:name> <maml:description> <maml:para>Sets the `Output.Outcome` option. This option can be set to include or exclude output results. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RuleOutcome</command:parameterValue> <dev:type> <maml:name>RuleOutcome</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Processed</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OutputPath</maml:name> <maml:description> <maml:para>Sets the option `Output.Path`. The `Output.Path` option configures an output file path to write results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OutputStyle</maml:name> <maml:description> <maml:para>Sets the option `Option.Style`. The `Output.Style` option configures the style that results will be presented in.</maml:para> <maml:para>This option only applies to `Assert-PSRule`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">OutputStyle</command:parameterValue> <dev:type> <maml:name>OutputStyle</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Client</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="JsonIndent"> <maml:name>OutputJsonIndent</maml:name> <maml:description> <maml:para>Sets the option `Output.JsonIndent`. The `Output.JsonIndent` option configures indentation for JSON output.</maml:para> <maml:para>This option only applies to `Get-PSRule`, `Invoke-PSRule` and `Assert-PSRule` cmdlets.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RuleIncludeLocal</maml:name> <maml:description> <maml:para>Sets the option `Rule.IncludeLocal`. The `Rule.IncludeLocal` option configures if local rules are automatically included. See about_PSRule_Options for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PSRule.Configuration.PSRuleOption</maml:name> </dev:type> <maml:description> <maml:para>When you use the `-PassThru` switch, an options object is returned to the pipeline.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Set-PSRuleOption -OutputFormat Yaml;</dev:code> <dev:remarks> <maml:para>Sets the `Output.Format` to `Yaml` for `ps-rule.yaml` in the current working path. If the `ps-rule.yaml` file exists, it is merged with the existing file and overwritten. If the file does not exist, a new file is created.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Set-PSRuleOption -OutputFormat Yaml -Path .\project-options.yaml;</dev:code> <dev:remarks> <maml:para>Sets the `Output.Format` to `Yaml` for `project-options.yaml` in the current working path. If the `project-options.yaml` file exists, it is merged with the existing file and overwritten. If the file does not exist, a new file is created.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://microsoft.github.io/PSRule/v1/commands/PSRule/en-US/Set-PSRuleOption/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-PSRuleOption</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Test-PSRuleTarget</command:name> <command:verb>Test</command:verb> <command:noun>PSRuleTarget</command:noun> <maml:description> <maml:para>Pass or fail objects against matching rules.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Evaluate objects against matching rules and return an overall pass or fail for the object as `$True` (pass) or `$False` (fail).</maml:para> <maml:para>PSRule uses the following logic to determine overall pass or fail for an object:</maml:para> <maml:para>- The object fails if: - Any rules fail or error. - Any rules are inconclusive. - The object passes if: - No matching rules were found. - All rules pass.</maml:para> <maml:para>By default, objects that do match any rules are not returned in results. To return `$True` for these objects, use `-Outcome All`.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Test-PSRuleTarget</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="p"> <maml:name>Path</maml:name> <maml:description> <maml:para>One or more paths to search for rule definitions within.</maml:para> <maml:para>If this parameter is not specified the current working path will be used, unless the `-Module` parameter is used.</maml:para> <maml:para>If the `-Module` parameter is used, rule definitions from the currently working path will not be included by default.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$PWD</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="n"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of a specific rule to evaluate. If this parameter is not specified all rules in search paths will be evaluated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Outcome</maml:name> <maml:description> <maml:para>Filter output to only show pipeline objects with a specific outcome.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Pass</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Fail</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Error</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">None</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Processed</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">All</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">RuleOutcome</command:parameterValue> <dev:type> <maml:name>RuleOutcome</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Pass, Fail, Error</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tag</maml:name> <maml:description> <maml:para>Only get rules with the specified tags set. If this parameter is not specified all rules in search paths will be returned.</maml:para> <maml:para>When more than one tag is used, all tags must match. Tags are not case sensitive. A tag value of `*` may be used to filter rules to any rule with the tag set, regardless of tag value.</maml:para> <maml:para>An array of tag values can be used to match a rule with either value. i.e. `severity = important, critical` matches rules with a category of either `important` or `critical`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="TargetObject"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The pipeline object to process rules for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Option</maml:name> <maml:description> <maml:para>Additional options that configure execution. A `PSRuleOption` can be created by using the `New-PSRuleOption` cmdlet. Alternatively, a hashtable or path to YAML file can be specified with options.</maml:para> <maml:para>For more information on PSRule options see about_PSRule_Options.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSRuleOption</command:parameterValue> <dev:type> <maml:name>PSRuleOption</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Format</maml:name> <maml:description> <maml:para>Configures the input format for when a string is passed in as a target object.</maml:para> <maml:para>When the `-InputObject` parameter or pipeline input is used, strings are treated as plain text by default. Set this option to either `Yaml`, `Json`, `Markdown`, `PowerShellData` to have PSRule deserialize the object.</maml:para> <maml:para>When the `-InputPath` parameter is used with a file path or URL. If the `Detect` format is used, the file extension will be used to automatically detect the format. When `-InputPath` is not used, `Detect` is the same as `None`.</maml:para> <maml:para>When this option is set to `File` PSRule scans the path and subdirectories specified by `-InputPath`. Files are treated as objects instead of being deserialized. Additional, PSRule uses the file extension as the object type. When files have no extension the whole file name is used.</maml:para> <maml:para>See `about_PSRule_Options` for details.</maml:para> <maml:para>This parameter takes precedence over the `Input.Format` option if set.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">None</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Yaml</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Json</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Markdown</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">PowerShellData</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Repository</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Detect</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">InputFormat</command:parameterValue> <dev:type> <maml:name>InputFormat</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Detect</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Convention</maml:name> <maml:description> <maml:para>Specifies conventions by name to execute in the pipeline when processing objects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Culture</maml:name> <maml:description> <maml:para>Specifies the culture to use for rule documentation and messages. By default, the culture of PowerShell is used.</maml:para> <maml:para>This option does not affect the culture used for the PSRule engine, which always uses the culture of PowerShell.</maml:para> <maml:para>The PowerShell cmdlet `Get-Culture` shows the current culture of PowerShell.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ObjectPath</maml:name> <maml:description> <maml:para>The name of a property to use instead of the pipeline object. If the property specified by `ObjectPath` is a collection or an array, then each item in evaluated separately.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TargetType</maml:name> <maml:description> <maml:para>Filters input objects by TargetType.</maml:para> <maml:para>If specified, only objects with the specified TargetType are processed. Objects that do not match TargetType are ignored. If multiple values are specified, only one TargetType must match. This parameter is not case-sensitive.</maml:para> <maml:para>By default, all objects are processed.</maml:para> <maml:para>This parameter if set, overrides the `Input.TargetType` option.</maml:para> <maml:para>To change the field TargetType is bound to set the `Binding.TargetType` option. For details see the about_PSRule_Options help topic.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="m"> <maml:name>Module</maml:name> <maml:description> <maml:para>Search for rule definitions within a module. When specified without the `-Path` parameter, only rule definitions in the module will be discovered.</maml:para> <maml:para>When both `-Path` and `-Module` are specified, rule definitions from both are discovered.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Test-PSRuleTarget</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="p"> <maml:name>Path</maml:name> <maml:description> <maml:para>One or more paths to search for rule definitions within.</maml:para> <maml:para>If this parameter is not specified the current working path will be used, unless the `-Module` parameter is used.</maml:para> <maml:para>If the `-Module` parameter is used, rule definitions from the currently working path will not be included by default.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$PWD</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="n"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of a specific rule to evaluate. If this parameter is not specified all rules in search paths will be evaluated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Outcome</maml:name> <maml:description> <maml:para>Filter output to only show pipeline objects with a specific outcome.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Pass</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Fail</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Error</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">None</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Processed</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">All</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">RuleOutcome</command:parameterValue> <dev:type> <maml:name>RuleOutcome</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Pass, Fail, Error</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tag</maml:name> <maml:description> <maml:para>Only get rules with the specified tags set. If this parameter is not specified all rules in search paths will be returned.</maml:para> <maml:para>When more than one tag is used, all tags must match. Tags are not case sensitive. A tag value of `*` may be used to filter rules to any rule with the tag set, regardless of tag value.</maml:para> <maml:para>An array of tag values can be used to match a rule with either value. i.e. `severity = important, critical` matches rules with a category of either `important` or `critical`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Option</maml:name> <maml:description> <maml:para>Additional options that configure execution. A `PSRuleOption` can be created by using the `New-PSRuleOption` cmdlet. Alternatively, a hashtable or path to YAML file can be specified with options.</maml:para> <maml:para>For more information on PSRule options see about_PSRule_Options.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSRuleOption</command:parameterValue> <dev:type> <maml:name>PSRuleOption</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Format</maml:name> <maml:description> <maml:para>Configures the input format for when a string is passed in as a target object.</maml:para> <maml:para>When the `-InputObject` parameter or pipeline input is used, strings are treated as plain text by default. Set this option to either `Yaml`, `Json`, `Markdown`, `PowerShellData` to have PSRule deserialize the object.</maml:para> <maml:para>When the `-InputPath` parameter is used with a file path or URL. If the `Detect` format is used, the file extension will be used to automatically detect the format. When `-InputPath` is not used, `Detect` is the same as `None`.</maml:para> <maml:para>When this option is set to `File` PSRule scans the path and subdirectories specified by `-InputPath`. Files are treated as objects instead of being deserialized. Additional, PSRule uses the file extension as the object type. When files have no extension the whole file name is used.</maml:para> <maml:para>See `about_PSRule_Options` for details.</maml:para> <maml:para>This parameter takes precedence over the `Input.Format` option if set.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">None</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Yaml</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Json</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Markdown</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">PowerShellData</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Repository</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Detect</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">InputFormat</command:parameterValue> <dev:type> <maml:name>InputFormat</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Detect</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Convention</maml:name> <maml:description> <maml:para>Specifies conventions by name to execute in the pipeline when processing objects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Culture</maml:name> <maml:description> <maml:para>Specifies the culture to use for rule documentation and messages. By default, the culture of PowerShell is used.</maml:para> <maml:para>This option does not affect the culture used for the PSRule engine, which always uses the culture of PowerShell.</maml:para> <maml:para>The PowerShell cmdlet `Get-Culture` shows the current culture of PowerShell.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ObjectPath</maml:name> <maml:description> <maml:para>The name of a property to use instead of the pipeline object. If the property specified by `ObjectPath` is a collection or an array, then each item in evaluated separately.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TargetType</maml:name> <maml:description> <maml:para>Filters input objects by TargetType.</maml:para> <maml:para>If specified, only objects with the specified TargetType are processed. Objects that do not match TargetType are ignored. If multiple values are specified, only one TargetType must match. This parameter is not case-sensitive.</maml:para> <maml:para>By default, all objects are processed.</maml:para> <maml:para>This parameter if set, overrides the `Input.TargetType` option.</maml:para> <maml:para>To change the field TargetType is bound to set the `Binding.TargetType` option. For details see the about_PSRule_Options help topic.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="m"> <maml:name>Module</maml:name> <maml:description> <maml:para>Search for rule definitions within a module. When specified without the `-Path` parameter, only rule definitions in the module will be discovered.</maml:para> <maml:para>When both `-Path` and `-Module` are specified, rule definitions from both are discovered.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="f"> <maml:name>InputPath</maml:name> <maml:description> <maml:para>Instead of processing objects from the pipeline, import objects file the specified file paths.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="p"> <maml:name>Path</maml:name> <maml:description> <maml:para>One or more paths to search for rule definitions within.</maml:para> <maml:para>If this parameter is not specified the current working path will be used, unless the `-Module` parameter is used.</maml:para> <maml:para>If the `-Module` parameter is used, rule definitions from the currently working path will not be included by default.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$PWD</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="n"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of a specific rule to evaluate. If this parameter is not specified all rules in search paths will be evaluated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Outcome</maml:name> <maml:description> <maml:para>Filter output to only show pipeline objects with a specific outcome.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RuleOutcome</command:parameterValue> <dev:type> <maml:name>RuleOutcome</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Pass, Fail, Error</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tag</maml:name> <maml:description> <maml:para>Only get rules with the specified tags set. If this parameter is not specified all rules in search paths will be returned.</maml:para> <maml:para>When more than one tag is used, all tags must match. Tags are not case sensitive. A tag value of `*` may be used to filter rules to any rule with the tag set, regardless of tag value.</maml:para> <maml:para>An array of tag values can be used to match a rule with either value. i.e. `severity = important, critical` matches rules with a category of either `important` or `critical`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="TargetObject"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The pipeline object to process rules for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Option</maml:name> <maml:description> <maml:para>Additional options that configure execution. A `PSRuleOption` can be created by using the `New-PSRuleOption` cmdlet. Alternatively, a hashtable or path to YAML file can be specified with options.</maml:para> <maml:para>For more information on PSRule options see about_PSRule_Options.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSRuleOption</command:parameterValue> <dev:type> <maml:name>PSRuleOption</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Format</maml:name> <maml:description> <maml:para>Configures the input format for when a string is passed in as a target object.</maml:para> <maml:para>When the `-InputObject` parameter or pipeline input is used, strings are treated as plain text by default. Set this option to either `Yaml`, `Json`, `Markdown`, `PowerShellData` to have PSRule deserialize the object.</maml:para> <maml:para>When the `-InputPath` parameter is used with a file path or URL. If the `Detect` format is used, the file extension will be used to automatically detect the format. When `-InputPath` is not used, `Detect` is the same as `None`.</maml:para> <maml:para>When this option is set to `File` PSRule scans the path and subdirectories specified by `-InputPath`. Files are treated as objects instead of being deserialized. Additional, PSRule uses the file extension as the object type. When files have no extension the whole file name is used.</maml:para> <maml:para>See `about_PSRule_Options` for details.</maml:para> <maml:para>This parameter takes precedence over the `Input.Format` option if set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">InputFormat</command:parameterValue> <dev:type> <maml:name>InputFormat</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Detect</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Convention</maml:name> <maml:description> <maml:para>Specifies conventions by name to execute in the pipeline when processing objects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Culture</maml:name> <maml:description> <maml:para>Specifies the culture to use for rule documentation and messages. By default, the culture of PowerShell is used.</maml:para> <maml:para>This option does not affect the culture used for the PSRule engine, which always uses the culture of PowerShell.</maml:para> <maml:para>The PowerShell cmdlet `Get-Culture` shows the current culture of PowerShell.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ObjectPath</maml:name> <maml:description> <maml:para>The name of a property to use instead of the pipeline object. If the property specified by `ObjectPath` is a collection or an array, then each item in evaluated separately.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TargetType</maml:name> <maml:description> <maml:para>Filters input objects by TargetType.</maml:para> <maml:para>If specified, only objects with the specified TargetType are processed. Objects that do not match TargetType are ignored. If multiple values are specified, only one TargetType must match. This parameter is not case-sensitive.</maml:para> <maml:para>By default, all objects are processed.</maml:para> <maml:para>This parameter if set, overrides the `Input.TargetType` option.</maml:para> <maml:para>To change the field TargetType is bound to set the `Binding.TargetType` option. For details see the about_PSRule_Options help topic.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="m"> <maml:name>Module</maml:name> <maml:description> <maml:para>Search for rule definitions within a module. When specified without the `-Path` parameter, only rule definitions in the module will be discovered.</maml:para> <maml:para>When both `-Path` and `-Module` are specified, rule definitions from both are discovered.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="f"> <maml:name>InputPath</maml:name> <maml:description> <maml:para>Instead of processing objects from the pipeline, import objects file the specified file paths.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> </dev:type> <maml:description> <maml:para>You can pipe any object to Test-PSRuleTarget .</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> </dev:type> <maml:description> <maml:para>Returns `$True` when the object passes and `$False` when the object fails.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>@{ Name = 'Item 1' } | Test-PSRuleTarget;</dev:code> <dev:remarks> <maml:para>Evaluate a simple hashtable on the pipeline against rules loaded from the current working path.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://microsoft.github.io/PSRule/v1/commands/PSRule/en-US/Test-PSRuleTarget/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-PSRule</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Assert-PSRule</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-PSRule</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |