Class: Azure::ARM::SQL::Models::DataMaskingRule

Inherits:
ProxyResource
  • Object
show all
Includes:
MsRest::JSONable, MsRestAzure
Defined in:
lib/generated/azure_mgmt_sql/models/data_masking_rule.rb

Overview

Represents a database data masking rule.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#alias_name ⇒ String

longer used.

Returns:

  • (String) —

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



21
22
23
 
# File 'lib/generated/azure_mgmt_sql/models/data_masking_rule.rb', line 21

def alias_name
  @alias_name
end

#column_name ⇒ String

applied.

Returns:

  • (String) —

    The column name on which the data masking rule is



41
42
43
 
# File 'lib/generated/azure_mgmt_sql/models/data_masking_rule.rb', line 41

def column_name
  @column_name
end

#data_masking_rule_id ⇒ String

Returns The rule Id.

Returns:

  • (String) —

    The rule Id.



17
18
19
 
# File 'lib/generated/azure_mgmt_sql/models/data_masking_rule.rb', line 17

def data_masking_rule_id
  @data_masking_rule_id
end

#kind ⇒ String

Azure portal.

Returns:

  • (String) —

    The kind of Data Masking Rule. Metadata, used for



78
79
80
 
# File 'lib/generated/azure_mgmt_sql/models/data_masking_rule.rb', line 78

def kind
  @kind
end

#location ⇒ String

Returns The location of the data masking rule.

Returns:

  • (String) —

    The location of the data masking rule.



74
75
76
 
# File 'lib/generated/azure_mgmt_sql/models/data_masking_rule.rb', line 74

def location
  @location
end

#masking_function ⇒ DataMaskingFunction

data masking rule. Possible values include: ‘Default’, ‘CCN’, ‘Email’, ‘Number’, ‘SSN’, ‘Text’

Returns:



46
47
48
 
# File 'lib/generated/azure_mgmt_sql/models/data_masking_rule.rb', line 46

def masking_function
  @masking_function
end

#number_from ⇒ String

if maskingFunction is set to Number, otherwise this parameter will be ignored.

Returns:

  • (String) —

    The numberFrom property of the masking rule. Required



51
52
53
 
# File 'lib/generated/azure_mgmt_sql/models/data_masking_rule.rb', line 51

def number_from
  @number_from
end

#number_to ⇒ String

Required if maskingFunction is set to Number, otherwise this parameter will be ignored.

Returns:

  • (String) —

    The numberTo property of the data masking rule.



56
57
58
 
# File 'lib/generated/azure_mgmt_sql/models/data_masking_rule.rb', line 56

def number_to
  @number_to
end

#prefix_size ⇒ String

characters to show unmasked in the beginning of the string. Otherwise, this parameter will be ignored.

Returns:

  • (String) —

    If maskingFunction is set to Text, the number of



61
62
63
 
# File 'lib/generated/azure_mgmt_sql/models/data_masking_rule.rb', line 61

def prefix_size
  @prefix_size
end

#replacement_string ⇒ String

use for masking the unexposed part of the string. Otherwise, this parameter will be ignored.

Returns:

  • (String) —

    If maskingFunction is set to Text, the character to



71
72
73
 
# File 'lib/generated/azure_mgmt_sql/models/data_masking_rule.rb', line 71

def replacement_string
  @replacement_string
end

#rule_state ⇒ DataMaskingRuleState

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. Possible values include: ‘Disabled’, ‘Enabled’

Returns:



29
30
31
 
# File 'lib/generated/azure_mgmt_sql/models/data_masking_rule.rb', line 29

def rule_state
  @rule_state
end

#schema_name ⇒ String

applied.

Returns:

  • (String) —

    The schema name on which the data masking rule is



33
34
35
 
# File 'lib/generated/azure_mgmt_sql/models/data_masking_rule.rb', line 33

def schema_name
  @schema_name
end

#suffix_size ⇒ String

characters to show unmasked at the end of the string. Otherwise, this parameter will be ignored.

Returns:

  • (String) —

    If maskingFunction is set to Text, the number of



66
67
68
 
# File 'lib/generated/azure_mgmt_sql/models/data_masking_rule.rb', line 66

def suffix_size
  @suffix_size
end

#table_name ⇒ String

applied.

Returns:

  • (String) —

    The table name on which the data masking rule is



37
38
39
 
# File 'lib/generated/azure_mgmt_sql/models/data_masking_rule.rb', line 37

def table_name
  @table_name
end

Class Method Details

.mapper ⇒ Object

Mapper for DataMaskingRule class as Ruby Hash. This will be used for serialization/deserialization.



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/generated/azure_mgmt_sql/models/data_masking_rule.rb', line 85

def self.mapper()
  {
    required: false,
    serialized_name: 'DataMaskingRule',
    type: {
      name: 'Composite',
      class_name: 'DataMaskingRule',
      model_properties: {
        id: {
          required: false,
          read_only: true,
          serialized_name: 'id',
          type: {
            name: 'String'
          }
        },
        name: {
          required: false,
          read_only: true,
          serialized_name: 'name',
          type: {
            name: 'String'
          }
        },
        type: {
          required: false,
          read_only: true,
          serialized_name: 'type',
          type: {
            name: 'String'
          }
        },
        data_masking_rule_id: {
          required: false,
          read_only: true,
          serialized_name: 'properties.id',
          type: {
            name: 'String'
          }
        },
        alias_name: {
          required: false,
          serialized_name: 'properties.aliasName',
          type: {
            name: 'String'
          }
        },
        rule_state: {
          required: false,
          serialized_name: 'properties.ruleState',
          type: {
            name: 'Enum',
            module: 'DataMaskingRuleState'
          }
        },
        schema_name: {
          required: true,
          serialized_name: 'properties.schemaName',
          type: {
            name: 'String'
          }
        },
        table_name: {
          required: true,
          serialized_name: 'properties.tableName',
          type: {
            name: 'String'
          }
        },
        column_name: {
          required: true,
          serialized_name: 'properties.columnName',
          type: {
            name: 'String'
          }
        },
        masking_function: {
          required: true,
          serialized_name: 'properties.maskingFunction',
          type: {
            name: 'Enum',
            module: 'DataMaskingFunction'
          }
        },
        number_from: {
          required: false,
          serialized_name: 'properties.numberFrom',
          type: {
            name: 'String'
          }
        },
        number_to: {
          required: false,
          serialized_name: 'properties.numberTo',
          type: {
            name: 'String'
          }
        },
        prefix_size: {
          required: false,
          serialized_name: 'properties.prefixSize',
          type: {
            name: 'String'
          }
        },
        suffix_size: {
          required: false,
          serialized_name: 'properties.suffixSize',
          type: {
            name: 'String'
          }
        },
        replacement_string: {
          required: false,
          serialized_name: 'properties.replacementString',
          type: {
            name: 'String'
          }
        },
        location: {
          required: false,
          read_only: true,
          serialized_name: 'location',
          type: {
            name: 'String'
          }
        },
        kind: {
          required: false,
          read_only: true,
          serialized_name: 'kind',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end