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

requires:
  PSRule: '@pre >=2.9.0'
  PSRule.Rules.Azure: '@pre >=1.27.3'

configuration:
  # Enable automatic expansion of JSON parameter files.
  AZURE_PARAMETER_FILE_EXPANSION: true

  # 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

  # Enable automatic expansion of Bicep parameter files.
  AZURE_BICEP_PARAMS_FILE_EXPANSION: true

    # Enable Bicep CLI checks.
  AZURE_BICEP_CHECK_TOOL: true

  # Configure the minimum version of the Bicep CLI.
  AZURE_BICEP_MINIMUM_VERSION: '0.18.4'

input:
  pathIgnore:
    # Ignore other files in the repository.
  - '.vscode/'
  - '.github/'
  - '*.md'

  # Exclude bicepconfig.json
  - 'bicepconfig.json'

  # ignore all bicep files except the ones that have been created to test modules
  - 'modules/**/*.bicep'
  - '!modules/**/*.tests.bicep'

rule:
  exclude:
    - Azure.Storage.UseReplication

include:
  module:
    - PSRule.Rules.Azure

execution:
  aliasReference: Warn
  duplicateResourceId: Error
  languageMode: FullLanguage
  initialSessionState: BuiltIn
  invariantCulture: Warn
  ruleExcluded: Ignore
  ruleInconclusive: Warn
  ruleSuppressed: Warn
  suppressionGroupExpired: Warn
  unprocessedObject: Ignore

output:
  as: Detail
  banner: Default
  culture: [en-GB]
  encoding: Default
  footer: Default