Get-AzureRmSqlDatabaseDataMaskingRule
Gets the data masking rules from a database.
Warning
The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.
Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.
Syntax
Get-AzureRmSqlDatabaseDataMaskingRule
[-SchemaName <String>]
[-TableName <String>]
[-ColumnName <String>]
[-ServerName] <String>
[-DatabaseName] <String>
[-ResourceGroupName] <String>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<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.
Examples
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 :Parameters
-ColumnName
Specifies the name of the column targeted by the masking rule.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DatabaseName
Specifies the name of the database.
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure
| Type: | IAzureContextContainer |
| Aliases: | AzureRmContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResourceGroupName
Specifies the name of the resource group to which the database is assigned.
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-SchemaName
Specifies the name of a schema.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ServerName
Specifies the name of the server.
| Type: | String |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-TableName
Specifies the name of an Azure SQL table.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |