Package com.azure.resourcemanager.synapse.models

Interface DataMaskingRule

  • public interface DataMaskingRule
    An immutable client-side representation of DataMaskingRule.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String aliasName()
      Gets the aliasName property: The alias name.
      String columnName()
      Gets the columnName property: The column name on which the data masking rule is applied.
      String id()
      Gets the id property: Fully qualified resource Id for the resource.
      String idPropertiesId()
      Gets the idPropertiesId property: The rule Id.
      DataMaskingRuleInner innerModel()
      Gets the inner com.azure.resourcemanager.synapse.fluent.models.DataMaskingRuleInner object.
      String kind()
      Gets the kind property: The kind of Data Masking Rule.
      String location()
      Gets the location property: The location of the data masking rule.
      DataMaskingFunction maskingFunction()
      Gets the maskingFunction property: The masking function that is used for the data masking rule.
      String name()
      Gets the name property: The name of the resource.
      String numberFrom()
      Gets the numberFrom property: The numberFrom property of the masking rule.
      String numberTo()
      Gets the numberTo property: The numberTo property of the data masking rule.
      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.
      DataMaskingRule refresh()
      Refreshes the resource to sync with Azure.
      DataMaskingRule refresh​(com.azure.core.util.Context context)
      Refreshes the resource to sync with Azure.
      com.azure.core.management.Region region()
      Gets the region of the resource.
      String regionName()
      Gets the name of the resource region.
      String replacementString()
      Gets the replacementString property: If maskingFunction is set to Text, the character to use for masking the unexposed part of the string.
      DataMaskingRuleState ruleState()
      Gets the ruleState property: The rule state.
      String schemaName()
      Gets the schemaName property: The schema name on which the data masking rule is applied.
      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.
      String tableName()
      Gets the tableName property: The table name on which the data masking rule is applied.
      String type()
      Gets the type property: The type of the resource.
      DataMaskingRule.Update update()
      Begins update for the DataMaskingRule resource.

    • Method Detail

      • id

        String id()
        Gets the id property: Fully qualified resource Id for the resource.
        Returns:
        the id value.

      • name

        String name()
        Gets the name property: The name of the resource.
        Returns:
        the name value.

      • type

        String type()
        Gets the type property: The type of the resource.
        Returns:
        the type value.

      • location

        String location()
        Gets the location property: The location of the data masking rule.
        Returns:
        the location value.

      • kind

        String kind()
        Gets the kind property: The kind of Data Masking Rule. Metadata, used for Azure portal.
        Returns:
        the kind value.

      • idPropertiesId

        String idPropertiesId()
        Gets the idPropertiesId property: The rule Id.
        Returns:
        the idPropertiesId value.

      • aliasName

        String aliasName()
        Gets the aliasName property: The alias name. This is a legacy parameter and is no longer used.
        Returns:
        the aliasName value.

      • ruleState

        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

        String schemaName()
        Gets the schemaName property: The schema name on which the data masking rule is applied.
        Returns:
        the schemaName value.

      • tableName

        String tableName()
        Gets the tableName property: The table name on which the data masking rule is applied.
        Returns:
        the tableName value.

      • columnName

        String columnName()
        Gets the columnName property: The column name on which the data masking rule is applied.
        Returns:
        the columnName value.

      • maskingFunction

        DataMaskingFunction maskingFunction()
        Gets the maskingFunction property: The masking function that is used for the data masking rule.
        Returns:
        the maskingFunction value.

      • numberFrom

        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

        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

        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.

      • suffixSize

        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.

      • replacementString

        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.

      • region

        com.azure.core.management.Region region()
        Gets the region of the resource.
        Returns:
        the region of the resource.

      • regionName

        String regionName()
        Gets the name of the resource region.
        Returns:
        the name of the resource region.

      • innerModel

        DataMaskingRuleInner innerModel()
        Gets the inner com.azure.resourcemanager.synapse.fluent.models.DataMaskingRuleInner object.
        Returns:
        the inner object.

      • update

        DataMaskingRule.Update update()
        Begins update for the DataMaskingRule resource.
        Returns:
        the stage of resource update.

      • refresh

        DataMaskingRule refresh()
        Refreshes the resource to sync with Azure.
        Returns:
        the refreshed resource.

      • refresh

        DataMaskingRule refresh​(com.azure.core.util.Context context)
        Refreshes the resource to sync with Azure.
        Parameters:
        context - The context to associate with this operation.
        Returns:
        the refreshed resource.