Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/microsoft/PSRule

Validate infrastructure as code (IaC) and objects using PowerShell rules.
https://github.com/microsoft/PSRule
allof anyof concept devops devops-tools hacktoberfest infrastructure-as-code powershell powershell-module psrule rule rule-engine testing-tools typeof
Last synced: about 2 months ago
JSON representation
Validate infrastructure as code (IaC) and objects using PowerShell rules.
Host: GitHub
URL: https://github.com/microsoft/PSRule
Owner: microsoft
License: mit
Created: 2018-03-19T09:24:17.000Z (over 6 years ago)
Default Branch: main
Last Pushed: 2024-04-03T17:06:05.000Z (6 months ago)
Last Synced: 2024-04-08T00:52:11.069Z (6 months ago)
Topics: allof, anyof, concept, devops, devops-tools, hacktoberfest, infrastructure-as-code, powershell, powershell-module, psrule, rule, rule-engine, testing-tools, typeof
Language: C#
Homepage: https://microsoft.github.io/PSRule/v2/
Size: 67.2 MB
Stars: 345
Watchers: 16
Forks: 44
Open Issues: 39
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
- Support: SUPPORT.md
Awesome Lists containing this project

jimsghstars - microsoft/PSRule - Validate infrastructure as code (IaC) and objects using PowerShell rules. (C# #)
AWESOME-Azure-Bicep - PSRule - A cross-platform module to validate infrastructure as code (IaC) and objects using PowerShell rules.
README

        # PSRule

A cross-platform module to validate infrastructure as code (IaC) and objects using PowerShell rules.

PSRule works great and integrates with popular continuous integration (CI) systems.

[![Open in vscode.dev](https://img.shields.io/badge/Open%20in-vscode.dev-blue)][1]

### Summary

- [Introduction](#summary)

- [Project Objectives](#project-objectives)

- [Support](#support)

- [Getting the module](#getting-the-module)

- [Getting extensions](#getting-extensions)

- [Getting started](#getting-started)

  - [Scenarios](#scenarios)

- [Language reference](#language-reference)

  - [Keywords](#keywords)

  - [Commands](#commands)

  - [Concepts](#concepts)

  - [Schemas](#schemas)

- [Related projects](#related-projects)

- [Changes and versioning](#changes-and-versioning)

- [Contributing](#contributing)

- [Code of conduct](#code-of-conduct)

- [Maintainers](#maintainers)

- [License](#license)

### Features of PSRule include

- [DevOps][2] - Built to support DevOps culture and tools.

- [Extensible][3] - Define tests using YAML, JSON, or PowerShell format.

- [Reusable][4] - Reuse and share rules across teams or organizations.

  [1]: https://vscode.dev/github/microsoft/PSRule

  [2]: https://microsoft.github.io/PSRule/latest/features/#devops

  [3]: https://microsoft.github.io/PSRule/latest/features/#extensible

  [4]: https://microsoft.github.io/PSRule/latest/features/#reusable

## Project objectives

1. **Extensible**:

   - Provide an execution environment (tools and language) to validate infrastructure code.

   - Handling of common concerns such as input/ output/ reporting should be handled by the engine.

   - Language must be flexible enough to support a wide range of use cases.

2. **DevOps**:

   - Validation should support and enhance DevOps workflows by providing fast feedback in pull requests.

   - Allow quality gates to be implemented between environments such development, test, and production.

3. **Cross-platform**:

   - A wide range of platforms can be used to author and deploy infrastructure code.

PSRule must support rule validation and authoring on Linux, MacOS, and Windows.

   - Runs in a Linux container.

For continuous integration (CI) systems that do not support PowerShell, run in a container.

4. **Reusable**:

   - Validation should plug and play, reusable across teams and organizations.

   - Any reusable validation will have exceptions.

Rules must be able to be disabled where they are not applicable.

Continue reading the [PSRule design specification][5].

  [5]: docs/specs/design-spec.md

  

> Back to the [summary](#summary)

## Support

This project uses GitHub Issues to track bugs and feature requests.

Please search the existing issues before filing new issues to avoid duplicates.

- For new issues, file your bug or feature request as a new [issue][6].

- For help, discussion, and support questions about using this project, join or start a [discussion][7].

Support for this project/ product is limited to the resources listed above.

  [6]: https://github.com/Microsoft/PSRule/issues

  [7]: https://github.com/microsoft/PSRule/discussions

> Back to the [summary](#summary)

## Getting the module

You can download and install the PSRule module from the PowerShell Gallery.

Module | Description | Downloads / instructions

------ | ----------- | ------------------------

PSRule | Validate infrastructure as code (IaC) and objects using PowerShell rules. | [latest][8] / [instructions][9]

For rule and integration modules see [related projects][10].

  [8]: https://www.powershellgallery.com/packages/PSRule

  [9]: https://microsoft.github.io/PSRule/v2/install-instructions/

  [10]: https://microsoft.github.io/PSRule/v2/related-projects/

> Back to the [summary](#summary)

## Getting extensions

Companion extensions are available for the following platforms.

Platform           | Description | Downloads / instructions

--------           | ----------- | ------------------------

Azure Pipelines    | Validate infrastructure as code (IaC) and DevOps repositories using Azure Pipelines. | [latest][11] / [instructions][9]

GitHub Actions     | Validate infrastructure as code (IaC) and DevOps repositories using GitHub Actions. | [latest][12] / [instructions][9]

Visual Studio Code | Visual Studio Code extension for PSRule. | [latest][13] / [instructions][9]

  [11]: https://marketplace.visualstudio.com/items?itemName=bewhite.ps-rule

  [12]: https://github.com/marketplace/actions/psrule

  [13]: https://marketplace.visualstudio.com/items?itemName=bewhite.psrule-vscode

  

> Back to the [summary](#summary)

## Getting started

For an quickstart example of using PSRule see [Create a standalone rule](https://microsoft.github.io/PSRule/v2/quickstart/standalone-rule/).

For specific use cases see [scenarios](#scenarios).

For frequently asked questions, see the [FAQ](https://microsoft.github.io/PSRule/v2/faq/).

> Back to the [summary](#summary)

### Scenarios

For walk through examples of PSRule usage see:

- [Validate Azure resource configuration](https://microsoft.github.io/PSRule/v2/scenarios/azure-resources/azure-resources/)

- [Validate Azure resources tags](https://microsoft.github.io/PSRule/v2/scenarios/azure-tags/azure-tags/)

- [Validate Kubernetes resources](https://microsoft.github.io/PSRule/v2/scenarios/kubernetes-resources/kubernetes-resources/)

- [Using within continuous integration](https://microsoft.github.io/PSRule/v2/scenarios/validation-pipeline/validation-pipeline/)

- [Packaging rules in a module](https://microsoft.github.io/PSRule/v2/authoring/packaging-rules/)

- [Writing rule help](https://microsoft.github.io/PSRule/v2/authoring/writing-rule-help/)

> Back to the [summary](#summary)

## Language reference

PSRule extends PowerShell with domain specific language (DSL) keywords, cmdlets and automatic variables.

### Keywords

The following language keywords are used by the `PSRule` module:

- [Rule](https://microsoft.github.io/PSRule/v2/keywords/PSRule/en-US/about_PSRule_Keywords/#rule) - A rule definition.

- [Exists](https://microsoft.github.io/PSRule/v2/keywords/PSRule/en-US/about_PSRule_Keywords/#exists) - Assert that a field or property must exist.

- [Match](https://microsoft.github.io/PSRule/v2/keywords/PSRule/en-US/about_PSRule_Keywords/#match) - Assert that the field must match any of the regular expressions.

- [AnyOf](https://microsoft.github.io/PSRule/v2/keywords/PSRule/en-US/about_PSRule_Keywords/#anyof) - Assert that any of the child expressions must be true.

- [AllOf](https://microsoft.github.io/PSRule/v2/keywords/PSRule/en-US/about_PSRule_Keywords/#allof) - Assert that all of the child expressions must be true.

- [Within](https://microsoft.github.io/PSRule/v2/keywords/PSRule/en-US/about_PSRule_Keywords/#within) - Assert that the field must match any of the values.

- [TypeOf](https://microsoft.github.io/PSRule/v2/keywords/PSRule/en-US/about_PSRule_Keywords/#typeof) - Assert that the object must be of a specific type.

- [Reason](https://microsoft.github.io/PSRule/v2/keywords/PSRule/en-US/about_PSRule_Keywords/#reason) - Return a reason for why the rule failed.

- [Recommend](https://microsoft.github.io/PSRule/v2/keywords/PSRule/en-US/about_PSRule_Keywords/#recommend) - Return a recommendation to resolve the issue and pass the rule.

> Back to the [summary](#summary)

### Commands

The following commands exist in the `PSRule` module:

- [Assert-PSRule](https://microsoft.github.io/PSRule/v2/commands/PSRule/en-US/Assert-PSRule/) - Evaluate objects against matching rules and assert any failures.

- [Export-PSRuleBaseline](https://microsoft.github.io/PSRule/v2/commands/PSRule/en-US/Export-PSRuleBaseline/) - Exports a list of baselines to a file.

- [Get-PSRule](https://microsoft.github.io/PSRule/v2/commands/PSRule/en-US/Get-PSRule/) - Get a list of rule definitions.

- [Get-PSRuleBaseline](https://microsoft.github.io/PSRule/v2/commands/PSRule/en-US/Get-PSRuleBaseline/) - Get a list of baselines.

- [Get-PSRuleHelp](https://microsoft.github.io/PSRule/v2/commands/PSRule/en-US/Get-PSRuleHelp/) - Get documentation for a rule.

- [Get-PSRuleTarget](https://microsoft.github.io/PSRule/v2/commands/PSRule/en-US/Get-PSRuleTarget/) - Get a list of target objects.

- [Invoke-PSRule](https://microsoft.github.io/PSRule/v2/commands/PSRule/en-US/Invoke-PSRule/) - Evaluate objects against matching rules and output the results.

- [New-PSRuleOption](https://microsoft.github.io/PSRule/v2/commands/PSRule/en-US/New-PSRuleOption/) - Create options to configure PSRule execution.

- [Set-PSRuleOption](https://microsoft.github.io/PSRule/v2/commands/PSRule/en-US/Set-PSRuleOption/) - Sets options that configure PSRule execution.

- [Test-PSRuleTarget](https://microsoft.github.io/PSRule/v2/commands/PSRule/en-US/Test-PSRuleTarget/) - Pass or fail objects against matching rules.

> Back to the [summary](#summary)

### Concepts

The following conceptual topics exist in the `PSRule` module:

- [Assert](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Assert/)

  - [APIVersion](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Assert/#apiversion)

  - [Contains](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Assert/#contains)

  - [Count](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Assert/#count)

  - [EndsWith](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Assert/#endswith)

  - [FileHeader](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Assert/#fileheader)

  - [FilePath](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Assert/#filepath)

  - [Greater](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Assert/#greater)

  - [GreaterOrEqual](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Assert/#greaterorequal)

  - [HasDefaultValue](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Assert/#hasdefaultvalue)

  - [HasField](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Assert/#hasfield)

  - [HasFields](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Assert/#hasfields)

  - [HasFieldValue](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Assert/#hasfieldvalue)

  - [HasJsonSchema](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Assert/#hasjsonschema)

  - [In](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Assert/#in)

  - [IsArray](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Assert/#isarray)

  - [IsBoolean](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Assert/#isboolean)

  - [IsDateTime](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Assert/#isdatetime)

  - [IsInteger](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Assert/#isinteger)

  - [IsLower](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Assert/#islower)

  - [IsNumeric](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Assert/#isnumeric)

  - [IsString](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Assert/#isstring)

  - [IsUpper](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Assert/#isupper)

  - [JsonSchema](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Assert/#jsonschema)

  - [Less](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Assert/#less)

  - [LessOrEqual](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Assert/#lessorequal)

  - [Like](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Assert/#like)

  - [Match](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Assert/#match)

  - [NotContains](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Assert/#notcontains)

  - [NotCount](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Assert/#notcount)

  - [NotEndsWith](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Assert/#notendswith)

  - [NotHasField](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Assert/#nothasfield)

  - [NotIn](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Assert/#notin)

  - [NotLike](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Assert/#notlike)

  - [NotMatch](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Assert/#notmatch)

  - [NotNull](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Assert/#notnull)

  - [NotStartsWith](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Assert/#notstartswith)

  - [NotWithinPath](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Assert/#notwithinpath)

  - [Null](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Assert/#null)

  - [NullOrEmpty](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Assert/#nullorempty)

  - [TypeOf](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Assert/#typeof)

  - [SetOf](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Assert/#setof)

  - [StartsWith](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Assert/#startswith)

  - [Subset](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Assert/#subset)

  - [Version](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Assert/#version)

  - [WithinPath](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Assert/#withinpath)

- [Badges](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Badges/)

- [Baselines](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Baseline/)

  - [Baseline specs](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Baseline/#baseline-specs)

  - [Baseline scopes](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Baseline/#baseline-scopes)

- [Conventions](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Conventions/)

  - [Using conventions](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Conventions/#using-conventions)

  - [Defining conventions](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Conventions/#defining-conventions)

  - [Begin Process End blocks](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Conventions/#begin-process-end-blocks)

  - [Including with options](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Conventions/#including-with-options)

  - [Using within modules](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Conventions/#using-within-modules)

  - [Execution order](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Conventions/#execution-order)

- [Docs](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Docs/)

  - [Getting documentation](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Docs/#getting-documentation)

  - [Online help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Docs/#online-help)

  - [Creating documentation](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Docs/#creating-documentation)

- [Expressions](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/)

  - [AllOf](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#allof)

  - [AnyOf](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#anyof)

  - [APIVersion](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#apiversion)

  - [Contains](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#contains)

  - [Count](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#count)

  - [EndsWith](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#endswith)

  - [Exists](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#exists)

  - [Equals](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#equals)

  - [Field](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#field)

  - [Greater](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#greater)

  - [GreaterOrEquals](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#greaterorequals)

  - [HasDefault](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#hasdefault)

  - [HasSchema](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#hasschema)

  - [HasValue](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#hasvalue)

  - [In](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#in)

  - [IsLower](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#islower)

  - [IsString](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#isstring)

  - [IsArray](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#isarray)

  - [IsBoolean](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#isboolean)

  - [IsDateTime](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#isdatetime)

  - [IsInteger](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#isinteger)

  - [IsNumeric](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#isnumeric)

  - [IsUpper](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#isupper)

  - [Less](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#less)

  - [LessOrEquals](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#lessorequals)

  - [Like](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#like)

  - [Match](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#match)

  - [Name](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#name)

  - [Not](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#not)

  - [NotContains](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#notcontains)

  - [NotCount](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#notcount)

  - [NotEndsWith](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#notendswith)

  - [NotEquals](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#notequals)

  - [NotIn](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#notin)

  - [NotLike](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#notlike)

  - [NotMatch](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#notmatch)

  - [NotStartsWith](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#notstartswith)

  - [NotWithinPath](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#notwithinpath)

  - [Scope](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#scope)

  - [SetOf](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#setof)

  - [Source](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#source)

  - [StartsWith](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#startswith)

  - [Subset](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#subset)

  - [Type](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#type)

  - [WithinPath](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#withinpath)

  - [Version](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#version)

- [Options](https://aka.ms/ps-rule/options)

  - [Baseline.Group](https://aka.ms/ps-rule/options#baselinegroup)

  - [Binding.Field](https://aka.ms/ps-rule/options#bindingfield)

  - [Binding.IgnoreCase](https://aka.ms/ps-rule/options#bindingignorecase)

  - [Binding.NameSeparator](https://aka.ms/ps-rule/options#bindingnameseparator)

  - [Binding.PreferTargetInfo](https://aka.ms/ps-rule/options#bindingprefertargetinfo)

  - [Binding.TargetName](https://aka.ms/ps-rule/options#bindingtargetname)

  - [Binding.TargetType](https://aka.ms/ps-rule/options#bindingtargettype)

  - [Binding.UseQualifiedName](https://aka.ms/ps-rule/options#bindingusequalifiedname)

  - [Configuration](https://aka.ms/ps-rule/options#configuration)

  - [Convention.Include](https://aka.ms/ps-rule/options#conventioninclude)

  - [Execution.AliasReference](https://aka.ms/ps-rule/options#executionaliasreference)

  - [Execution.Break](https://aka.ms/ps-rule/options#executionbreak)

  - [Execution.DuplicateResourceId](https://aka.ms/ps-rule/options#executionduplicateresourceid)

  - [Execution.HashAlgorithm](https://aka.ms/ps-rule/options#executionhashalgorithm)

  - [Execution.LanguageMode](https://aka.ms/ps-rule/options#executionlanguagemode)

  - [Execution.InvariantCulture](https://aka.ms/ps-rule/options#executioninvariantculture)

  - [Execution.InitialSessionState](https://aka.ms/ps-rule/options#executioninitialsessionstate)

  - [Execution.RestrictScriptSource](https://aka.ms/ps-rule/options#executionrestrictscriptsource)

  - [Execution.RuleInconclusive](https://aka.ms/ps-rule/options#executionruleinconclusive)

  - [Execution.SuppressionGroupExpired](https://aka.ms/ps-rule/options#executionsuppressiongroupexpired)

  - [Execution.UnprocessedObject](https://aka.ms/ps-rule/options#executionunprocessedobject)

  - [Include.Module](https://aka.ms/ps-rule/options#includemodule)

  - [Include.Path](https://aka.ms/ps-rule/options#includepath)

  - [Input.FileObjects](https://aka.ms/ps-rule/options#inputfileobjects)

  - [Input.Format](https://aka.ms/ps-rule/options#inputformat)

  - [Input.IgnoreGitPath](https://aka.ms/ps-rule/options#inputignoregitpath)

  - [Input.IgnoreObjectSource](https://aka.ms/ps-rule/options#inputignoreobjectsource)

  - [Input.IgnoreRepositoryCommon](https://aka.ms/ps-rule/options#inputignorerepositorycommon)

  - [Input.IgnoreUnchangedPath](https://aka.ms/ps-rule/options#inputignoreunchangedpath)

  - [Input.ObjectPath](https://aka.ms/ps-rule/options#inputobjectpath)

  - [Input.PathIgnore](https://aka.ms/ps-rule/options#inputpathignore)

  - [Input.TargetType](https://aka.ms/ps-rule/options#inputtargettype)

  - [Logging.LimitDebug](https://aka.ms/ps-rule/options#logginglimitdebug)

  - [Logging.LimitVerbose](https://aka.ms/ps-rule/options#logginglimitverbose)

  - [Logging.RuleFail](https://aka.ms/ps-rule/options#loggingrulefail)

  - [Logging.RulePass](https://aka.ms/ps-rule/options#loggingrulepass)

  - [Output.As](https://aka.ms/ps-rule/options#outputas)

  - [Output.Banner](https://aka.ms/ps-rule/options#outputbanner)

  - [Output.Culture](https://aka.ms/ps-rule/options#outputculture)

  - [Output.Encoding](https://aka.ms/ps-rule/options#outputencoding)

  - [Output.Footer](https://aka.ms/ps-rule/options#outputfooter)

  - [Output.Format](https://aka.ms/ps-rule/options#outputformat)

  - [Output.JobSummaryPath](https://aka.ms/ps-rule/options#outputjobsummarypath)

  - [Output.JsonIndent](https://aka.ms/ps-rule/options#outputjsonindent)

  - [Output.Outcome](https://aka.ms/ps-rule/options#outputoutcome)

  - [Output.Path](https://aka.ms/ps-rule/options#outputpath)

  - [Output.SarifProblemsOnly](https://aka.ms/ps-rule/options#outputsarifproblemsonly)

  - [Output.Style](https://aka.ms/ps-rule/options#outputstyle)

  - [Repository.BaseRef](https://aka.ms/ps-rule/options#repositorybaseref)

  - [Repository.Url](https://aka.ms/ps-rule/options#repositoryurl)

  - [Requires](https://aka.ms/ps-rule/options#requires)

  - [Rule.Baseline](https://aka.ms/ps-rule/options#rulebaseline)

  - [Rule.Include](https://aka.ms/ps-rule/options#ruleinclude)

  - [Rule.IncludeLocal](https://aka.ms/ps-rule/options#ruleincludelocal)

  - [Rule.Exclude](https://aka.ms/ps-rule/options#ruleexclude)

  - [Rule.Tag](https://aka.ms/ps-rule/options#ruletag)

  - [Suppression](https://aka.ms/ps-rule/options#suppression)

- [Rules](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Rules/)

- [Selectors](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Selectors/)

- [Suppression Groups](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_SuppressionGroups/)

- [Variables](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Variables/)

  - [$Assert](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Variables/#assert)

  - [$Configuration](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Variables/#configuration)

  - [$LocalizedData](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Variables/#localizeddata)

  - [$PSRule](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Variables/#psrule)

  - [$Rule](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Variables/#rule)

  - [$TargetObject](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Variables/#targetobject)

> Back to the [summary](#summary)

### Schemas

PSRule uses the following schemas:

- [Options](schemas/PSRule-options.schema.json) - Schema for PSRule YAML options file.

- [Language](schemas/PSRule-language.schema.json) - Schema for PSRule resources such as baselines.

- [Resources](schemas/PSRule-resources.schema.json) - Schema for PSRule resources documents used with JSON.

> Back to the [summary](#summary)

## Related projects

For a list of projects and integrations see [Related projects][10].

## Changes and versioning

This repository uses [semantic versioning](http://semver.org/) to declare breaking changes.

For details please see the [changes and versioning](https://microsoft.github.io/PSRule/v2/versioning/).

## Contributing

This project welcomes contributions and suggestions.

If you are ready to contribute, please visit the [contribution guide](CONTRIBUTING.md).

## Code of Conduct

This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).

For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)

or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.

## Maintainers

- [Bernie White](https://github.com/BernieWhite)

## License

This project is [licensed under the MIT License](LICENSE).

## Trademarks

This project may contain trademarks or logos for projects, products, or services.

Authorized use of Microsoft trademarks or logos is subject to and must follow [Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/legal/intellectualproperty/trademarks).

Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.

Any use of third-party trademarks or logos are subject to those third-party's policies.

> Back to the [summary](#summary)