Class: Azure::SecurityInsights::Mgmt::V2019_01_01_preview::Models::SecurityAlert

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

Overview

Represents a security alert entity.

Instance Attribute Summary collapse

Attributes inherited from Entity

#id, #name, #type

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ SecurityAlert

Returns a new instance of SecurityAlert.



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

def initialize
  @kind = "SecurityAlert"
end

Instance Attribute Details

#additional_data ⇒ Object

will be presented to the user.

Returns:

  • A bag of custom fields that should be part of the entity and



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

def additional_data
  @additional_data
end

#alert_display_name ⇒ String

Returns The display name of the alert.

Returns:

  • (String) —

    The display name of the alert.



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

def alert_display_name
  @alert_display_name
end

#alert_link ⇒ String

Returns The uri link of the alert.

Returns:

  • (String) —

    The uri link of the alert.



119
120
121
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/models/security_alert.rb', line 119

def alert_link
  @alert_link
end

#alert_type ⇒ String

Returns The type name of the alert.

Returns:

  • (String) —

    The type name of the alert.



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

def alert_type
  @alert_type
end

#compromised_entity ⇒ String

Returns Display name of the main entity being reported on.

Returns:

  • (String) —

    Display name of the main entity being reported on.



38
39
40
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/models/security_alert.rb', line 38

def compromised_entity
  @compromised_entity
end

#confidence_level ⇒ ConfidenceLevel

values include: ‘Unknown’, ‘Low’, ‘High’

Returns:



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

def confidence_level
  @confidence_level
end

#confidence_reasons ⇒ Array<SecurityAlertPropertiesConfidenceReasonsItem>

confidence reasons

Returns:



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

def confidence_reasons
  @confidence_reasons
end

#confidence_score ⇒ Float

Returns The confidence score of the alert.

Returns:

  • (Float) —

    The confidence score of the alert.



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

def confidence_score
  @confidence_score
end

#confidence_score_status ⇒ ConfidenceScoreStatus

status, i.e. indicating if score calculation is pending for this alert, not applicable or final. Possible values include: ‘NotApplicable’, ‘InProcess’, ‘NotFinal’, ‘Final’

Returns:



55
56
57
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/models/security_alert.rb', line 55

def confidence_score_status
  @confidence_score_status
end

#description ⇒ String

Returns Alert description.

Returns:

  • (String) —

    Alert description.



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

def description
  @description
end

#end_time_utc ⇒ DateTime

last event contributing to the alert).

Returns:

  • (DateTime) —

    The impact end time of the alert (the time of the



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

def end_time_utc
  @end_time_utc
end

#friendly_name ⇒ String

readable description of the graph item instance. This property is optional and might be system generated.

Returns:

  • (String) —

    The graph item display name which is a short humanly



29
30
31
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/models/security_alert.rb', line 29

def friendly_name
  @friendly_name
end

#intent ⇒ KillChainIntent

this alert. Possible values include: ‘Unknown’, ‘Probing’, ‘Exploitation’, ‘Persistence’, ‘PrivilegeEscalation’, ‘DefenseEvasion’, ‘CredentialAccess’, ‘Discovery’, ‘LateralMovement’, ‘Execution’, ‘Collection’, ‘Exfiltration’, ‘CommandAndControl’, ‘Impact’

Returns:



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

def intent
  @intent
end

#kind ⇒ Object

Returns the value of attribute kind.



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

def kind
  @kind
end

#processing_end_time ⇒ DateTime

consumption.

Returns:

  • (DateTime) —

    The time the alert was made available for



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

def processing_end_time
  @processing_end_time
end

#product_component_name ⇒ String

generated the alert.

Returns:

  • (String) —

    The name of a component inside the product which



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

def product_component_name
  @product_component_name
end

#product_name ⇒ String

Returns The name of the product which published this alert.

Returns:

  • (String) —

    The name of the product which published this alert.



84
85
86
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/models/security_alert.rb', line 84

def product_name
  @product_name
end

#product_version ⇒ String

Returns The version of the product generating the alert.

Returns:

  • (String) —

    The version of the product generating the alert.



87
88
89
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/models/security_alert.rb', line 87

def product_version
  @product_version
end

#provider_alert_id ⇒ String

generated the alert.

Returns:

  • (String) —

    The identifier of the alert inside the product which



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

def provider_alert_id
  @provider_alert_id
end

#remediation_steps ⇒ Array<String>

alert.

Returns:

  • (Array<String>) —

    Manual action items to take to remediate the



91
92
93
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/models/security_alert.rb', line 91

def remediation_steps
  @remediation_steps
end

#resource_identifiers ⇒ Object

Returns The list of resource identifiers of the alert.

Returns:

  • The list of resource identifiers of the alert.



122
123
124
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/models/security_alert.rb', line 122

def resource_identifiers
  @resource_identifiers
end

#severity ⇒ AlertSeverity

include: ‘High’, ‘Medium’, ‘Low’, ‘Informational’

Returns:



95
96
97
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/models/security_alert.rb', line 95

def severity
  @severity
end

#start_time_utc ⇒ DateTime

first event contributing to the alert).

Returns:

  • (DateTime) —

    The impact start time of the alert (the time of the



99
100
101
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/models/security_alert.rb', line 99

def start_time_utc
  @start_time_utc
end

#status ⇒ AlertStatus

values include: ‘Unknown’, ‘New’, ‘Resolved’, ‘Dismissed’, ‘InProgress’

Returns:

  • (AlertStatus) —

    The lifecycle status of the alert. Possible



103
104
105
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/models/security_alert.rb', line 103

def status
  @status
end

#system_alert_id ⇒ String

product.

Returns:

  • (String) —

    Holds the product identifier of the alert for the



107
108
109
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/models/security_alert.rb', line 107

def system_alert_id
  @system_alert_id
end

#tactics ⇒ Array<AttackTactic>

Returns The tactics of the alert.

Returns:



110
111
112
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/models/security_alert.rb', line 110

def tactics
  @tactics
end

#time_generated ⇒ DateTime

Returns The time the alert was generated.

Returns:

  • (DateTime) —

    The time the alert was generated.



113
114
115
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/models/security_alert.rb', line 113

def time_generated
  @time_generated
end

#vendor_name ⇒ String

Returns The name of the vendor that raise the alert.

Returns:

  • (String) —

    The name of the vendor that raise the alert.



116
117
118
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/models/security_alert.rb', line 116

def vendor_name
  @vendor_name
end

Class Method Details

.mapper ⇒ Object

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



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
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/models/security_alert.rb', line 129

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'SecurityAlert',
    type: {
      name: 'Composite',
      class_name: 'SecurityAlert',
      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'
          }
        },
        kind: {
          client_side_validation: true,
          required: true,
          serialized_name: 'kind',
          type: {
            name: 'String'
          }
        },
        additional_data: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.additionalData',
          type: {
            name: 'Dictionary',
            value: {
                client_side_validation: true,
                required: false,
                serialized_name: 'ObjectElementType',
                type: {
                  name: 'Object'
                }
            }
          }
        },
        friendly_name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.friendlyName',
          type: {
            name: 'String'
          }
        },
        alert_display_name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.alertDisplayName',
          type: {
            name: 'String'
          }
        },
        alert_type: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.alertType',
          type: {
            name: 'String'
          }
        },
        compromised_entity: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.compromisedEntity',
          type: {
            name: 'String'
          }
        },
        confidence_level: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.confidenceLevel',
          type: {
            name: 'String'
          }
        },
        confidence_reasons: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.confidenceReasons',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'SecurityAlertPropertiesConfidenceReasonsItemElementType',
                type: {
                  name: 'Composite',
                  class_name: 'SecurityAlertPropertiesConfidenceReasonsItem'
                }
            }
          }
        },
        confidence_score: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.confidenceScore',
          type: {
            name: 'Double'
          }
        },
        confidence_score_status: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.confidenceScoreStatus',
          type: {
            name: 'String'
          }
        },
        description: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.description',
          type: {
            name: 'String'
          }
        },
        end_time_utc: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.endTimeUtc',
          type: {
            name: 'DateTime'
          }
        },
        intent: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.intent',
          type: {
            name: 'String'
          }
        },
        provider_alert_id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.providerAlertId',
          type: {
            name: 'String'
          }
        },
        processing_end_time: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.processingEndTime',
          type: {
            name: 'DateTime'
          }
        },
        product_component_name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.productComponentName',
          type: {
            name: 'String'
          }
        },
        product_name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.productName',
          type: {
            name: 'String'
          }
        },
        product_version: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.productVersion',
          type: {
            name: 'String'
          }
        },
        remediation_steps: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.remediationSteps',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        severity: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.severity',
          type: {
            name: 'String'
          }
        },
        start_time_utc: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.startTimeUtc',
          type: {
            name: 'DateTime'
          }
        },
        status: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.status',
          type: {
            name: 'String'
          }
        },
        system_alert_id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.systemAlertId',
          type: {
            name: 'String'
          }
        },
        tactics: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.tactics',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'AttackTacticElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        time_generated: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.timeGenerated',
          type: {
            name: 'DateTime'
          }
        },
        vendor_name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.vendorName',
          type: {
            name: 'String'
          }
        },
        alert_link: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.alertLink',
          type: {
            name: 'String'
          }
        },
        resource_identifiers: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.resourceIdentifiers',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'ObjectElementType',
                type: {
                  name: 'Object'
                }
            }
          }
        }
      }
    }
  }
end