Get-AzureSqlDatabaseDataMaskingRule
Get-AzureSqlDatabaseDataMaskingRule
Gets the data masking rules from an Azure SQL database.
Syntax
Parameter Set: Default
Get-AzureSqlDatabaseDataMaskingRule [-ResourceGroupName] <System.String> [-ServerName] <System.String> [-DatabaseName] <System.String> [-Profile <Microsoft.Azure.Common.Authentication.Models.AzureProfile> ] [-RuleId <System.String> ]
Detailed Description
The Get-AzureSqlDatabaseDataMaskingRule cmdlet gets either a specific data masking rule, or all of the data masking rules of 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, then all the data masking rules of that Azure SQL database are returned.
Parameters
-DatabaseName<System.String>
Specifies the name of the database.
Aliases |
none |
Required? |
true |
Position? |
3 |
Default Value |
none |
Accept Pipeline Input? |
true(ByPropertyName) |
Accept Wildcard Characters? |
false |
-Profile<Microsoft.Azure.Common.Authentication.Models.AzureProfile>
Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ResourceGroupName<System.String>
Specifies the name of the resource group containing the database.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true(ByPropertyName) |
Accept Wildcard Characters? |
false |
-RuleId<System.String>
Specifies the ID of the requested rule. If you do not specify this parameter, this cmdlet gets all the information about all the data masking rules in the specified SQL database.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true(ByPropertyName) |
Accept Wildcard Characters? |
false |
-ServerName<System.String>
Specifies the name of the server.
Aliases |
none |
Required? |
true |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
true(ByPropertyName) |
Accept Wildcard Characters? |
false |
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
- None
Outputs
The output type is the type of the objects that the cmdlet emits.
- Microsoft.Azure.Commands.Sql.Security.Model.DatabaseDataMaskingRuleModel
Notes
- This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters.
Examples
Example 1: Get all data masking rules from a database
This command gets all data masking rules from Database06 in resource group ResourceGroup11 contained in server Server01.
PS C:\> Get-AzureSqlDatabaseDataMaskingRule -ResourceGroupName "ResourceGroup11" -ServerName "Server01" -DatabaseName "Database06"
Related topics
Get-AzureSqlDatabaseDataMaskingPolicy
New-AzureSqlDatabaseDataMaskingRule
Remove-AzureSqlDatabaseDataMaskingRule
Set-AzureSqlDatabaseDataMaskingPolicy