ps-rule.yaml

---
#
# PSRule for Azure configuration
#

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

# Use rules from the following modules/
include:
  module:
    - PSRule.Rules.Azure
    - PSRule.Rules.CAF

# Require a minimum version of modules that include referenced baseline.
requires:
  PSRule: '@pre >=2.3.2'
  PSRule.Rules.Azure: '@pre >=1.18.1'

execution:
  # Ignore warnings for resources and objects that don't have any rules.
  unprocessedObject: Ignore

configuration:
  # Enable expansion for Bicep source files.
  AZURE_BICEP_FILE_EXPANSION: true

  # Expand Bicep module from Azure parameter files.
  AZURE_PARAMETER_FILE_EXPANSION: true

  # Set timeout for expanding Bicep source files.
  AZURE_BICEP_FILE_EXPANSION_TIMEOUT: 45

  # Set defaults for bicep parameters
  AZURE_PARAMETER_DEFAULTS:
    roleDefinitionIdOrName: reader
    name: test
    assigneeObjectId: fce6bf71-0d10-4469-8d3a-f6468465b8fd
    principalIds: acdd72a7-3385-48ef-bd42-f606fba81ae7
    principalId: acdd72a7-3385-48ef-bd42-f606fba81ae7
    destinationVirtualNetworkName: test
    subscriptionDisplayName: test
    subscriptionAliasName: test
    resourceGroupName: test
    sourceVirtualNetworkName: test
    groupShortName: test

  AZURE_RESOURCE_ALLOWED_LOCATIONS:
    - australiaeast
    - australiasoutheast

  AZURE_RESOURCE_GROUP:
    location: australiaeast

input:
  pathIgnore:
    # Ignore common files that don't need analysis.
    - '**/bicepconfig.json'
    - '*.yaml'
    - '*.yml'
    - '*.md'
    - '*.ps1'
    - '*.png'
    - '.github/'
    - '**/main.bicep'
    - '**/main.test.bicep'
    - '**/dependencies.bicep'

binding:
  preferTargetInfo: true
  targetType:
    - resourceType
    - type

rule:
  exclude:
    # Ignore these recommendations for this repo.
    - Azure.Resource.UseTags
    - Azure.NSG.LateralTraversal

output:
  culture: ['en-AU', 'en-US']