Set-PSRuleOption#
SYNOPSIS#
Sets options that configure PSRule execution.
SYNTAX#
Set-PSRuleOption [[-Path] <String>] [-Option <PSRuleOption>] [-PassThru] [-Force] [-AllowClobber]
[-BaselineGroup <Hashtable>] [-BindingIgnoreCase <Boolean>] [-BindingField <Hashtable>]
[-BindingNameSeparator <String>] [-BindingPreferTargetInfo <Boolean>] [-TargetName <String[]>]
[-TargetType <String[]>] [-BindingUseQualifiedName <Boolean>] [-Convention <String[]>]
[-DuplicateResourceId <ExecutionActionPreference>] [-InitialSessionState <SessionState>]
[-SuppressionGroupExpired <ExecutionActionPreference>] [-ExecutionRuleExcluded <ExecutionActionPreference>]
[-ExecutionRuleSuppressed <ExecutionActionPreference>] [-ExecutionAliasReference <ExecutionActionPreference>]
[-ExecutionRuleInconclusive <ExecutionActionPreference>]
[-ExecutionInvariantCulture <ExecutionActionPreference>]
[-ExecutionUnprocessedObject <ExecutionActionPreference>] [-IncludeModule <String[]>]
[-IncludePath <String[]>] [-Format <InputFormat>] [-InputIgnoreGitPath <Boolean>]
[-InputIgnoreObjectSource <Boolean>] [-InputIgnoreRepositoryCommon <Boolean>]
[-InputIgnoreUnchangedPath <Boolean>] [-ObjectPath <String>] [-InputPathIgnore <String[]>]
[-InputTargetType <String[]>] [-LoggingLimitDebug <String[]>] [-LoggingLimitVerbose <String[]>]
[-LoggingRuleFail <OutcomeLogStream>] [-LoggingRulePass <OutcomeLogStream>] [-OutputAs <ResultFormat>]
[-OutputBanner <BannerFormat>] [-OutputCulture <String[]>] [-OutputEncoding <OutputEncoding>]
[-OutputFooter <FooterFormat>] [-OutputFormat <OutputFormat>] [-OutputJobSummaryPath <String>]
[-OutputJsonIndent <Int32>] [-OutputOutcome <RuleOutcome>] [-OutputPath <String>]
[-OutputSarifProblemsOnly <Boolean>] [-OutputStyle <OutputStyle>] [-RepositoryBaseRef <String>]
[-RepositoryUrl <String>] [-RuleIncludeLocal <Boolean>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION#
Sets options that configure PSRule execution.
EXAMPLES#
Example 1#
PS C:\> Set-PSRuleOption -OutputFormat Yaml;
Sets the Output.Format to Yaml for ps-rule.yaml in the current working path.
If the ps-rule.yaml file exists, it is merged with the existing file and overwritten.
If the file does not exist, a new file is created.
Example 2#
PS C:\> Set-PSRuleOption -OutputFormat Yaml -Path .\project-options.yaml;
Sets the Output.Format to Yaml for project-options.yaml in the current working path.
If the project-options.yaml file exists, it is merged with the existing file and overwritten.
If the file does not exist, a new file is created.
PARAMETERS#
-Path#
The path to a YAML file where options will be set.
Either a directory or file path can be specified.
When a directory is used, ps-rule.yaml will be used as the file name.
The file will be created if it does not exist. If the file already exists it will be merged with the existing options and overwritten.
If the directory does not exist an error will be generated.
To force the creation of the directory path use the -Force switch.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Option#
An options object to use.
Type: PSRuleOption
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-PassThru#
Use this option to return the options object to the pipeline instead of saving to disk.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Force#
Force creation of directory path for Path parameter, when the directory does not already exist.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-AllowClobber#
Overwrite YAML files that contain comments.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-BaselineGroup#
Sets the option Baseline.Group.
The option Baseline.Group allows a named group of baselines to be defined and later referenced.
See about_PSRule_Options for more information.
Type: Hashtable
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-BindingIgnoreCase#
Sets the option Binding.IgnoreCase.
The option Binding.IgnoreCase determines if binding operations are case-sensitive or not.
See about_PSRule_Options for more information.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: True
Accept pipeline input: False
Accept wildcard characters: False
-BindingField#
Sets the option Binding.Field.
The option specified one or more custom field bindings.
See about_PSRule_Options for more information.
Type: Hashtable
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-BindingNameSeparator#
Sets the option Binding.NameSeparator.
This option specifies the separator to use for qualified names.
See about_PSRule_Options for more information.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-BindingPreferTargetInfo#
Sets the option Binding.PreferTargetInfo.
This option specifies if automatic binding is preferred over configured binding options.
See about_PSRule_Options for more information.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Convention#
Sets the Option.ConventionInclude option.
This option specifies the name of conventions to execute in the pipeline when processing objects.
See about_PSRule_Options for more information.
Type: String[]
Parameter Sets: (All)
Aliases: ConventionInclude
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-TargetName#
Sets the option Binding.TargetName.
This option specifies one or more properties of TargetObject to use to bind TargetName to.
See about_PSRule_Options for more information.
Type: String[]
Parameter Sets: (All)
Aliases: BindingTargetName
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-TargetType#
Sets the option Binding.TargetType.
This option specifies one or more properties of TargetObject to use to bind TargetType to.
See about_PSRule_Options for more information.
Type: String[]
Parameter Sets: (All)
Aliases: BindingTargetType
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-BindingUseQualifiedName#
Sets the option Binding.UseQualifiedName.
This option specifies is qualified target names are used.
See about_PSRule_Options for more information.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ExecutionAliasReference#
Sets the Execution.AliasReference option.
Determines how to handle when an alias to a resource is used.
See about_PSRule_Options for more information.
Type: ExecutionActionPreference
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ExecutionInvariantCulture#
Sets the Execution.InvariantCulture option.
Determines how to report when an invariant culture is used.
See about_PSRule_Options for more information.
Type: ExecutionActionPreference
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ExecutionRuleInconclusive#
Sets the Execution.RuleInconclusive option.
Determines how to handle rules that generate inconclusive results.
See about_PSRule_Options for more information.
Type: ExecutionActionPreference
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ExecutionUnprocessedObject#
Sets the Execution.UnprocessedObject option.
Determines how to report objects that are not processed by any rule.
See about_PSRule_Options for more information.
Type: ExecutionActionPreference
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-IncludeModule#
Sets the Include.Module option to include additional module sources.
See about_PSRule_Options for more information.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-IncludePath#
Sets the Include.Path option to include additional standalone sources.
See about_PSRule_Options for more information.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Format#
Sets the Input.Format option to configure the input format for when a string is passed in as a target object.
See about_PSRule_Options for more information.
Type: InputFormat
Parameter Sets: (All)
Aliases: InputFormat
Accepted values: None, Yaml, Json, Markdown, PowerShellData, File, Detect
Required: False
Position: Named
Default value: Detect
Accept pipeline input: False
Accept wildcard characters: False
-InputIgnoreGitPath#
Sets the Input.IgnoreGitPath option to determine if files within the .git path are ignored.
See about_PSRule_Options for more information.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: True
Accept pipeline input: False
Accept wildcard characters: False
-InputIgnoreRepositoryCommon#
Sets the Input.IgnoreRepositoryCommon option to determine if files common repository files are ignored.
See about_PSRule_Options for more information.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-InputIgnoreUnchangedPath#
Sets the option Input.IgnoreUnchangedPath.
The Input.IgnoreUnchangedPath option determine if unchanged files are ignored.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ObjectPath#
Sets the Input.ObjectPath option to use an object path to use instead of the pipeline object.
See about_PSRule_Options for more information.
Type: String
Parameter Sets: (All)
Aliases: InputObjectPath
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-InputPathIgnore#
Sets the Input.PathIgnore option.
If specified, files that match the path spec will not be processed.
See about_PSRule_Options for more information.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-InputTargetType#
Sets the Input.TargetType option to only process objects with the specified TargetType.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-InputIgnoreObjectSource#
Sets the option Input.IgnoreObjectSource.
The Input.IgnoreObjectSource option determines if objects will be skipped if the source path has been ignored.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-LoggingLimitDebug#
Sets the Logging.LimitDebug option to limit debug messages to a list of named debug scopes.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-LoggingLimitVerbose#
Sets the Logging.LimitVerbose option to limit verbose messages to a list of named verbose scopes.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-LoggingRuleFail#
Sets the Logging.RuleFail option to generate an informational message for each rule fail.
Type: OutcomeLogStream
Parameter Sets: (All)
Aliases:
Accepted values: None, Error, Warning, Information
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-LoggingRulePass#
Sets the Logging.RulePass option to generate an informational message for each rule pass.
Type: OutcomeLogStream
Parameter Sets: (All)
Aliases:
Accepted values: None, Error, Warning, Information
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-OutputAs#
Sets the option Output.As.
The Output.As option configures the type of results to produce, either detail or summary.
Type: ResultFormat
Parameter Sets: (All)
Aliases:
Accepted values: Detail, Summary
Required: False
Position: Named
Default value: Detail
Accept pipeline input: False
Accept wildcard characters: False
-OutputBanner#
Sets the option Output.Banner.
The Output.Banner option configure information displayed with PSRule banner.
This option is only applicable when using Assert-PSRule cmdlet.
Type: BannerFormat
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: Default
Accept pipeline input: False
Accept wildcard characters: False
-OutputCulture#
Sets the option Output.Culture.
The Output.Culture option configures the culture used to generated output.
When multiple cultures are specified, the first matching culture will be used.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-OutputEncoding#
Sets the option Output.Encoding.
The Output.Encoding option configured the encoding used to write results to file.
Type: OutputEncoding
Parameter Sets: (All)
Aliases:
Accepted values: Default, UTF8, UTF7, Unicode, UTF32, ASCII
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-OutputFooter#
Sets the option Output.Footer.
The Output.Footer option configures the information displayed for PSRule footer.
See about_PSRule_Options for more information.
Type: FooterFormat
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: Default
Accept pipeline input: False
Accept wildcard characters: False
-OutputFormat#
Sets the option Output.Format.
The Output.Format option configures the format that results will be presented in.
Type: OutputFormat
Parameter Sets: (All)
Aliases:
Accepted values: None, Yaml, Json, Markdown, NUnit3, Csv, Wide, Sarif
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-OutputJobSummaryPath#
Set the option Output.JobSummaryPath.
The Output.JobSummaryPath option configures the path to a job summary output file.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-OutputJsonIndent#
Sets the option Output.JsonIndent.
The Output.JsonIndent option configures indentation for JSON output.
This option only applies to Get-PSRule, Invoke-PSRule and Assert-PSRule cmdlets.
Type: Int32
Parameter Sets: (All)
Aliases: JsonIndent
Accepted values: 0, 1, 2, 3, 4
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-OutputOutcome#
Sets the Output.Outcome option.
This option can be set to include or exclude output results.
See about_PSRule_Options for more information.
Type: RuleOutcome
Parameter Sets: (All)
Aliases: Outcome
Required: False
Position: Named
Default value: Processed
Accept pipeline input: False
Accept wildcard characters: False
-OutputPath#
Sets the option Output.Path.
The Output.Path option configures an output file path to write results.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-OutputSarifProblemsOnly#
Sets the option Option.SarifProblemsOnly.
The Output.SarifProblemsOnly option determines if SARIF output only includes fail and error outcomes.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: True
Accept pipeline input: False
Accept wildcard characters: False
-OutputStyle#
Sets the option Option.Style.
The Output.Style option configures the style that results will be presented in.
This option only applies to Assert-PSRule.
Type: OutputStyle
Parameter Sets: (All)
Aliases:
Accepted values: Client, Plain, AzurePipelines, GitHubActions
Required: False
Position: Named
Default value: Client
Accept pipeline input: False
Accept wildcard characters: False
-WhatIf#
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Confirm#
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-RepositoryBaseRef#
Sets the option Repository.BaseRef.
The Repository.BaseRef option sets the repository base ref used for comparisons of changed files.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-RepositoryUrl#
Sets the option Repository.Url.
The Repository.Url option sets the repository URL reported in output.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-RuleIncludeLocal#
Sets the option Rule.IncludeLocal.
The Rule.IncludeLocal option configures if local rules are automatically included.
See about_PSRule_Options for more information.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-DuplicateResourceId#
Sets the option Execution.DuplicateResourceId.
The Execution.DuplicateResourceId option determines how to handle duplicate resources identifiers during execution.
Type: ExecutionActionPreference
Parameter Sets: (All)
Aliases: ExecutionDuplicateResourceId
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-InitialSessionState#
Sets the option Execution.InitialSessionState.
The Execution.InitialSessionState option determines how the initial session state for executing PowerShell code is created.
Type: SessionState
Parameter Sets: (All)
Aliases: ExecutionInitialSessionState
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ExecutionRuleExcluded#
Sets the option Execution.RuleExcluded.
The Execution.RuleExcluded option determines how to handle excluded rules.
Type: ExecutionActionPreference
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ExecutionRuleSuppressed#
Sets the option Execution.RuleSuppressed.
The Execution.RuleSuppressed option determines how to handle suppressed rules.
Type: ExecutionActionPreference
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-SuppressionGroupExpired#
Sets the option Execution.SuppressionGroupExpired.
The Execution.SuppressionGroupExpired option determines how to handle expired suppression groups.
Type: ExecutionActionPreference
Parameter Sets: (All)
Aliases: ExecutionSuppressionGroupExpired
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters#
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
INPUTS#
OUTPUTS#
PSRule.Configuration.PSRuleOption#
When you use the -PassThru switch, an options object is returned to the pipeline.