Class DataMaskingRule

Represents a database data masking rule.

Inheritance
Object
Resource
ProxyResource
DataMaskingRule
Inherited Members
Namespace: System.Dynamic.ExpandoObject
Assembly: Microsoft.Azure.Management.Sql.dll
Syntax
[Microsoft.Rest.Serialization.JsonTransformation]
public class DataMaskingRule : Microsoft.Azure.Management.Sql.Models.ProxyResource

Constructors

DataMaskingRule()

Initializes a new instance of the DataMaskingRule class.

Declaration
public DataMaskingRule ();

DataMaskingRule(String, String, String, DataMaskingFunction, String, String, String, String, String, Nullable<DataMaskingRuleState>, String, String, String, String, String, String, String)

Initializes a new instance of the DataMaskingRule class.

Declaration
public DataMaskingRule (string schemaName, string tableName, string columnName, Microsoft.Azure.Management.Sql.Models.DataMaskingFunction maskingFunction, string id = null, string name = null, string type = null, string dataMaskingRuleId = null, string aliasName = null, Nullable<Microsoft.Azure.Management.Sql.Models.DataMaskingRuleState> ruleState = null, string numberFrom = null, string numberTo = null, string prefixSize = null, string suffixSize = null, string replacementString = null, string location = null, string kind = null);
Parameters
String schemaName

The schema name on which the data masking rule is applied.
String tableName

The table name on which the data masking rule is applied.
String columnName

The column name on which the data masking rule is applied.
DataMaskingFunction maskingFunction

The masking function that is used for the data masking rule. Possible values include: 'Default', 'CCN', 'Email', 'Number', 'SSN', 'Text'
String id

Resource ID.
String name

Resource name.
String type

Resource type.
String dataMaskingRuleId

The rule Id.
String aliasName

The alias name. This is a legacy parameter and is no longer used.
Nullable<DataMaskingRuleState> ruleState

The rule state. Used to delete a rule. To delete an existing rule, specify the schemaName, tableName, columnName, maskingFunction, and specify ruleState as disabled. However, if the rule doesn't already exist, the rule will be created with ruleState set to enabled, regardless of the provided value of ruleState. Possible values include: 'Disabled', 'Enabled'
String numberFrom

The numberFrom property of the masking rule. Required if maskingFunction is set to Number, otherwise this parameter will be ignored.
String numberTo

The numberTo property of the data masking rule. Required if maskingFunction is set to Number, otherwise this parameter will be ignored.
String prefixSize

If maskingFunction is set to Text, the number of characters to show unmasked in the beginning of the string. Otherwise, this parameter will be ignored.
String suffixSize

If maskingFunction is set to Text, the number of characters to show unmasked at the end of the string. Otherwise, this parameter will be ignored.
String replacementString

If maskingFunction is set to Text, the character to use for masking the unexposed part of the string. Otherwise, this parameter will be ignored.
String location

The location of the data masking rule.
String kind

The kind of Data Masking Rule. Metadata, used for Azure portal.

Properties

AliasName

Gets or sets the alias name. This is a legacy parameter and is no longer used.

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.aliasName")]
public string AliasName { get; set; }
Property Value
String

ColumnName

Gets or sets the column name on which the data masking rule is applied.

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.columnName")]
public string ColumnName { get; set; }
Property Value
String

DataMaskingRuleId

Gets the rule Id.

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.id")]
public string DataMaskingRuleId { get; }
Property Value
String

Kind

Gets the kind of Data Masking Rule. Metadata, used for Azure portal.

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="kind")]
public string Kind { get; }
Property Value
String

Location

Gets the location of the data masking rule.

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="location")]
public string Location { get; }
Property Value
String

MaskingFunction

Gets or sets the masking function that is used for the data masking rule. Possible values include: 'Default', 'CCN', 'Email', 'Number', 'SSN', 'Text'

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.maskingFunction")]
public Microsoft.Azure.Management.Sql.Models.DataMaskingFunction MaskingFunction { get; set; }
Property Value
DataMaskingFunction

NumberFrom

Gets or sets the numberFrom property of the masking rule. Required if maskingFunction is set to Number, otherwise this parameter will be ignored.

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.numberFrom")]
public string NumberFrom { get; set; }
Property Value
String

NumberTo

Gets or sets the numberTo property of the data masking rule. Required if maskingFunction is set to Number, otherwise this parameter will be ignored.

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.numberTo")]
public string NumberTo { get; set; }
Property Value
String

PrefixSize

Gets or sets if maskingFunction is set to Text, the number of characters to show unmasked in the beginning of the string. Otherwise, this parameter will be ignored.

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.prefixSize")]
public string PrefixSize { get; set; }
Property Value
String

ReplacementString

Gets or sets if maskingFunction is set to Text, the character to use for masking the unexposed part of the string. Otherwise, this parameter will be ignored.

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.replacementString")]
public string ReplacementString { get; set; }
Property Value
String

RuleState

Gets or sets the rule state. Used to delete a rule. To delete an existing rule, specify the schemaName, tableName, columnName, maskingFunction, and specify ruleState as disabled. However, if the rule doesn't already exist, the rule will be created with ruleState set to enabled, regardless of the provided value of ruleState. Possible values include: 'Disabled', 'Enabled'

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.ruleState")]
public Nullable<Microsoft.Azure.Management.Sql.Models.DataMaskingRuleState> RuleState { get; set; }
Property Value
Nullable<DataMaskingRuleState>

SchemaName

Gets or sets the schema name on which the data masking rule is applied.

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.schemaName")]
public string SchemaName { get; set; }
Property Value
String

SuffixSize

Gets or sets if maskingFunction is set to Text, the number of characters to show unmasked at the end of the string. Otherwise, this parameter will be ignored.

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.suffixSize")]
public string SuffixSize { get; set; }
Property Value
String

TableName

Gets or sets the table name on which the data masking rule is applied.

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.tableName")]
public string TableName { get; set; }
Property Value
String

Methods

Validate()

Validate the object.

Declaration
public virtual void Validate ();
Exceptions
ValidationException

Thrown if validation fails