Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
Get-AzSqlDatabaseDataMaskingRule
- Module:
- Az.Sql Module
Gets the data masking rules from a database.
Syntax
Default (Default)
Get-AzSqlDatabaseDataMaskingRule
[-SchemaName <String>]
[-TableName <String>]
[-ColumnName <String>]
[-ServerName] <String>
[-DatabaseName] <String>
[-ResourceGroupName] <String>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Get-AzSqlDatabaseDataMaskingRule 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.
Examples
Example 1: Get all data masking rules from a database
Get-AzSqlDatabaseDataMaskingRule -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".
Get-AzSqlDatabaseDataMaskingRule -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 :
Parameters
-ColumnName
Specifies the name of the column targeted by the masking rule.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
-DatabaseName
Specifies the name of the database.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure
Parameter properties
| Type: | IAzureContextContainer |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
Parameter sets
-ResourceGroupName
Specifies the name of the resource group to which the database is assigned.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-SchemaName
Specifies the name of a schema.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ServerName
Specifies the name of the server.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-TableName
Specifies the name of an Azure SQL table.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
String
Outputs
DatabaseDataMaskingRuleModel
Related Links
Azure PowerShell
Feedback
Was this page helpful?