DataMaskingRule Interface

Package:

com.azure.resourcemanager.synapse.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-synapse:1.0.0-beta.7

public interface DataMaskingRule

An immutable client-side representation of DataMaskingRule.

Method Summary

Modifier and Type	Method and Description
abstract String	aliasName() Gets the aliasName property: The alias name.
abstract String	columnName() Gets the columnName property: The column name on which the data masking rule is applied.
abstract String	id() Gets the id property: Fully qualified resource Id for the resource.
abstract String	idPropertiesId() Gets the idPropertiesId property: The rule Id.
abstract DataMaskingRuleInner	innerModel() Gets the inner com.azure.resourcemanager.synapse.fluent.models.DataMaskingRuleInner object.
abstract String	kind() Gets the kind property: The kind of Data Masking Rule.
abstract String	location() Gets the location property: The location of the data masking rule.
abstract DataMaskingFunction	maskingFunction() Gets the maskingFunction property: The masking function that is used for the data masking rule.
abstract String	name() Gets the name property: The name of the resource.
abstract String	numberFrom() Gets the numberFrom property: The numberFrom property of the masking rule.
abstract String	numberTo() Gets the numberTo property: The numberTo property of the data masking rule.
abstract String	prefixSize() Gets the prefixSize property: If maskingFunction is set to Text, the number of characters to show unmasked in the beginning of the string.
abstract DataMaskingRule	refresh() Refreshes the resource to sync with Azure.
abstract DataMaskingRule	refresh(Context context) Refreshes the resource to sync with Azure.
abstract Region	region() Gets the region of the resource.
abstract String	regionName() Gets the name of the resource region.
abstract String	replacementString() Gets the replacementString property: If maskingFunction is set to Text, the character to use for masking the unexposed part of the string.
abstract String	resourceGroupName() Gets the name of the resource group.
abstract DataMaskingRuleState	ruleState() Gets the ruleState property: The rule state.
abstract String	schemaName() Gets the schemaName property: The schema name on which the data masking rule is applied.
abstract String	suffixSize() Gets the suffixSize property: If maskingFunction is set to Text, the number of characters to show unmasked at the end of the string.
abstract String	tableName() Gets the tableName property: The table name on which the data masking rule is applied.
abstract String	type() Gets the type property: The type of the resource.
abstract Update	update() Begins update for the DataMaskingRule resource.

Method Details

aliasName

public abstract String aliasName()

Gets the aliasName property: The alias name. This is a legacy parameter and is no longer used.

Returns:

the aliasName value.

columnName

public abstract String columnName()

Gets the columnName property: The column name on which the data masking rule is applied.

Returns:

the columnName value.

id

public abstract String id()

Gets the id property: Fully qualified resource Id for the resource.

Returns:

the id value.

idPropertiesId

public abstract String idPropertiesId()

Gets the idPropertiesId property: The rule Id.

Returns:

the idPropertiesId value.

innerModel

public abstract DataMaskingRuleInner innerModel()

Gets the inner com.azure.resourcemanager.synapse.fluent.models.DataMaskingRuleInner object.

Returns:

the inner object.

kind

public abstract String kind()

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

Returns:

the kind value.

location

public abstract String location()

Gets the location property: The location of the data masking rule.

Returns:

the location value.

maskingFunction

public abstract DataMaskingFunction maskingFunction()

Gets the maskingFunction property: The masking function that is used for the data masking rule.

Returns:

the maskingFunction value.

name

public abstract String name()

Gets the name property: The name of the resource.

Returns:

the name value.

numberFrom

public abstract String numberFrom()

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

Returns:

the numberFrom value.

numberTo

public abstract String numberTo()

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

Returns:

the numberTo value.

prefixSize

public abstract String prefixSize()

Gets the prefixSize property: 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.

Returns:

the prefixSize value.

refresh

public abstract DataMaskingRule refresh()

Refreshes the resource to sync with Azure.

Returns:

the refreshed resource.

refresh

public abstract DataMaskingRule refresh(Context context)

Refreshes the resource to sync with Azure.

Parameters:

context - The context to associate with this operation.

Returns:

the refreshed resource.

region

public abstract Region region()

Gets the region of the resource.

Returns:

the region of the resource.

regionName

public abstract String regionName()

Gets the name of the resource region.

Returns:

the name of the resource region.

replacementString

public abstract String replacementString()

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

Returns:

the replacementString value.

resourceGroupName

public abstract String resourceGroupName()

Gets the name of the resource group.

Returns:

the name of the resource group.

ruleState

public abstract DataMaskingRuleState ruleState()

Gets the ruleState property: 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.

Returns:

the ruleState value.

schemaName

public abstract String schemaName()

Gets the schemaName property: The schema name on which the data masking rule is applied.

Returns:

the schemaName value.

suffixSize

public abstract String suffixSize()

Gets the suffixSize property: 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.

Returns:

the suffixSize value.

tableName

public abstract String tableName()

Gets the tableName property: The table name on which the data masking rule is applied.

Returns:

the tableName value.

type

public abstract String type()

Gets the type property: The type of the resource.

Returns:

the type value.

update

public abstract DataMaskingRule.Update update()

Begins update for the DataMaskingRule resource.

Returns:

the stage of resource update.