Package version:

Interface DataMaskingRule

Represents a database data masking rule.

Hierarchy

Properties

aliasName? columnName? id? idPropertiesId? kind? location? maskingFunction? name? numberFrom? numberTo? prefixSize? replacementString? ruleState? schemaName? suffixSize? tableName? type?

Properties

Optional aliasName

aliasName?: string

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

Optional columnName

columnName?: string

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

Optional Readonly id

id?: string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional Readonly idPropertiesId

idPropertiesId?: string

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

Optional Readonly kind

kind?: string

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.

Optional Readonly location

location?: string

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

Optional maskingFunction

maskingFunction?: DataMaskingFunction

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

Optional Readonly name

name?: string

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

Optional numberFrom

numberFrom?: string

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

Optional numberTo

numberTo?: string

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

Optional prefixSize

prefixSize?: string

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.

Optional replacementString

replacementString?: string

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

Optional ruleState

ruleState?: DataMaskingRuleState

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.

Optional schemaName

schemaName?: string

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

Optional suffixSize

suffixSize?: string

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.

Optional tableName

tableName?: string

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

Optional Readonly type

type?: string

Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

Settings

Member Visibility

Theme

Generated using TypeDoc