ps-rule.yaml

#
# PSRule for Azure configuration
#

# Please see the documentation for all configuration options:
# https://aka.ms/ps-rule/options
# https://aka.ms/ps-rule-azure/options

# Configure binding for local rules.
binding:
  preferTargetInfo: true
  targetType:
    - type
    - resourceType

# Require minimum versions of modules.
requires:
  PSRule: '@pre >=2.4.0'
  PSRule.Rules.Azure: '@pre >=1.27.3'

# Use PSRule for Azure.
include:
  module:
    - PSRule.Rules.Azure

execution:
  # suppressedRuleWarning: false - no more supported in PsRule ver 3.0
  # notProcessedWarning: false - no more supported in PsRule ver 3.0
  ruleSuppressed: Warn
  unprocessedObject: Warn

output:
  culture:
    - 'en-US'

input:
  pathIgnore:
    # Ignore other files in the repository.
    - '**/*'
    # Do not ignore tests.
    - '!modules/**/*.test.bicep'

configuration:
  # Enable automatic expansion of Azure parameter files.
  AZURE_PARAMETER_FILE_EXPANSION: false

  # Enable automatic expansion of Azure Bicep source files.
  AZURE_BICEP_FILE_EXPANSION: true

  # Configures the number of seconds to wait for build Bicep files.
  AZURE_BICEP_FILE_EXPANSION_TIMEOUT: 10

rule:
  # Enable custom rules that don't exist in the baseline
  includeLocal: false
  exclude:
  # Ignore the following rules for all resources
   - Azure.KeyVault.PurgeProtect
   - Azure.Resource.AllowedRegions