en-US/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>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.</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 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 then one tag is used, all tags must match. Tag names are not case sensitive, tag values are 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: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="none"> <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: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.</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="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 then one tag is used, all tags must match. Tag names are not case sensitive, tag values are 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: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="none"> <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: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 Description -------- ----------- 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:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/BernieWhite/PSRule/blob/master/docs/commands/PSRule/en-US/Get-PSRule.md</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>Invoke-PSRule</command:name> <command:verb>Invoke</command:verb> <command:noun>PSRule</command:noun> <maml:description> <maml:para>Evaluate pipeline objects against matching rules.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Evaluate pipeline objects against matching rules.</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.</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 rules 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: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 evaluate rules with the specified tags set. If this parameter is not specified all rules in search paths will be evaluated.</maml:para> <maml:para>When more than one tag is used, all tags must match. Tag names are not case sensitive, tag values are 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: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 individual 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. When this option is used and set to either `Yaml` or `Json`, strings are read as YAML or JSON and are converted to an object.</maml:para> <maml:para>- When the `-InputPath` parameter is used with a file path or URL, by default the file extension (either `.yaml`, `.yml` or `.json`) will be used to automatically detect the format as YAML or 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: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>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>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="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OutputFormat</maml:name> <maml:Description> <maml:para>Configures the format that output is 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: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: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.</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 rules 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: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 evaluate rules with the specified tags set. If this parameter is not specified all rules in search paths will be evaluated.</maml:para> <maml:para>When more than one tag is used, all tags must match. Tag names are not case sensitive, tag values are 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: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 individual 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. When this option is used and set to either `Yaml` or `Json`, strings are read as YAML or JSON and are converted to an object.</maml:para> <maml:para>- When the `-InputPath` parameter is used with a file path or URL, by default the file extension (either `.yaml`, `.yml` or `.json`) will be used to automatically detect the format as YAML or 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: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>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>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="none"> <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>OutputFormat</maml:name> <maml:Description> <maml:para>Configures the format that output is 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: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="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.</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="none"> <maml:name>Outcome</maml:name> <maml:Description> <maml:para>Filter output to only show rules 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 evaluate rules with the specified tags set. If this parameter is not specified all rules in search paths will be evaluated.</maml:para> <maml:para>When more than one tag is used, all tags must match. Tag names are not case sensitive, tag values are 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: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 individual 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. When this option is used and set to either `Yaml` or `Json`, strings are read as YAML or JSON and are converted to an object.</maml:para> <maml:para>- When the `-InputPath` parameter is used with a file path or URL, by default the file extension (either `.yaml`, `.yml` or `.json`) will be used to automatically detect the format as YAML or JSON.</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>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>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="none"> <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>OutputFormat</maml:name> <maml:Description> <maml:para>Configures the format that output is 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: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 Message -------- ------- ------- isFruit Fail Fruit is only Apple, Orange and Pear TargetName: Apple RuleName Outcome Message -------- ------- ------- 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 Message -------- ------- ------- 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://github.com/BernieWhite/PSRule/blob/master/docs/commands/PSRule/en-US/Invoke-PSRule.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-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="false" 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.</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="1" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>The path to a YAML file containing options.</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>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.</maml:para> <maml:para>For more information on PSRule options see about_PSRule_Options.</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.</maml:para> <maml:para>For more information on PSRule options see about_PSRule_Options.</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>BaselineConfiguration</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. BaselineConfiguration also accepts a hashtable of configuration values as key/ value pairs.</maml:para> <maml:para>For more information on PSRule options see about_PSRule_Options.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">BaselineConfiguration</command:parameterValue> <dev:type> <maml:name>BaselineConfiguration</maml:name> <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.</maml:para> <maml:para>For more information on PSRule options see about_PSRule_Options.</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:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" 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.</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="1" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>The path to a YAML file containing options.</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>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.</maml:para> <maml:para>For more information on PSRule options see about_PSRule_Options.</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.</maml:para> <maml:para>For more information on PSRule options see about_PSRule_Options.</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>BaselineConfiguration</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. BaselineConfiguration also accepts a hashtable of configuration values as key/ value pairs.</maml:para> <maml:para>For more information on PSRule options see about_PSRule_Options.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">BaselineConfiguration</command:parameterValue> <dev:type> <maml:name>BaselineConfiguration</maml:name> <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.</maml:para> <maml:para>For more information on PSRule options see about_PSRule_Options.</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: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 -BaselineConfiguration @{ '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://github.com/BernieWhite/PSRule/blob/master/docs/commands/PSRule/en-US/New-PSRuleOption.md</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>Test-PSRuleTarget</command:name> <command:verb>Test</command:verb> <command:noun>PSRuleTarget</command:noun> <maml:description> <maml:para>Pass or fail pipeline objects against matching rules.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Evaluate pipeline 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 rules were found that match preconditions, name and tag filters. - All rules pass.</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>Tag</maml:name> <maml:Description> <maml:para>Only evaluate rules with the specified tags set. If this parameter is not specified all rules in search paths will be evaluated.</maml:para> <maml:para>When more than one tag is used, all tags must match. Tag names are not case sensitive, tag values are 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: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. When this option is used and set to either `Yaml` or `Json`, strings are read as YAML or JSON and are converted to an object.</maml:para> <maml:para>- When the `-InputPath` parameter is used with a file path or URL, by default the file extension (either `.yaml`, `.yml` or `.json`) will be used to automatically detect the format as YAML or 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: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>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>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>Tag</maml:name> <maml:Description> <maml:para>Only evaluate rules with the specified tags set. If this parameter is not specified all rules in search paths will be evaluated.</maml:para> <maml:para>When more than one tag is used, all tags must match. Tag names are not case sensitive, tag values are 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: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. When this option is used and set to either `Yaml` or `Json`, strings are read as YAML or JSON and are converted to an object.</maml:para> <maml:para>- When the `-InputPath` parameter is used with a file path or URL, by default the file extension (either `.yaml`, `.yml` or `.json`) will be used to automatically detect the format as YAML or 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: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>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>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="none"> <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>Tag</maml:name> <maml:Description> <maml:para>Only evaluate rules with the specified tags set. If this parameter is not specified all rules in search paths will be evaluated.</maml:para> <maml:para>When more than one tag is used, all tags must match. Tag names are not case sensitive, tag values are 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: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. When this option is used and set to either `Yaml` or `Json`, strings are read as YAML or JSON and are converted to an object.</maml:para> <maml:para>- When the `-InputPath` parameter is used with a file path or URL, by default the file extension (either `.yaml`, `.yml` or `.json`) will be used to automatically detect the format as YAML or JSON.</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>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>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="none"> <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: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://github.com/BernieWhite/PSRule/blob/master/docs/commands/PSRule/en-US/Test-PSRuleTarget.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-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> |