< Back
New-DbaDbMaskingConfig
Post
NAME New-DbaDbMaskingConfig
SYNOPSIS
Generates a new data masking configuration file to be used with Invoke-DbaDbDataMasking
SYNTAX
New-DbaDbMaskingConfig [[-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
[[-SqlCredential] <Pscredential>] [[-Database] <System.String[]>] [[-Table] <System.String[]>] [[-Column]
<System.String[]>] [-Path] <String> [[-Locale] <String>] [[-CharacterString] <String>] [[-SampleCount] <Int>]
[[-KnownNameFilePath] <String>] [[-PatternFilePath] <String>] [-ExcludeDefaultKnownName <Switch>]
[-ExcludeDefaultPattern <Switch>] [-Force <Switch>] [[-InputObject] <System.Object[]>] [-EnableException <Switch>]
[<CommonParameters>]
DESCRIPTION
Generates a new data masking configuration file. This file is important to apply any data masking to the data in a
database.
Note that the following column and data types are not currently supported:
Identity
ForeignKey
Computed
Hierarchyid
Geography
Geometry
Xml
Read more here:
https://sachabarbs.wordpress.com/2018/0 ... data-tool/
https://github.com/bchavez/Bogus
PARAMETERS
-CharacterString [<String>]
The characters to use in string data. 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789' by
default
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Column [<System.String[]>]
Columns to process. By default all the columns will be processed
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Database [<System.String[]>]
Databases to process through
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-EnableException [<Switch>]
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-ExcludeDefaultKnownName [<Switch>]
Excludes the default known names
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-ExcludeDefaultPattern [<Switch>]
Excludes the default patterns
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Force [<Switch>]
Forcefully execute commands when needed
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-InputObject [<System.Object[]>]
Used for piping the values from Invoke-DbaDbPiiScan
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-KnownNameFilePath [<String>]
Points to a file containing the custom known names
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Locale [<String>]
Set the local to enable certain settings in the masking
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Path [<String>]
Path where to save the generated JSON files.
Th naming convention will be "servername.databasename.tables.json"
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-PatternFilePath [<String>]
Points to a file containing the custom patterns
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SampleCount [<Int>]
Amount of rows to sample to make an assessment. The default is 100
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlCredential [<Pscredential>]
Login to the target instance using alternative credentials. Accepts PowerShell credentials (Get-Credential).
Windows Authentication, SQL Server Authentication, Active Directory - Password, and Active Directory -
Integrated are all supported.
For MFA support, please use Connect-DbaInstance.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlInstance [<Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
The target SQL Server instance or instances.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Table [<System.String[]>]
Tables to process. By default all the tables will be processed
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
Tags: Masking, DataMasking
Author: Sander Stad (@sqlstad, sqlstad.nl) | Chrissy LeMaire (@cl, netnerds.net)
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>New-DbaDbMaskingConfig -SqlInstance SQLDB1 -Database DB1 -Path C:\\Temp\\clone
Process all tables and columns for database DB1 on instance SQLDB1
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>New-DbaDbMaskingConfig -SqlInstance SQLDB1 -Database DB1 -Table Customer -Path C:\\Temp\\clone
Process only table Customer with all the columns
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>New-DbaDbMaskingConfig -SqlInstance SQLDB1 -Database DB1 -Table Customer -Column City -Path C:\\Temp\\clone
Process only table Customer and only the column named "City"
RELATED LINKS
https://dbatools.io/New-DbaDbMaskingConfig
SYNOPSIS
Generates a new data masking configuration file to be used with Invoke-DbaDbDataMasking
SYNTAX
New-DbaDbMaskingConfig [[-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
[[-SqlCredential] <Pscredential>] [[-Database] <System.String[]>] [[-Table] <System.String[]>] [[-Column]
<System.String[]>] [-Path] <String> [[-Locale] <String>] [[-CharacterString] <String>] [[-SampleCount] <Int>]
[[-KnownNameFilePath] <String>] [[-PatternFilePath] <String>] [-ExcludeDefaultKnownName <Switch>]
[-ExcludeDefaultPattern <Switch>] [-Force <Switch>] [[-InputObject] <System.Object[]>] [-EnableException <Switch>]
[<CommonParameters>]
DESCRIPTION
Generates a new data masking configuration file. This file is important to apply any data masking to the data in a
database.
Note that the following column and data types are not currently supported:
Identity
ForeignKey
Computed
Hierarchyid
Geography
Geometry
Xml
Read more here:
https://sachabarbs.wordpress.com/2018/0 ... data-tool/
https://github.com/bchavez/Bogus
PARAMETERS
-CharacterString [<String>]
The characters to use in string data. 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789' by
default
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Column [<System.String[]>]
Columns to process. By default all the columns will be processed
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Database [<System.String[]>]
Databases to process through
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-EnableException [<Switch>]
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-ExcludeDefaultKnownName [<Switch>]
Excludes the default known names
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-ExcludeDefaultPattern [<Switch>]
Excludes the default patterns
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Force [<Switch>]
Forcefully execute commands when needed
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-InputObject [<System.Object[]>]
Used for piping the values from Invoke-DbaDbPiiScan
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-KnownNameFilePath [<String>]
Points to a file containing the custom known names
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Locale [<String>]
Set the local to enable certain settings in the masking
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Path [<String>]
Path where to save the generated JSON files.
Th naming convention will be "servername.databasename.tables.json"
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-PatternFilePath [<String>]
Points to a file containing the custom patterns
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SampleCount [<Int>]
Amount of rows to sample to make an assessment. The default is 100
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlCredential [<Pscredential>]
Login to the target instance using alternative credentials. Accepts PowerShell credentials (Get-Credential).
Windows Authentication, SQL Server Authentication, Active Directory - Password, and Active Directory -
Integrated are all supported.
For MFA support, please use Connect-DbaInstance.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlInstance [<Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
The target SQL Server instance or instances.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Table [<System.String[]>]
Tables to process. By default all the tables will be processed
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
Tags: Masking, DataMasking
Author: Sander Stad (@sqlstad, sqlstad.nl) | Chrissy LeMaire (@cl, netnerds.net)
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>New-DbaDbMaskingConfig -SqlInstance SQLDB1 -Database DB1 -Path C:\\Temp\\clone
Process all tables and columns for database DB1 on instance SQLDB1
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>New-DbaDbMaskingConfig -SqlInstance SQLDB1 -Database DB1 -Table Customer -Path C:\\Temp\\clone
Process only table Customer with all the columns
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>New-DbaDbMaskingConfig -SqlInstance SQLDB1 -Database DB1 -Table Customer -Column City -Path C:\\Temp\\clone
Process only table Customer and only the column named "City"
RELATED LINKS
https://dbatools.io/New-DbaDbMaskingConfig