en-US/about_PSRule_Options.help.txt

TOPIC
    about_psrule_options
 
SHORT DESCRIPTION
    Describes additional options that can be used during rule execution.
 
LONG DESCRIPTION
    PSRule lets you use options when calling cmdlets such as `Invoke-PSRule` and
    `Test-PSRuleTarget` to change how rules are processed. This topic describes
    what options are available, when to and how to use them.
    The following workspace options are available for use:
    -
    Execution.LanguageMode
    -
    Execution.InconclusiveWarning
    -
    Execution.NotProcessedWarning
    -
    Input.Format
    -
    Input.ObjectPath
    -
    Input.TargetType
    -
    Logging.LimitDebug
    -
    Logging.LimitVerbose
    -
    Logging.RuleFail
    -
    Logging.RulePass
    -
    Output.As
    -
    Output.Encoding
    -
    Output.Format
    -
    Output.Path
    -
    Output.Style
    -
    Suppression
    Additionally the following baseline options can be included:
-
    Binding.IgnoreCase
    -
    Binding.Field
    -
    Binding.TargetName
    -
    Binding.TargetType
    -
    Configuration
    -
    Rule.Include
    -
    Rule.Exclude
    -
    Rule.Tag
    See
    about_PSRule_Baseline
    for more information on baseline options.
    Options can be used with the following PSRule cmdlets:
    - Get-PSRule
    - Get-PSRuleBaseline
    - Get-PSRuleHelp
    - Invoke-PSRule
    - Test-PSRuleTarget
    Each of these cmdlets support:
    - Using the `-Option` parameter with an object created with the
    `New-PSRuleOption` cmdlet. See cmdlet help for syntax and examples.
    - Using the `-Option` parameter with a hashtable object.
    - Using the `-Option` parameter with a YAML file path.
    When using a hashtable object `@{}`, one or more options can be specified as
    keys using a dotted notation.
    For example:
 
    $option = @{ 'Output.Format' = 'Yaml' };
    Invoke-PSRule -Path . -Option $option;
 
    Invoke-PSRule -Path . -Option @{ 'Output.Format' = 'Yaml' };
 
    The above example shows how the `Output.Format` option as a hashtable key
    can be used. Continue reading for a full list of options and how each can be used.
    Alternatively, options can be stored in a YAML formatted file and loaded
    from disk. Storing options as YAML allows different configurations to be
    loaded in a repeatable way instead of having to create an options object
    each time.
    Options are stored as YAML properties using a lower camel case naming
    convention, for example:
 
    output:
      format: Yaml
 
    The `Set-PSRuleOption` cmdlet can be used to set options stored in YAML or
    the YAML file can be manually edited.
 
    Set-PSRuleOption -OutputFormat Yaml;
 
    By default, PSRule will automatically look for a default YAML options file
    in the current working directory. Alternatively, you can specify a specific
    file path.
    For example:
 
    Invoke-PSRule -Option '.\myconfig.yml';
 
    New-PSRuleOption -Path '.\myconfig.yaml';
 
    PSRule uses any of the following file names (in order) as the default YAML
    options file. If more than one of these files exist, the following order
    will be used to find the first match.
    - `ps-rule.yaml`
    - `ps-rule.yml`
    - `psrule.yaml`
    - `psrule.yml`
    We recommend only using lowercase characters as shown above. This is because
    not all operation systems treat case in the same way.
 
    BINDING.IGNORECASE
    When evaluating an object, PSRule extracts a few key properties from the
    object to help filter rules and display output results. The process of
    extract these key properties is called
    binding
    . The properties that PSRule uses for binding can be customized by providing
    a order list of alternative properties to use. See
    `Binding.TargetName`
    for these options.
    - By default, custom property binding finds the first matching property by
    name regardless of case. i.e. `Binding.IgnoreCase` is `true`.
    - To make custom bindings case sensitive, set the `Binding.IgnoreCase`
    option to `false`. - Changing this option will affect custom property
    bindings for both
    TargetName
    and
    TargetType
    . - Setting this option has no affect on binding defaults or custom scripts.
    This option can be specified using:
 
    # PowerShell: Using the BindingIgnoreCase parameter
    $option = New-PSRuleOption -BindingIgnoreCase $False;
 
    # PowerShell: Using the Binding.IgnoreCase hashtable key
    $option = New-PSRuleOption -Option @{ 'Binding.IgnoreCase' = $False };
 
    # PowerShell: Using the BindingIgnoreCase parameter to set YAML
    Set-PSRuleOption -BindingIgnoreCase $False;
 
    # YAML: Using the binding/ignoreCase property
    binding:
      ignoreCase: false
 
    BINDING.FIELD
    When an object is passed from the pipeline, PSRule automatically extracts
    fields from object properties. PSRule provides standard fields such as
    `TargetName` and `TargetType`. In addition to standard fields, custom fields
    can be bound. Custom fields are available to rules and included in output.
    PSRule uses the following logic to determine which property should be used
    for binding:
    - By default PSRule will not extract any custom fields.
    - If custom fields are configured, PSRule will attempt to bind the field. -
    If
    none
    of the configured property names exist, the field will be skipped. - If
    more then one property name is configured, the order they are specified in
    the configuration determines precedence. - i.e. The first configured
    property name will take precedence over the second property name. - By
    default the property name will be matched ignoring case sensitivity. To use
    a case sensitive match, configure the
    Binding.IgnoreCase
    option.
Custom field bindings can be specified using:
 
    # PowerShell: Using the BindingField parameter
    $option = New-PSRuleOption -BindingField @{ id = 'ResourceId', 'AlternativeId' };
 
    # PowerShell: Using the Binding.Field hashtable key
    $option = New-PSRuleOption -Option @{ 'Binding.Field' = @{ id = 'ResourceId', 'AlternativeId' } };
 
    # PowerShell: Using the BindingField parameter to set YAML
    Set-PSRuleOption -BindingField @{ id = 'ResourceId', 'AlternativeId' };
 
    # YAML: Using the binding/field property
    binding:
      field:
        id:
        - ResourceId
        - AlternativeId
 
    BINDING.TARGETNAME
    When an object is passed from the pipeline, PSRule assigns the object a
    TargetName
    .
    TargetName
    is used in output results to identify one object from another. Many objects
    could be passed down the pipeline at the same time, so using a
    TargetName
    that is meaningful is important.
    TargetName
    is also used for advanced features such as rule suppression.
    The value that PSRule uses for
    TargetName
    is configurable. PSRule uses the following logic to determine what
    TargetName
    should be used:
    - By default PSRule will: - Use `TargetName` or `Name` properties on the
    object. These property names are case insensitive. - If both `TargetName`
    and `Name` properties exist, `TargetName` will take precedence over `Name`.
     - If neither `TargetName` or `Name` properties exist, a SHA1 hash of the
    object will be used as
    TargetName
    . - If custom
    TargetName
    binding properties are configured, the property names specified will
    override the defaults. - If
    none
    of the configured property names exist, PSRule will revert back to
    `TargetName` then `Name`. - If more then one property name is configured,
    the order they are specified in the configuration determines precedence.
    - i.e. The first configured property name will take precedence over the
    second property name. - By default the property name will be matched
    ignoring case sensitivity. To use a case sensitive match, configure the
    Binding.IgnoreCase
    option. - If a custom
    TargetName
    binding function is specified, the function will be evaluated first before
    any other option. - If the function returns `$Null` then custom
    properties, `TargetName` and `Name` properties will be used. - The custom
    binding function is executed outside the PSRule engine, so PSRule keywords
    and variables will not be available. - Custom binding functions are
    blocked in constrained language mode is used. See
    language mode
    for more information.
    Custom property names to use for binding can be specified using:
 
    # PowerShell: Using the TargetName parameter
    $option = New-PSRuleOption -TargetName 'ResourceName', 'AlternateName';
 
    # PowerShell: Using the Binding.TargetName hashtable key
    $option = New-PSRuleOption -Option @{ 'Binding.TargetName' = 'ResourceName', 'AlternateName' };
 
    # PowerShell: Using the TargetName parameter to set YAML
    Set-PSRuleOption -TargetName 'ResourceName', 'AlternateName';
 
    # YAML: Using the binding/targetName property
    binding:
      targetName:
      - ResourceName
      - AlternateName
 
    To specify a custom binding function use:
 
    # Create a custom function that returns a TargetName string
    $bindFn = {
        param ($TargetObject)
     
        $otherName = $TargetObject.PSObject.Properties['OtherName'];
        if ($Null -eq $otherName) { return $Null }
        return $otherName.Value;
    }
     
    # Specify the binding function script block code to execute
    $option = New-PSRuleOption -BindTargetName $bindFn;
 
    BINDING.TARGETTYPE
    When an object is passed from the pipeline, PSRule assigns the object a
    TargetType
    .
    TargetType
    is used to filter rules based on object type and appears in output results.
    The value that PSRule uses for
    TargetType
    is configurable. PSRule uses the following logic to determine what
    TargetType
    should be used:
    - By default PSRule will: - Use the default type presented by PowerShell
    from `TypeNames`. i.e. `.PSObject.TypeNames[0]` - If custom
    TargetType
    binding properties are configured, the property names specified will
    override the defaults. - If
    none
    of the configured property names exist, PSRule will revert back to the type
    presented by PowerShell. - If more then one property name is configured,
    the order they are specified in the configuration determines precedence.
    - i.e. The first configured property name will take precedence over the
    second property name. - By default the property name will be matched
    ignoring case sensitivity. To use a case sensitive match, configure the
    `Binding.IgnoreCase`
    option. - If a custom
    TargetType
    binding function is specified, the function will be evaluated first before
    any other option. - If the function returns `$Null` then custom
    properties, or the type presented by PowerShell will be used in order
    instead. - The custom binding function is executed outside the PSRule
    engine, so PSRule keywords and variables will not be available. - Custom
    binding functions are blocked in constrained language mode is used. See
    language mode
    for more information.
    Custom property names to use for binding can be specified using:
 
    # PowerShell: Using the TargetType parameter
    $option = New-PSRuleOption -TargetType 'ResourceType', 'kind';
 
    # PowerShell: Using the Binding.TargetType hashtable key
    $option = New-PSRuleOption -Option @{ 'Binding.TargetType' = 'ResourceType', 'kind' };
 
    # PowerShell: Using the TargetType parameter to set YAML
    Set-PSRuleOption -TargetType 'ResourceType', 'kind';
 
    # YAML: Using the binding/targetType property
    binding:
      targetType:
      - ResourceType
      - kind
 
    To specify a custom binding function use:
 
    # Create a custom function that returns a TargetType string
    $bindFn = {
        param ($TargetObject)
     
        $otherType = $TargetObject.PSObject.Properties['OtherType'];
     
        if ($otherType -eq $Null) {
            return $Null
        }
     
        return $otherType.Value;
    }
     
    # Specify the binding function script block code to execute
    $option = New-PSRuleOption -BindTargetType $bindFn;
 
    CONFIGURATION
    Configures a set of baseline configuration values that can be used in rule
    definitions instead of using hard coded values.
    This option can be specified using:
 
    # PowerShell: Using the BaselineConfiguration option with a hashtable
    $option = New-PSRuleOption -BaselineConfiguration @{ appServiceMinInstanceCount = 2 };
 
    # YAML: Using the configuration property
    configuration:
      appServiceMinInstanceCount: 2
 
    EXECUTION.LANGUAGEMODE
    Unless PowerShell has been constrained, full language features of PowerShell
    are available to use within rule definitions. In locked down environments, a
    reduced set of language features may be desired.
    When PSRule is executed in an environment configured for Device Guard, only
    constrained language features are available.
    The following language modes are available for use in PSRule:
    - FullLanguage
    - ConstrainedLanguage
    This option can be specified using:
 
    # PowerShell: Using the Execution.LanguageMode hashtable key
    $option = New-PSRuleOption -Option @{ 'Execution.LanguageMode' = 'ConstrainedLanguage' };
 
    # YAML: Using the execution/languageMode property
    execution:
      languageMode: ConstrainedLanguage
 
    EXECUTION.INCONCLUSIVEWARNING
    When defining rules, it is possible not return a valid `$True` or `$False`
    result within the definition script block.
    Rule authors should not intentionally avoid returning a result, however a
    possible cause for not returning a result may be a rule logic error.
    If a rule should not be evaluated, use pre-conditions to avoid processing
    the rule for objects where the rule is not applicable.
    In cases where the rule does not return a result it is marked as inconclusive.
    Inconclusive results will:
    - Generate a warning by default.
    - Fail the object. Outcome will be reported as `Fail` with an OutcomeReason
    of `Inconclusive`.
    The inconclusive warning can be disabled by using:
 
    # PowerShell: Using the InconclusiveWarning parameter
    $option = New-PSRuleOption -InconclusiveWarning $False;
 
    # PowerShell: Using the Execution.InconclusiveWarning hashtable key
    $option = New-PSRuleOption -Option @{ 'Execution.InconclusiveWarning' = $False };
 
    # PowerShell: Using the InconclusiveWarning parameter to set YAML
    Set-PSRuleOption -InconclusiveWarning $False;
 
    # YAML: Using the execution/inconclusiveWarning property
    execution:
      inconclusiveWarning: false
 
    EXECUTION.NOTPROCESSEDWARNING
    When evaluating rules, it is possible to incorrectly select a path with
    rules that use pre-conditions that do not accept the pipeline object.
    In this case the object has not been processed by any rule.
    Not processed objects will:
    - Generate a warning by default.
    - Pass the object. Outcome will be reported as `None`.
    The not processed warning can be disabled by using:
 
    # PowerShell: Using the NotProcessedWarning parameter
    $option = New-PSRuleOption -NotProcessedWarning $False;
 
    # PowerShell: Using the Execution.NotProcessedWarning hashtable key
    $option = New-PSRuleOption -Option @{ 'Execution.NotProcessedWarning' = $False };
 
    # PowerShell: Using the NotProcessedWarning parameter to set YAML
    Set-PSRuleOption -NotProcessedWarning $False;
 
    # YAML: Using the execution/notProcessedWarning property
    execution:
      notProcessedWarning: false
 
    INPUT.FORMAT
    Configures the input format for when a string is passed in as a target object.
    Use this option with `Assert-PSRule`, `Invoke-PSRule` or `Test-PSRuleTarget`.
    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.
    The `-Format` parameter will override any value set in configuration.
    The following formats are available:
    - None - Treat strings as plain text.
    - Yaml - Treat strings as one or more YAML objects.
    - Json - Treat strings as one or more JSON objects.
    - Markdown - Treat strings as a markdown object.
    - PowerShellData - Treat strings as a PowerShell data object.
    - Detect - Detect format based on file extension. This is the default.
    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`.
    Detect uses matches the following file extensions:
    - Yaml - `.yaml` or `.yml`
    - Json - `.json`
    - Markdown - `.md`
    - PowerShellData - `.psd1`
    The `Markdown` format does not parse the whole markdown document.
    Specifically this format deserializes YAML front matter from the top of the
    document if any exists.
    This option can be specified using:
 
    # PowerShell: Using the Format parameter
    $option = New-PSRuleOption -Format Yaml;
 
    # PowerShell: Using the Input.Format hashtable key
    $option = New-PSRuleOption -Option @{ 'Input.Format' = 'Yaml' };
 
    # PowerShell: Using the Format parameter to set YAML
    Set-PSRuleOption -Format Yaml;
 
    # YAML: Using the input/format property
    input:
      format: Yaml
 
    INPUT.OBJECTPATH
    The object path to a property to use instead of the pipeline object.
    By default, PSRule processes objects passed from the pipeline against
    selected rules. When this option is set, instead of evaluating the pipeline
    object, PSRule looks for a property of the pipeline object specified by
    `ObjectPath` and uses that instead. If the property specified by
    `ObjectPath` is a collection/ array, then each item is evaluated separately.
    If the property specified by `ObjectPath` does not exist, PSRule skips the object.
    When using `Invoke-PSRule`, `Test-PSRuleTarget` and `Assert-PSRule` the
    `-ObjectPath` parameter will override any value set in configuration.
    This option can be specified using:
 
    # PowerShell: Using the ObjectPath parameter
    $option = New-PSRuleOption -ObjectPath 'items';
 
    # PowerShell: Using the Input.ObjectPath hashtable key
    $option = New-PSRuleOption -Option @{ 'Input.ObjectPath' = 'items' };
 
    # PowerShell: Using the ObjectPath parameter to set YAML
    Set-PSRuleOption -ObjectPath 'items';
 
    # YAML: Using the input/objectPath property
    input:
      objectPath: items
 
    INPUT.TARGETTYPE
    Filters input objects by TargetType.
    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 option is not case-sensitive.
    By default, all objects are processed.
    To change the field TargetType is bound to set the `Binding.TargetType` option.
    When using `Invoke-PSRule`, `Test-PSRuleTarget` and `Assert-PSRule` the
    `-TargetType` parameter will override any value set in configuration.
    This option can be specified using:
 
    # PowerShell: Using the InputTargetType parameter
    $option = New-PSRuleOption -InputTargetType 'virtualMachine';
 
    # PowerShell: Using the Input.TargetType hashtable key
    $option = New-PSRuleOption -Option @{ 'Input.TargetType' = 'virtualMachine' };
 
    # PowerShell: Using the InputTargetType parameter to set YAML
    Set-PSRuleOption -InputTargetType 'virtualMachine';
 
    # YAML: Using the input/targetType property
    input:
      targetType:
      - virtualMachine
 
    LOGGING.LIMITDEBUG
    Limits debug messages to a list of named debug scopes.
    When using the `-Debug` switch or preference variable, by default PSRule
    cmdlets log all debug output. When using debug output for debugging a
    specific rule, it may be helpful to limit debug message to a specific rule.
    To identify a rule to include in debug output use the rule name.
    The following built-in scopes exist in addition to rule names:
    - `[Discovery.Source]` - Discovery messages for `.Rule.ps1` files and rule modules.
    - `[Discovery.Rule]` - Discovery messages for individual rules within
    `.Rule.ps1` files.
    This option can be specified using:
 
    # PowerShell: Using the LoggingLimitDebug parameter
    $option = New-PSRuleOption -LoggingLimitDebug Rule1, Rule2;
 
    # PowerShell: Using the Logging.LimitDebug hashtable key
    $option = New-PSRuleOption -Option @{ 'Logging.LimitDebug' = Rule1, Rule2 };
 
    # PowerShell: Using the LoggingLimitDebug parameter to set YAML
    Set-PSRuleOption -LoggingLimitDebug Rule1, Rule2;
 
    # YAML: Using the logging/limitDebug property
    logging:
      limitDebug:
      - Rule1
      - Rule2
 
    LOGGING.LIMITVERBOSE
    Limits verbose messages to a list of named verbose scopes.
    When using the `-Verbose` switch or preference variable, by default PSRule
    cmdlets log all verbose output. When using verbose output for
    troubleshooting a specific rule, it may be helpful to limit verbose messages
    to a specific rule.
    To identify a rule to include in verbose output use the rule name.
    The following built-in scopes exist in addition to rule names:
    - `[Discovery.Source]` - Discovery messages for `.Rule.ps1` files and rule modules.
    - `[Discovery.Rule]` - Discovery messages for individual rules within
    `.Rule.ps1` files.
    This option can be specified using:
 
    # PowerShell: Using the LoggingLimitVerbose parameter
    $option = New-PSRuleOption -LoggingLimitVerbose Rule1, Rule2;
 
    # PowerShell: Using the Logging.LimitVerbose hashtable key
    $option = New-PSRuleOption -Option @{ 'Logging.LimitVerbose' = Rule1, Rule2 };
 
    # PowerShell: Using the LoggingLimitVerbose parameter to set YAML
    Set-PSRuleOption -LoggingLimitVerbose Rule1, Rule2;
 
    # YAML: Using the logging/limitVerbose property
    logging:
      limitVerbose:
      - Rule1
      - Rule2
 
    LOGGING.RULEFAIL
    When an object fails a rule condition the results are written to output as a
    structured object marked with the outcome of
    Fail
    . If the rule executed successfully regardless of outcome no other
    informational messages are shown by default.
    In some circumstances such as a continuous integration (CI) pipeline, it may
    be preferable to see informational messages or abort the CI process if one
    or more
    Fail
    outcomes are returned.
    By settings this option, error, warning or information messages will be
    generated for each rule
    fail
    outcome in addition to structured output. By default, outcomes are not
    logged to an informational stream (i.e. None).
    The following streams available:
    - None
    - Error
    - Warning
    - Information
    This option can be specified using:
 
    # PowerShell: Using the LoggingRuleFail parameter
    $option = New-PSRuleOption -LoggingRuleFail Error;
 
    # PowerShell: Using the Logging.RuleFail hashtable key
    $option = New-PSRuleOption -Option @{ 'Logging.RuleFail' = 'Error' };
 
    # PowerShell: Using the LoggingRuleFail parameter to set YAML
    Set-PSRuleOption -LoggingRuleFail Error;
 
    # YAML: Using the logging/ruleFail property
    logging:
      ruleFail: Error
 
    LOGGING.RULEPASS
    When an object passes a rule condition the results are written to output as
    a structured object marked with the outcome of
    Pass
    . If the rule executed successfully regardless of outcome no other
    informational messages are shown by default.
    In some circumstances such as a continuous integration (CI) pipeline, it may
    be preferable to see informational messages.
    By settings this option, error, warning or information messages will be
    generated for each rule
    pass
    outcome in addition to structured output. By default, outcomes are not
    logged to an informational stream (i.e. None).
    The following streams available:
    - None
    - Error
    - Warning
    - Information
    This option can be specified using:
 
    # PowerShell: Using the LoggingRulePass parameter
    $option = New-PSRuleOption -LoggingRulePass Information;
 
    # PowerShell: Using the Logging.RulePass hashtable key
    $option = New-PSRuleOption -Option @{ 'Logging.RulePass' = 'Information' };
 
    # PowerShell: Using the LoggingRulePass parameter to set YAML
    Set-PSRuleOption -LoggingRulePass Information;
 
    # YAML: Using the logging/rulePass property
    logging:
      rulePass: Information
 
    OUTPUT.AS
    Configures the type of results to produce.
    This option only applies to `Invoke-PSRule`. `Invoke-PSRule` also includes a
    parameter `-As` to set this option at runtime. If specified, the `-As`
    parameter take precedence, over this option.
    The following options are available:
    - Detail - Return a record per rule per object.
    - Summary - Return summary information for per rule.
    This option can be specified using:
 
    # PowerShell: Using the OutputAs parameter
    $option = New-PSRuleOption -OutputAs Yaml;
 
    # PowerShell: Using the Output.As hashtable key
    $option = New-PSRuleOption -Option @{ 'Output.As' = 'Summary' };
 
    # PowerShell: Using the OutputAs parameter to set YAML
    Set-PSRuleOption -OutputAs Yaml;
 
    # YAML: Using the output/as property
    output:
      as: Summary
 
    OUTPUT.ENCODING
    Configures the encoding used when output is written to file. This option has
    no affect when `Output.Path` is not set.
    The following encoding options are available:
    - Default
    - UTF-8
    - UTF-7
    - Unicode
    - UTF-32
    - ASCII
    This option can be specified using:
 
    # PowerShell: Using the OutputEncoding parameter
    $option = New-PSRuleOption -OutputEncoding UTF8;
 
    # PowerShell: Using the Output.Format hashtable key
    $option = New-PSRuleOption -Option @{ 'Output.Encoding' = 'UTF8' };
 
    # PowerShell: Using the OutputEncoding parameter to set YAML
    Set-PSRuleOption -OutputEncoding UTF8;
 
    # YAML: Using the output/encoding property
    output:
      encoding: UTF8
 
    OUTPUT.FORMAT
    Configures the format that results will be presented in. This option applies
    to `Invoke-PSRule`, `Assert-PSRule` and `Get-PSRule`. This options is
    ignored by other cmdlets.
    The following format options are available:
    - None - Output is presented as an object using PowerShell defaults. This is
    the default.
    - Yaml - Output is serialized as YAML.
    - Json - Output is serialized as JSON.
    - NUnit3 - Output is serialized as NUnit3 (XML).
    - Csv - Output is serialized as a comma separated values (CSV). - The
    following columns are included: - RuleName - TargetName -
    TargetType - Outcome - OutcomeReason - Synopsis -
    Recommendation - Wide - Output is presented using the wide table format,
    which includes reason and wraps columns.
    The Wide format is ignored by `Assert-PSRule`. `Get-PSRule` only accepts
    `Wide` or `None`. Usage of other formats are treated as `None`.
    This option can be specified using:
 
    # PowerShell: Using the OutputFormat parameter
    $option = New-PSRuleOption -OutputFormat Yaml;
 
    # PowerShell: Using the Output.Format hashtable key
    $option = New-PSRuleOption -Option @{ 'Output.Format' = 'Yaml' };
 
    # PowerShell: Using the OutputFormat parameter to set YAML
    Set-PSRuleOption -OutputFormat Yaml;
 
    # YAML: Using the output/format property
    output:
      format: Yaml
 
    OUTPUT.PATH
    Specifies the output file path to write results. Directories along the file
    path will automatically be created if they do not exist.
    This option only applies to `Invoke-PSRule`. `Invoke-PSRule` also includes a
    parameter `-OutputPath` to set this option at runtime. If specified, the
    `-OutputPath` parameter take precedence, over this option.
    This option can be specified using:
 
    # PowerShell: Using the OutputPath parameter
    $option = New-PSRuleOption -OutputPath 'out/results.yaml';
 
    # PowerShell: Using the Output.Path hashtable key
    $option = New-PSRuleOption -Option @{ 'Output.Path' = 'out/results.yaml' };
 
    # PowerShell: Using the OutputPath parameter to set YAML
    Set-PSRuleOption -OutputPath 'out/results.yaml';
 
    # YAML: Using the output/path property
    output:
      path: 'out/results.yaml'
 
    OUTPUT.STYLE
    Configures the style that results will be presented in.
    This option only applies to output generated from `Assert-PSRule`.
    `Assert-PSRule` also include a parameter `-Style` to set this option at
    runtime. If specified, the `-Style` parameter takes precedence, over this option.
    The following styles are available:
    - Client - Output is written to the host directly in green/ red to indicate
    outcome. This is the default.
    - Plain - Output is written as an unformatted string. This option can be
    redirected to a file.
    - AzurePipelines - Output is written with commands that can be interpreted
    by Azure Pipelines.
    - GitHubActions - Output is written with commands that can be interpreted by
    GitHub Actions.
    This option can be specified using:
 
    # PowerShell: Using the OutputStyle parameter
    $option = New-PSRuleOption -OutputStyle AzurePipelines;
 
    # PowerShell: Using the Output.Style hashtable key
    $option = New-PSRuleOption -Option @{ 'Output.Style' = 'AzurePipelines' };
 
    # PowerShell: Using the OutputStyle parameter to set YAML
    Set-PSRuleOption -OutputFormat AzurePipelines;
 
    # YAML: Using the output/style property
    output:
      style: AzurePipelines
 
    RULE.INCLUDE
    The name of specific rules to evaluate. If this option is not specified all
    rules in search paths will be evaluated.
    This option can be overridden at runtime by using the `-Name` cmdlet parameter.
    This option can be specified using:
 
    # PowerShell: Using the Rule.Include hashtable key
    $option = New-PSRuleOption -Option @{ 'Rule.Include' = 'Rule1','Rule2' };
 
    # YAML: Using the rule/include property
    rule:
      include:
      - rule1
      - rule2
 
    RULE.EXCLUDE
    The name of specific rules to exclude from being evaluated. This will
    exclude rules specified by `Rule.Include` or discovered from a search path.
    This option can be specified using:
 
    # PowerShell: Using the Rule.Exclude hashtable key
    $option = New-PSRuleOption -Option @{ 'Rule.Exclude' = 'Rule3','Rule4' };
 
    # YAML: Using the rule/exclude property
    rule:
      exclude:
      - rule3
      - rule4
 
    RULE.TAG
    A set of required key value pairs (tags) that rules must have applied to
    them to be included.
    Multiple values can be specified for the same tag. When multiple values are
    used, only one must match.
    This option can be overridden at runtime by using the `-Tag` cmdlet parameter.
    This option can be specified using:
 
    # PowerShell: Using the Rule.Tag hashtable key
    $option = New-PSRuleOption -Option @{ 'Rule.Tag' = @{ severity = 'Critical','Warning' } };
 
    # YAML: Using the rule/tag property
    rule:
      tag:
        severity: Critical
 
    # YAML: Using the rule/tag property, with multiple values
    rule:
      tag:
        severity:
        - Critical
        - Warning
 
    In the example above, rules must have a tag of `severity` set to either
    `Critical` or `Warning` to be included.
 
    SUPPRESSION
    In certain circumstances it may be necessary to exclude or suppress rules
    from processing objects that are in a known failed state.
    PSRule allows objects to be suppressed for a rule by TargetName. Objects
    that are suppressed are not processed by the rule at all but will continue
    to be processed by other rules.
    Rule suppression complements pre-filtering and pre-conditions.
    This option can be specified using:
 
    # PowerShell: Using the SuppressTargetName option with a hashtable
    $option = New-PSRuleOption -SuppressTargetName @{ 'storageAccounts.UseHttps' = 'TestObject1', 'TestObject3' };
 
    # YAML: Using the suppression property
    suppression:
      storageAccounts.UseHttps:
        targetName:
        - TestObject1
        - TestObject3
 
    In both of the above examples, `TestObject1` and `TestObject3` have been
    suppressed from being processed by a rule named `storageAccounts.UseHttps`.
    When
    to
    use rule suppression:
    - A temporary exclusion for an object that is in a known failed state.
    When
    not
    to use rule suppression:
    - An object should never be processed by any rule. Pre-filter the pipeline instead.
    - The rule is not applicable because the object is the wrong type. Use
    pre-conditions on the rule instead.
    An example of pre-filtering:
 
    # Define objects to validate
    $items = @();
    $items += [PSCustomObject]@{ Name = 'Fridge'; Type = 'Equipment'; Category = 'White goods'; };
    $items += [PSCustomObject]@{ Name = 'Apple'; Type = 'Food'; Category = 'Produce'; };
    $items += [PSCustomObject]@{ Name = 'Carrot'; Type = 'Food'; Category = 'Produce'; };
     
    # Example of pre-filtering, only food items are sent to Invoke-PSRule
    $items | Where-Object { $_.Type -eq 'Food' } | Invoke-PSRule;
 
    An example of pre-conditions:
 
    # A rule with a pre-condition to only process produce
    Rule 'isFruit' -If { $TargetObject.Category -eq 'Produce' } {
        # Condition to determine if the object is fruit
        $TargetObject.Name -in 'Apple', 'Orange', 'Pear'
    }
 
EXAMPLES
    EXAMPLE PSRULE.YML
    #
    # PSRule example configuration
    #
     
    # Configure execution options
    execution:
      languageMode: ConstrainedLanguage
      inconclusiveWarning: false
      notProcessedWarning: false
     
    # Configures input options
    input:
      format: Yaml
      objectPath: items
      targetType:
      - Microsoft.Compute/virtualMachines
      - Microsoft.Network/virtualNetworks
     
    # Configures outcome logging options
    logging:
      limitDebug:
      - Rule1
      - Rule2
      limitVerbose:
      - Rule1
      - Rule2
      ruleFail: Error
      rulePass: Information
     
    output:
      as: Summary
      culture:
      - en-US
      encoding: UTF8
      format: Json
      style: GitHubActions
     
    # Configure rule suppression
    suppression:
      storageAccounts.UseHttps:
        targetName:
        - TestObject1
        - TestObject3
     
    # Configure baseline options
    binding:
      ignoreCase: false
      field:
        id:
        - ResourceId
        - AlternativeId
      targetName:
      - ResourceName
      - AlternateName
      targetType:
      - ResourceType
      - kind
     
    configuration:
      appServiceMinInstanceCount: 2
     
    rule:
      include:
      - rule1
      - rule2
      exclude:
      - rule3
      - rule4
      tag:
        severity:
        - Critical
        - Warning
 
    DEFAULT PSRULE.YML
    #
    # PSRule defaults
    #
     
    # Note: Only properties that differ from the default values need to be specified.
     
    # Configure execution options
    execution:
      languageMode: FullLanguage
      inconclusiveWarning: true
      notProcessedWarning: true
     
    # Configures input options
    input:
      format: Detect
      objectPath: null
      targetType: [ ]
     
    # Configures outcome logging options
    logging:
      limitDebug: [ ]
      limitVerbose: [ ]
      ruleFail: None
      rulePass: None
     
    output:
      as: Detail
      encoding: Default
      format: None
      style: Client
     
    # Configure rule suppression
    suppression: { }
     
    # Configure baseline options
    binding:
      ignoreCase: true
      field: { }
      targetName:
      - TargetName
      - Name
      targetType:
      - PSObject.TypeNames[0]
     
    configuration: { }
     
    rule:
      include: [ ]
      exclude: [ ]
      tag: { }
 
NOTE
    An online version of this document is available at
    https://github.com/Microsoft/PSRule/blob/master/docs/concepts/PSRule/en-US/about_PSRule_Options.md.
 
SEE ALSO
    -
    Invoke-PSRule
    -
    New-PSRuleOption
    -
    Set-PSRuleOption
 
KEYWORDS
    - Options
- PSRule