< Back
Get-AzureRmSqlDatabaseDataMaskingRule
Post
NAME Get-AzureRmSqlDatabaseDataMaskingRule
SYNOPSIS
Gets the data masking rules from a database.
SYNTAX
Get-AzureRmSqlDatabaseDataMaskingRule [-ResourceGroupName] <String> [-ServerName] <String> [-DatabaseName] <String> [-ColumnName <String>]
[-DefaultProfile <IAzureContextContainer>] [-SchemaName <String>] [-TableName <String>] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Get-AzureRmSqlDatabaseDataMaskingRule cmdlet gets either a specific data masking rule or all of the data masking rules for an Azure SQL
database. To use the cmdlet, use the ResourceGroupName , ServerName , and DatabaseName parameters to identify the database, and the RuleId
parameter to specify which rule this cmdlet returns. If you do not provide RuleId , all the data masking rules for that Azure SQL database are
returned.
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? false
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
-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? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ServerName <String>
Specifies the name of the server.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-TableName <String>
Specifies the name of an Azure SQL table.
Required? false
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: Get all data masking rules from a database
PS C:\\>Get-AzureRmSqlDatabaseDataMaskingRule -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01"
DatabaseName : database01
ResourceGroupName : resourcegroup01
ServerName : server01
SchemaName : dbo
TableName : table1
ColumnName : column1
MaskingFunction : Default
PrefixSize :
SuffixSize :
ReplacementString :
NumberFrom :
NumberTo :
DatabaseName : database01
ResourceGroupName : resourcegroup01
ServerName : server01
SchemaName : dbo
TableName : table2
ColumnName : column2
MaskingFunction : Default
PrefixSize :
SuffixSize :
ReplacementString :
NumberFrom :
NumberTo :
Example 2: Get the data masking rule defined on schema "dbo", table "table1" and column "column1".
PS C:\\>Get-AzureRmSqlDatabaseDataMaskingRule -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -SchemaName
"dbo" -TableName "table1" -ColumnName "column1"
DatabaseName : database01
ResourceGroupName : resourcegroup01
ServerName : server01
SchemaName : dbo
TableName : table1
ColumnName : column1
MaskingFunction : Default
PrefixSize :
SuffixSize :
ReplacementString :
NumberFrom :
NumberTo :
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... askingrule
Get-AzureRmSqlDatabaseDataMaskingPolicy
New-AzureRmSqlDatabaseDataMaskingRule
Remove-AzureRmSqlDatabaseDataMaskingRule
Set-AzureRmSqlDatabaseDataMaskingPolicy
Set-AzureRmSqlDatabaseDataMaskingRule
SYNOPSIS
Gets the data masking rules from a database.
SYNTAX
Get-AzureRmSqlDatabaseDataMaskingRule [-ResourceGroupName] <String> [-ServerName] <String> [-DatabaseName] <String> [-ColumnName <String>]
[-DefaultProfile <IAzureContextContainer>] [-SchemaName <String>] [-TableName <String>] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Get-AzureRmSqlDatabaseDataMaskingRule cmdlet gets either a specific data masking rule or all of the data masking rules for an Azure SQL
database. To use the cmdlet, use the ResourceGroupName , ServerName , and DatabaseName parameters to identify the database, and the RuleId
parameter to specify which rule this cmdlet returns. If you do not provide RuleId , all the data masking rules for that Azure SQL database are
returned.
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? false
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
-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? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ServerName <String>
Specifies the name of the server.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-TableName <String>
Specifies the name of an Azure SQL table.
Required? false
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: Get all data masking rules from a database
PS C:\\>Get-AzureRmSqlDatabaseDataMaskingRule -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01"
DatabaseName : database01
ResourceGroupName : resourcegroup01
ServerName : server01
SchemaName : dbo
TableName : table1
ColumnName : column1
MaskingFunction : Default
PrefixSize :
SuffixSize :
ReplacementString :
NumberFrom :
NumberTo :
DatabaseName : database01
ResourceGroupName : resourcegroup01
ServerName : server01
SchemaName : dbo
TableName : table2
ColumnName : column2
MaskingFunction : Default
PrefixSize :
SuffixSize :
ReplacementString :
NumberFrom :
NumberTo :
Example 2: Get the data masking rule defined on schema "dbo", table "table1" and column "column1".
PS C:\\>Get-AzureRmSqlDatabaseDataMaskingRule -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -SchemaName
"dbo" -TableName "table1" -ColumnName "column1"
DatabaseName : database01
ResourceGroupName : resourcegroup01
ServerName : server01
SchemaName : dbo
TableName : table1
ColumnName : column1
MaskingFunction : Default
PrefixSize :
SuffixSize :
ReplacementString :
NumberFrom :
NumberTo :
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... askingrule
Get-AzureRmSqlDatabaseDataMaskingPolicy
New-AzureRmSqlDatabaseDataMaskingRule
Remove-AzureRmSqlDatabaseDataMaskingRule
Set-AzureRmSqlDatabaseDataMaskingPolicy
Set-AzureRmSqlDatabaseDataMaskingRule