Class: Azure::SecurityInsights::Mgmt::V2019_01_01_preview::Models::ScheduledAlertRule

Inherits:
AlertRule
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-01-01-preview/generated/azure_mgmt_security_insights/models/scheduled_alert_rule.rb

Overview

Represents scheduled alert rule.

Instance Attribute Summary collapse

Attributes inherited from AlertRule

#etag, #id, #name, #type

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ ScheduledAlertRule

Returns a new instance of ScheduledAlertRule.



16
17
18
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/models/scheduled_alert_rule.rb', line 16

def initialize
  @kind = "Scheduled"
end

Instance Attribute Details

#alert_rule_template_name ⇒ String

this rule.

Returns:

  • (String) —

    The Name of the alert rule template used to create



50
51
52
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/models/scheduled_alert_rule.rb', line 50

def alert_rule_template_name
  @alert_rule_template_name
end

#description ⇒ String

Returns The description of the alert rule.

Returns:

  • (String) —

    The description of the alert rule.



53
54
55
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/models/scheduled_alert_rule.rb', line 53

def description
  @description
end

#display_name ⇒ String

rule.

Returns:

  • (String) —

    The display name for alerts created by this alert



57
58
59
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/models/scheduled_alert_rule.rb', line 57

def display_name
  @display_name
end

#enabled ⇒ Boolean

disabled.

Returns:

  • (Boolean) —

    Determines whether this alert rule is enabled or



61
62
63
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/models/scheduled_alert_rule.rb', line 61

def enabled
  @enabled
end

#event_grouping_settings ⇒ EventGroupingSettings

Returns The event grouping settings.

Returns:



46
47
48
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/models/scheduled_alert_rule.rb', line 46

def event_grouping_settings
  @event_grouping_settings
end

#incident_configuration ⇒ IncidentConfiguration

created from alerts triggered by this analytics rule

Returns:



80
81
82
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/models/scheduled_alert_rule.rb', line 80

def incident_configuration
  @incident_configuration
end

#kind ⇒ Object

Returns the value of attribute kind.



20
21
22
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/models/scheduled_alert_rule.rb', line 20

def kind
  @kind
end

#last_modified_utc ⇒ DateTime

modified.

Returns:

  • (DateTime) —

    The last time that this alert rule has been



65
66
67
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/models/scheduled_alert_rule.rb', line 65

def last_modified_utc
  @last_modified_utc
end

#query ⇒ String

Returns The query that creates alerts for this rule.

Returns:

  • (String) —

    The query that creates alerts for this rule.



23
24
25
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/models/scheduled_alert_rule.rb', line 23

def query
  @query
end

#query_frequency ⇒ Duration

alert rule to run.

Returns:

  • (Duration) —

    The frequency (in ISO 8601 duration format) for this



27
28
29
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/models/scheduled_alert_rule.rb', line 27

def query_frequency
  @query_frequency
end

#query_period ⇒ Duration

alert rule looks at.

Returns:

  • (Duration) —

    The period (in ISO 8601 duration format) that this



31
32
33
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/models/scheduled_alert_rule.rb', line 31

def query_period
  @query_period
end

#severity ⇒ AlertSeverity

rule. Possible values include: ‘High’, ‘Medium’, ‘Low’, ‘Informational’

Returns:

  • (AlertSeverity) —

    The severity for alerts created by this alert



35
36
37
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/models/scheduled_alert_rule.rb', line 35

def severity
  @severity
end

#suppression_duration ⇒ Duration

wait since last time this alert rule been triggered.

Returns:

  • (Duration) —

    The suppression (in ISO 8601 duration format) to



69
70
71
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/models/scheduled_alert_rule.rb', line 69

def suppression_duration
  @suppression_duration
end

#suppression_enabled ⇒ Boolean

rule is enabled or disabled.

Returns:

  • (Boolean) —

    Determines whether the suppression for this alert



73
74
75
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/models/scheduled_alert_rule.rb', line 73

def suppression_enabled
  @suppression_enabled
end

#tactics ⇒ Array<AttackTactic>

Returns The tactics of the alert rule.

Returns:



76
77
78
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/models/scheduled_alert_rule.rb', line 76

def tactics
  @tactics
end

#trigger_operator ⇒ TriggerOperator

triggers alert rule. Possible values include: ‘GreaterThan’, ‘LessThan’, ‘Equal’, ‘NotEqual’

Returns:



40
41
42
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/models/scheduled_alert_rule.rb', line 40

def trigger_operator
  @trigger_operator
end

#trigger_threshold ⇒ Integer

Returns The threshold triggers this alert rule.

Returns:

  • (Integer) —

    The threshold triggers this alert rule.



43
44
45
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/models/scheduled_alert_rule.rb', line 43

def trigger_threshold
  @trigger_threshold
end

Class Method Details

.mapper ⇒ Object

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



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
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/models/scheduled_alert_rule.rb', line 87

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'Scheduled',
    type: {
      name: 'Composite',
      class_name: 'ScheduledAlertRule',
      model_properties: {
        id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'id',
          type: {
            name: 'String'
          }
        },
        name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'name',
          type: {
            name: 'String'
          }
        },
        type: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'type',
          type: {
            name: 'String'
          }
        },
        etag: {
          client_side_validation: true,
          required: false,
          serialized_name: 'etag',
          type: {
            name: 'String'
          }
        },
        kind: {
          client_side_validation: true,
          required: true,
          serialized_name: 'kind',
          type: {
            name: 'String'
          }
        },
        query: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.query',
          type: {
            name: 'String'
          }
        },
        query_frequency: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.queryFrequency',
          type: {
            name: 'TimeSpan'
          }
        },
        query_period: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.queryPeriod',
          type: {
            name: 'TimeSpan'
          }
        },
        severity: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.severity',
          type: {
            name: 'String'
          }
        },
        trigger_operator: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.triggerOperator',
          type: {
            name: 'Enum',
            module: 'TriggerOperator'
          }
        },
        trigger_threshold: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.triggerThreshold',
          type: {
            name: 'Number'
          }
        },
        event_grouping_settings: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.eventGroupingSettings',
          type: {
            name: 'Composite',
            class_name: 'EventGroupingSettings'
          }
        },
        alert_rule_template_name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.alertRuleTemplateName',
          type: {
            name: 'String'
          }
        },
        description: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.description',
          type: {
            name: 'String'
          }
        },
        display_name: {
          client_side_validation: true,
          required: true,
          serialized_name: 'properties.displayName',
          type: {
            name: 'String'
          }
        },
        enabled: {
          client_side_validation: true,
          required: true,
          serialized_name: 'properties.enabled',
          type: {
            name: 'Boolean'
          }
        },
        last_modified_utc: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.lastModifiedUtc',
          type: {
            name: 'DateTime'
          }
        },
        suppression_duration: {
          client_side_validation: true,
          required: true,
          serialized_name: 'properties.suppressionDuration',
          type: {
            name: 'TimeSpan'
          }
        },
        suppression_enabled: {
          client_side_validation: true,
          required: true,
          serialized_name: 'properties.suppressionEnabled',
          type: {
            name: 'Boolean'
          }
        },
        tactics: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.tactics',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'AttackTacticElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        incident_configuration: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.incidentConfiguration',
          type: {
            name: 'Composite',
            class_name: 'IncidentConfiguration'
          }
        }
      }
    }
  }
end