Class: Azure::Security::Mgmt::V2019_01_01::Models::Alert

Inherits:
Resource
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-01-01/generated/azure_mgmt_security/models/alert.rb

Overview

Security alert

Instance Attribute Summary collapse

Attributes inherited from Resource

#id, #name, #type

Class Method Summary collapse

Methods inherited from Resource

#resource_group

Instance Attribute Details

#action_taken ⇒ String

(Active, Blocked etc.)

Returns:

  • (String) —

    The action that was taken as a response to the alert



42
43
44
 
# File 'lib/2019-01-01/generated/azure_mgmt_security/models/alert.rb', line 42

def action_taken
  @action_taken
end

#alert_display_name ⇒ String

Returns Display name of the alert type.

Returns:

  • (String) —

    Display name of the alert type



29
30
31
 
# File 'lib/2019-01-01/generated/azure_mgmt_security/models/alert.rb', line 29

def alert_display_name
  @alert_display_name
end

#alert_name ⇒ String

Returns Name of the alert type.

Returns:

  • (String) —

    Name of the alert type



26
27
28
 
# File 'lib/2019-01-01/generated/azure_mgmt_security/models/alert.rb', line 26

def alert_name
  @alert_name
end

#associated_resource ⇒ String

Returns Azure resource ID of the associated resource.

Returns:

  • (String) —

    Azure resource ID of the associated resource



52
53
54
 
# File 'lib/2019-01-01/generated/azure_mgmt_security/models/alert.rb', line 52

def associated_resource
  @associated_resource
end

#can_be_investigated ⇒ Boolean

Security Center

Returns:

  • (Boolean) —

    Whether this alert can be investigated with Azure



62
63
64
 
# File 'lib/2019-01-01/generated/azure_mgmt_security/models/alert.rb', line 62

def can_be_investigated
  @can_be_investigated
end

#compromised_entity ⇒ String

Returns The entity that the incident happened on.

Returns:

  • (String) —

    The entity that the incident happened on



49
50
51
 
# File 'lib/2019-01-01/generated/azure_mgmt_security/models/alert.rb', line 49

def compromised_entity
  @compromised_entity
end

#confidence_reasons ⇒ Array<AlertConfidenceReason>

confidenceScore value

Returns:



76
77
78
 
# File 'lib/2019-01-01/generated/azure_mgmt_security/models/alert.rb', line 76

def confidence_reasons
  @confidence_reasons
end

#confidence_score ⇒ Float

Returns level of confidence we have on the alert.

Returns:

  • (Float) —

    level of confidence we have on the alert



72
73
74
 
# File 'lib/2019-01-01/generated/azure_mgmt_security/models/alert.rb', line 72

def confidence_score
  @confidence_score
end

#correlation_key ⇒ String

together in Ibiza.

Returns:

  • (String) —

    Alerts with the same CorrelationKey will be grouped



92
93
94
 
# File 'lib/2019-01-01/generated/azure_mgmt_security/models/alert.rb', line 92

def correlation_key
  @correlation_key
end

#description ⇒ String

Returns Description of the incident and what it means.

Returns:

  • (String) —

    Description of the incident and what it means



35
36
37
 
# File 'lib/2019-01-01/generated/azure_mgmt_security/models/alert.rb', line 35

def description
  @description
end

#detected_time_utc ⇒ DateTime

Returns The time the incident was detected by the vendor.

Returns:

  • (DateTime) —

    The time the incident was detected by the vendor



32
33
34
 
# File 'lib/2019-01-01/generated/azure_mgmt_security/models/alert.rb', line 32

def detected_time_utc
  @detected_time_utc
end

#entities ⇒ Array<AlertEntity>

Returns objects that are related to this alerts.

Returns:

  • (Array<AlertEntity>) —

    objects that are related to this alerts



69
70
71
 
# File 'lib/2019-01-01/generated/azure_mgmt_security/models/alert.rb', line 69

def entities
  @entities
end

#extended_properties ⇒ Object

Returns:



55
56
57
 
# File 'lib/2019-01-01/generated/azure_mgmt_security/models/alert.rb', line 55

def extended_properties
  @extended_properties
end

#instance_id ⇒ String

Returns Instance ID of the alert.

Returns:

  • (String) —

    Instance ID of the alert.



84
85
86
 
# File 'lib/2019-01-01/generated/azure_mgmt_security/models/alert.rb', line 84

def instance_id
  @instance_id
end

#is_incident ⇒ Boolean

(otherwise - single alert)

Returns:

  • (Boolean) —

    Whether this alert is for incident type or not



66
67
68
 
# File 'lib/2019-01-01/generated/azure_mgmt_security/models/alert.rb', line 66

def is_incident
  @is_incident
end

#remediation_steps ⇒ String

Returns Recommended steps to reradiate the incident.

Returns:

  • (String) —

    Recommended steps to reradiate the incident



38
39
40
 
# File 'lib/2019-01-01/generated/azure_mgmt_security/models/alert.rb', line 38

def remediation_steps
  @remediation_steps
end

#reported_severity ⇒ ReportedSeverity

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

Returns:



46
47
48
 
# File 'lib/2019-01-01/generated/azure_mgmt_security/models/alert.rb', line 46

def reported_severity
  @reported_severity
end

#reported_time_utc ⇒ DateTime

Microsoft.Security in UTC

Returns:

  • (DateTime) —

    The time the incident was reported to



20
21
22
 
# File 'lib/2019-01-01/generated/azure_mgmt_security/models/alert.rb', line 20

def reported_time_utc
  @reported_time_utc
end

#state ⇒ String

Returns State of the alert (Active, Dismissed etc.).

Returns:

  • (String) —

    State of the alert (Active, Dismissed etc.)



16
17
18
 
# File 'lib/2019-01-01/generated/azure_mgmt_security/models/alert.rb', line 16

def state
  @state
end

#subscription_id ⇒ String

security alert or the subscription ID of the workspace that this resource reports to

Returns:

  • (String) —

    Azure subscription ID of the resource that had the



81
82
83
 
# File 'lib/2019-01-01/generated/azure_mgmt_security/models/alert.rb', line 81

def subscription_id
  @subscription_id
end

#system_source ⇒ String

Returns The type of the alerted resource (Azure, Non-Azure).

Returns:

  • (String) —

    The type of the alerted resource (Azure, Non-Azure)



58
59
60
 
# File 'lib/2019-01-01/generated/azure_mgmt_security/models/alert.rb', line 58

def system_source
  @system_source
end

#vendor_name ⇒ String

Returns Name of the vendor that discovered the incident.

Returns:

  • (String) —

    Name of the vendor that discovered the incident



23
24
25
 
# File 'lib/2019-01-01/generated/azure_mgmt_security/models/alert.rb', line 23

def vendor_name
  @vendor_name
end

#workspace_arm_id ⇒ String

reported to.

Returns:

  • (String) —

    Azure resource ID of the workspace that the alert was



88
89
90
 
# File 'lib/2019-01-01/generated/azure_mgmt_security/models/alert.rb', line 88

def workspace_arm_id
  @workspace_arm_id
end

Class Method Details

.mapper ⇒ Object

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



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
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
 
# File 'lib/2019-01-01/generated/azure_mgmt_security/models/alert.rb', line 99

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'Alert',
    type: {
      name: 'Composite',
      class_name: 'Alert',
      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'
          }
        },
        state: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.state',
          type: {
            name: 'String'
          }
        },
        reported_time_utc: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.reportedTimeUtc',
          type: {
            name: 'DateTime'
          }
        },
        vendor_name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.vendorName',
          type: {
            name: 'String'
          }
        },
        alert_name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.alertName',
          type: {
            name: 'String'
          }
        },
        alert_display_name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.alertDisplayName',
          type: {
            name: 'String'
          }
        },
        detected_time_utc: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.detectedTimeUtc',
          type: {
            name: 'DateTime'
          }
        },
        description: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.description',
          type: {
            name: 'String'
          }
        },
        remediation_steps: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.remediationSteps',
          type: {
            name: 'String'
          }
        },
        action_taken: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.actionTaken',
          type: {
            name: 'String'
          }
        },
        reported_severity: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.reportedSeverity',
          type: {
            name: 'String'
          }
        },
        compromised_entity: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.compromisedEntity',
          type: {
            name: 'String'
          }
        },
        associated_resource: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.associatedResource',
          type: {
            name: 'String'
          }
        },
        extended_properties: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.extendedProperties',
          type: {
            name: 'Dictionary',
            value: {
                client_side_validation: true,
                required: false,
                serialized_name: 'ObjectElementType',
                type: {
                  name: 'Object'
                }
            }
          }
        },
        system_source: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.systemSource',
          type: {
            name: 'String'
          }
        },
        can_be_investigated: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.canBeInvestigated',
          type: {
            name: 'Boolean'
          }
        },
        is_incident: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.isIncident',
          type: {
            name: 'Boolean'
          }
        },
        entities: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.entities',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'AlertEntityElementType',
                type: {
                  name: 'Composite',
                  class_name: 'AlertEntity'
                }
            }
          }
        },
        confidence_score: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.confidenceScore',
          constraints: {
            InclusiveMaximum: 1,
            InclusiveMinimum: 0
          },
          type: {
            name: 'Double'
          }
        },
        confidence_reasons: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.confidenceReasons',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'AlertConfidenceReasonElementType',
                type: {
                  name: 'Composite',
                  class_name: 'AlertConfidenceReason'
                }
            }
          }
        },
        subscription_id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.subscriptionId',
          type: {
            name: 'String'
          }
        },
        instance_id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.instanceId',
          type: {
            name: 'String'
          }
        },
        workspace_arm_id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.workspaceArmId',
          type: {
            name: 'String'
          }
        },
        correlation_key: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.correlationKey',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end