Share via


DataMaskingRule Class

Definition

Represents a database data masking rule.

public class DataMaskingRule : Azure.ResourceManager.Models.ResourceData, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.Sql.Models.DataMaskingRule>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.Sql.Models.DataMaskingRule>
type DataMaskingRule = class
    inherit ResourceData
    interface IJsonModel<DataMaskingRule>
    interface IPersistableModel<DataMaskingRule>
Public Class DataMaskingRule
Inherits ResourceData
Implements IJsonModel(Of DataMaskingRule), IPersistableModel(Of DataMaskingRule)
Inheritance
DataMaskingRule
Implements

Constructors

DataMaskingRule()

Initializes a new instance of DataMaskingRule.

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.

Id

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

(Inherited from ResourceData)
Kind

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

Location

The location of the data masking rule.

MaskingFunction

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

Name

The name of the resource.

(Inherited from ResourceData)
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.

ResourceType

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

(Inherited from ResourceData)
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.

SystemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

(Inherited from ResourceData)
TableName

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

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from ResourceData)

Explicit Interface Implementations

IJsonModel<DataMaskingRule>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<DataMaskingRule>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<DataMaskingRule>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<DataMaskingRule>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<DataMaskingRule>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to