Share via


DataMaskingRule Class

Definition

Represents a Sql pool data masking rule.

[Microsoft.Rest.Serialization.JsonTransformation]
public class DataMaskingRule : Microsoft.Azure.Management.Synapse.Models.ProxyResource
[<Microsoft.Rest.Serialization.JsonTransformation>]
type DataMaskingRule = class
    inherit ProxyResource
Public Class DataMaskingRule
Inherits ProxyResource
Inheritance
DataMaskingRule
Attributes

Constructors

DataMaskingRule()

Initializes a new instance of the DataMaskingRule class.

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.

Properties

AliasName

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

ColumnName

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

DataMaskingRuleId

Gets the rule Id.

Id

Gets fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

(Inherited from Resource)
Kind

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

Location

Gets the location of the data masking rule.

MaskingFunction

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

Name

Gets the name of the resource

(Inherited from Resource)
NumberFrom

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

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.

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.

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.

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'

SchemaName

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

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.

TableName

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

Type

Gets the type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

(Inherited from Resource)

Methods

Validate()

Validate the object.

Applies to