< Back
New-AzureRmSqlDatabaseDataMaskingRule
Post
NAME New-AzureRmSqlDatabaseDataMaskingRule
SYNOPSIS
Creates a data masking rule for a database.
SYNTAX
New-AzureRmSqlDatabaseDataMaskingRule [-ResourceGroupName] <String> [-ServerName] <String> [-DatabaseName] <String> -ColumnName <String>
[-DefaultProfile <IAzureContextContainer>] -MaskingFunction {NoMasking | Default | Text | Number | SocialSecurityNumber | CreditCardNumber |
Email} [-NumberFrom <Double>] [-NumberTo <Double>] [-PassThru] [-PrefixSize <UInt32>] [-ReplacementString <String>] -SchemaName <String>
[-SuffixSize <UInt32>] -TableName <String> [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The New-AzureRmSqlDatabaseDataMaskingRule cmdlet creates a data masking rule for an Azure SQL database. To use the cmdlet, use the
ResourceGroupName , ServerName , DatabaseName , and RuleId parameters to identify the rule. Provide the TableName and ColumnName to specify the
target of the rule and the MaskingFunction parameter to define how the data is masked.
If MaskingFunction has a value of Number or Text, you can specify the NumberFrom and NumberTo parameters, for number masking, or the PrefixSize ,
ReplacementString , and SuffixSize for text masking.
If the command succeeds and the PassThru parameter is used, the cmdlet returns an object describing the data masking rule properties in addition
to the rule identifiers. Rule identifiers include, but are not limited to, ResourceGroupName , ServerName , DatabaseName , and RuleID .
This cmdlet is also supported by the SQL Server Stretch Database service on Azure.
PARAMETERS
-ColumnName <String>
Specifies the name of the column targeted by the masking rule.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DatabaseName <String>
Specifies the name of the database.
Required? true
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-MaskingFunction <String>
Specifies the masking function that the rule uses. The acceptable values for this parameter are:
- Default
- NoMasking
- Text
- Number
- SocialSecurityNumber
- CreditCardNumber
- Email
The default value is Default.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-NumberFrom <Double>
Specifies the lower bound number of the interval from which a random value is selected. Specify this parameter only if you specify a value of
Number for the MaskingFunction parameter. The default value is 0.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-NumberTo <Double>
Specifies the upper bound number of the interval from which a random value is selected. Specify this parameter only if you specify a value of
Number for the MaskingFunction parameter. The default value is 0.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-PrefixSize <UInt32>
Specifies the number of characters at the start of the text that are not masked. Specify this parameter only if you specify a value of Text
for the MaskingFunction parameter. The default value is 0.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ReplacementString <String>
Specifies the number of characters in the end of the text that are not masked. Specify this parameter only if you specify a value of Text for
the MaskingFunction parameter. The default value is an empty string.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceGroupName <String>
Specifies the name of the resource group to which the database is assigned.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-SchemaName <String>
Specifies the name of a schema.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ServerName <String>
Specifies the name of the server that hosts the database.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-SuffixSize <UInt32>
Specifies the number of characters at the end of the text that are not masked. Specify this parameter only if you specify a value of Text for
the MaskingFunction parameter. The default value is 0.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-TableName <String>
Specifies the name of the database table that contains the masked column.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
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 (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None.
OUTPUTS
Microsoft.Azure.Commands.Sql.Security.Model.DatabaseDataMaskingRuleModel
NOTES
Example 1: Create a data masking rule for a number column in a database
PS C:\\>New-AzureRmSqlDatabaseDataMaskingRule -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -RuleId
"Rule01" -SchemaName "Schema01" -TableName "Table01" -ColumnName "Column01" -MaskingFunction "Number" -NumberFrom 5 -NumberTo 14
This command creates a data masking rule for the column named Column01 in the table named Table01 in the schema named Schema01. The database named
Database01 contains all these items. The rule is a number masking rule that uses a random number between 5 and 14 as the mask value. The rule is
named Rule01.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... askingrule
Get-AzureRmSqlDatabaseDataMaskingRule
Remove-AzureRmSqlDatabaseDataMaskingRule
Set-AzureRmSqlDatabaseDataMaskingRule
SQL Database Documentation https://docs.microsoft.com/azure/sql-database/
SYNOPSIS
Creates a data masking rule for a database.
SYNTAX
New-AzureRmSqlDatabaseDataMaskingRule [-ResourceGroupName] <String> [-ServerName] <String> [-DatabaseName] <String> -ColumnName <String>
[-DefaultProfile <IAzureContextContainer>] -MaskingFunction {NoMasking | Default | Text | Number | SocialSecurityNumber | CreditCardNumber |
Email} [-NumberFrom <Double>] [-NumberTo <Double>] [-PassThru] [-PrefixSize <UInt32>] [-ReplacementString <String>] -SchemaName <String>
[-SuffixSize <UInt32>] -TableName <String> [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The New-AzureRmSqlDatabaseDataMaskingRule cmdlet creates a data masking rule for an Azure SQL database. To use the cmdlet, use the
ResourceGroupName , ServerName , DatabaseName , and RuleId parameters to identify the rule. Provide the TableName and ColumnName to specify the
target of the rule and the MaskingFunction parameter to define how the data is masked.
If MaskingFunction has a value of Number or Text, you can specify the NumberFrom and NumberTo parameters, for number masking, or the PrefixSize ,
ReplacementString , and SuffixSize for text masking.
If the command succeeds and the PassThru parameter is used, the cmdlet returns an object describing the data masking rule properties in addition
to the rule identifiers. Rule identifiers include, but are not limited to, ResourceGroupName , ServerName , DatabaseName , and RuleID .
This cmdlet is also supported by the SQL Server Stretch Database service on Azure.
PARAMETERS
-ColumnName <String>
Specifies the name of the column targeted by the masking rule.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DatabaseName <String>
Specifies the name of the database.
Required? true
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-MaskingFunction <String>
Specifies the masking function that the rule uses. The acceptable values for this parameter are:
- Default
- NoMasking
- Text
- Number
- SocialSecurityNumber
- CreditCardNumber
The default value is Default.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-NumberFrom <Double>
Specifies the lower bound number of the interval from which a random value is selected. Specify this parameter only if you specify a value of
Number for the MaskingFunction parameter. The default value is 0.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-NumberTo <Double>
Specifies the upper bound number of the interval from which a random value is selected. Specify this parameter only if you specify a value of
Number for the MaskingFunction parameter. The default value is 0.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-PrefixSize <UInt32>
Specifies the number of characters at the start of the text that are not masked. Specify this parameter only if you specify a value of Text
for the MaskingFunction parameter. The default value is 0.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ReplacementString <String>
Specifies the number of characters in the end of the text that are not masked. Specify this parameter only if you specify a value of Text for
the MaskingFunction parameter. The default value is an empty string.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceGroupName <String>
Specifies the name of the resource group to which the database is assigned.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-SchemaName <String>
Specifies the name of a schema.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ServerName <String>
Specifies the name of the server that hosts the database.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-SuffixSize <UInt32>
Specifies the number of characters at the end of the text that are not masked. Specify this parameter only if you specify a value of Text for
the MaskingFunction parameter. The default value is 0.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-TableName <String>
Specifies the name of the database table that contains the masked column.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
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 (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None.
OUTPUTS
Microsoft.Azure.Commands.Sql.Security.Model.DatabaseDataMaskingRuleModel
NOTES
Example 1: Create a data masking rule for a number column in a database
PS C:\\>New-AzureRmSqlDatabaseDataMaskingRule -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -RuleId
"Rule01" -SchemaName "Schema01" -TableName "Table01" -ColumnName "Column01" -MaskingFunction "Number" -NumberFrom 5 -NumberTo 14
This command creates a data masking rule for the column named Column01 in the table named Table01 in the schema named Schema01. The database named
Database01 contains all these items. The rule is a number masking rule that uses a random number between 5 and 14 as the mask value. The rule is
named Rule01.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... askingrule
Get-AzureRmSqlDatabaseDataMaskingRule
Remove-AzureRmSqlDatabaseDataMaskingRule
Set-AzureRmSqlDatabaseDataMaskingRule
SQL Database Documentation https://docs.microsoft.com/azure/sql-database/