Share via

DataMaskingRule interface

  • Reference
Package:
@azure/arm-synapse

Represents a Sql pool data masking rule.

Extends
ProxyResource

Properties

aliasName

The alias name. This is a legacy parameter and is no longer used.
columnName

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

The rule Id. NOTE: This property will not be serialized. It can only be populated by the server.
kind

The kind of Data Masking Rule. Metadata, used for Azure portal. NOTE: This property will not be serialized. It can only be populated by the server.
location

The location of the data masking rule. NOTE: This property will not be serialized. It can only be populated by the server.
maskingFunction

The masking function that is used for the data masking rule.
numberFrom

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

The numberTo property of the data masking rule. Required if maskingFunction is set to Number, otherwise this parameter will be ignored.
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.
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.
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.
schemaName

The schema name on which the data masking rule is applied.
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.
tableName

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

Inherited Properties

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.
name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

aliasName

The alias name. This is a legacy parameter and is no longer used.

aliasName?: string

Property Value

string

columnName

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

columnName?: string

Property Value

string

idPropertiesId

The rule Id. NOTE: This property will not be serialized. It can only be populated by the server.

idPropertiesId?: string

Property Value

string

kind

The kind of Data Masking Rule. Metadata, used for Azure portal. NOTE: This property will not be serialized. It can only be populated by the server.

kind?: string

Property Value

string

location

The location of the data masking rule. NOTE: This property will not be serialized. It can only be populated by the server.

location?: string

Property Value

string

maskingFunction

The masking function that is used for the data masking rule.

maskingFunction?: DataMaskingFunction

Property Value

DataMaskingFunction

numberFrom

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

numberFrom?: string

Property Value

string

numberTo

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

numberTo?: string

Property Value

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.

prefixSize?: string

Property Value

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.

replacementString?: string

Property Value

string

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.

ruleState?: DataMaskingRuleState

Property Value

DataMaskingRuleState

schemaName

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

schemaName?: string

Property Value

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.

suffixSize?: string

Property Value

string

tableName

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

tableName?: string

Property Value

string

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From ProxyResource.id

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From ProxyResource.name

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From ProxyResource.type