Test-DbaDbDataMaskingConfig

Synopsis

Validates data masking configuration JSON files for structural and logical errors

Description

Validates data masking configuration JSON files by checking column properties, data types, masking types, and action configurations against dbatools requirements.
Returns detailed error information for any tables and columns that fail validation, helping you identify configuration issues before running data masking operations.
Checks include required/allowed column properties, supported SQL Server data types, valid masking and subtype combinations, date range validations, and action property requirements.
Essential for troubleshooting complex masking configurations and ensuring they’ll execute successfully without runtime errors.

Syntax

Test-DbaDbDataMaskingConfig
    [-FilePath] <String>
    [-EnableException]
    [<CommonParameters>]

Examples

Example: 1

PS C:\> Test-DbaDbDataMaskingConfig -FilePath C:\temp\_datamasking\db1.json

Test the configuration file

Required Parameters

-FilePath

Specifies the full path to the data masking configuration JSON file to validate.
Use this to verify your masking configuration before running New-DbaDbDataMaskingConfig or Invoke-DbaDbDataMasking to catch errors early.

Optional Parameters

-EnableException

By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.
This avoids overwhelming you with “sea of red” exceptions, but is inconvenient because it basically disables advanced scripting.
Using this switch turns this “nice by default” feature off and enables you to catch exceptions with your own try/catch.