commands

^

New-DbaDbMaskingConfig

Author Sander Stad (@sqlstad, sqlstad.nl) , Chrissy LeMaire (@cl, netnerds.net)
Availability Windows, Linux, macOS

 

Synopsis

Generates a new data masking configuration file to be used with Invoke-DbaDbDataMasking

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/06/11/bogus-simple-fake-data-tool/ https://github.com/bchavez/Bogus

Syntax

New-DbaDbMaskingConfig
    [[-SqlInstance] <DbaInstanceParameter[]>]
    [[-SqlCredential] <PSCredential>]
    [[-Database] <String[]>]
    [[-Table] <String[]>]
    [[-Column] <String[]>]
    [-Path] <String>
    [[-Locale] <String>]
    [[-CharacterString] <String>]
    [[-SampleCount] <Int32>]
    [[-KnownNameFilePath] <String>]
    [[-PatternFilePath] <String>]
    [-ExcludeDefaultKnownName]
    [-ExcludeDefaultPattern]
    [-Force]
    [[-InputObject] <Object[]>]
    [-EnableException]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

 

Examples

 

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"

Required Parameters

-Path

Path where to save the generated JSON files. Th naming convention will be "servername.databasename.tables.json"

Alias
Required True
Pipeline false
Default Value

Optional Parameters

-SqlInstance

The target SQL Server instance or instances.

Alias
Required False
Pipeline false
Default Value
-SqlCredential

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.

Alias
Required False
Pipeline false
Default Value
-Database

Databases to process through

Alias
Required False
Pipeline false
Default Value
-Table

Tables to process. By default all the tables will be processed

Alias
Required False
Pipeline false
Default Value
-Column

Columns to process. By default all the columns will be processed

Alias
Required False
Pipeline false
Default Value
-Locale

Set the local to enable certain settings in the masking

Alias
Required False
Pipeline false
Default Value en
-CharacterString

The characters to use in string data. 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789' by default

Alias
Required False
Pipeline false
Default Value abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789
-SampleCount

Amount of rows to sample to make an assessment. The default is 100

Alias
Required False
Pipeline false
Default Value 100
-KnownNameFilePath

Points to a file containing the custom known names

Alias
Required False
Pipeline false
Default Value
-PatternFilePath

Points to a file containing the custom patterns

Alias
Required False
Pipeline false
Default Value
-ExcludeDefaultKnownName

Excludes the default known names

Alias
Required False
Pipeline false
Default Value False
-ExcludeDefaultPattern

Excludes the default patterns

Alias
Required False
Pipeline false
Default Value False
-Force

Forcefully execute commands when needed

Alias
Required False
Pipeline false
Default Value False
-InputObject

Used for piping the values from Invoke-DbaDbPiiScan

Alias
Required False
Pipeline true (ByValue)
Default Value
-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.

Alias
Required False
Pipeline false
Default Value False
-WhatIf

Shows what would happen if the command were to run. No actions are actually performed.

Alias wi
Required False
Pipeline false
Default Value
-Confirm

Prompts you for confirmation before executing any changing operations within the command.

Alias cf
Required False
Pipeline false
Default Value

 

Want to see the source code for this command? Check out New-DbaDbMaskingConfig on GitHub.
Want to see the Bill Of Health for this command? Check out New-DbaDbMaskingConfig.