Set-AzureRmSqlDatabaseDataMaskingPolicy
Sets data masking for a database.
Important
Because Az PowerShell modules now have all the capabilities of AzureRM PowerShell modules and more, we'll retire AzureRM PowerShell modules on 29 February 2024.
To avoid service interruptions, update your scripts that use AzureRM PowerShell modules to use Az PowerShell modules by 29 February 2024. To automatically update your scripts, follow the quickstart guide.
Syntax
Set-AzureRmSqlDatabaseDataMaskingPolicy
[-PassThru]
[-PrivilegedLogins <String>]
[-PrivilegedUsers <String>]
[-DataMaskingState <String>]
[-ServerName] <String>
[-DatabaseName] <String>
[-ResourceGroupName] <String>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
The Set-AzureRmSqlDatabaseDataMaskingPolicy cmdlet sets the data masking policy for an Azure SQL database. To use this cmdlet, use the ResourceGroupName, ServerName, and DatabaseName parameters to identify the database. You can set the DataMaskingState parameter to specify whether data masking operations are enabled or disabled. You can also set the PrivilegedLogins parameter to specify which users are allowed to see the unmasked data. If the cmdlet succeeds and the PassThru parameter is used, it returns an object describing the current data masking policy in addition to the database identifiers. Database identifiers include, but are not limited to, ResourceGroupName, ServerName, and DatabaseName. This cmdlet is also supported by the SQL Server Stretch Database service on Azure.
Examples
Example 1: Set the data masking policy for a database
PS C:\>Set-AzureRmSqlDatabaseDataMaskingPolicy -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01 -PrivilegedUsers "public" -DataMaskingState "Enabled"This command sets the data masking policy for a database named database01 on the server named server01.
Parameters
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Specifies the name of the database where the policy is set.
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
Specifies whether data masking operation is enabled or disabled. The acceptable values for this parameter are:
- Enabled
- Disabled The default value is Enabled.
| Type: | String |
| Accepted values: | Enabled, Disabled |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
The credentials, account, tenant, and subscription used for communication with azure
| Type: | IAzureContextContainer |
| Aliases: | AzureRmContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Specifies which SQL users are excluded from masking. This parameter is deprecated and will be removed from future releases.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
Specifies a semicolon-separated list of privileged user IDs. These users are allowed to view the masking data.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
Specifies the name of the resource group to which the database is assigned.
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
Specifies the name of the server hosting the database.
| Type: | String |
| Position: | 1 |
| Default value: | None |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
Outputs
DatabaseDataMaskingPolicyModel