Class: MicrosoftGraph::Models::Alert

Inherits:
Entity
  • Object
show all
Includes:
MicrosoftKiotaAbstractions::Parsable
Defined in:
lib/models/alert.rb

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Entity

#additional_data, #additional_data=, #id, #id=, #odata_type, #odata_type=

Constructor Details

#initializeObject

Instantiates a new alert and sets the default values.



281
282
283
# File 'lib/models/alert.rb', line 281

def initialize()
    super
end

Class Method Details

.create_from_discriminator_value(parse_node) ⇒ Object

Creates a new instance of the appropriate class based on discriminator value

Parameters:

  • parse_node

    The parse node to use to read the discriminator value and create the object

Returns:

  • a alert

Raises:

  • (StandardError)


304
305
306
307
# File 'lib/models/alert.rb', line 304

def self.create_from_discriminator_value(parse_node)
    raise StandardError, 'parse_node cannot be null' if parse_node.nil?
    return Alert.new
end

Instance Method Details

#activity_group_nameObject

Gets the activityGroupName property value. Name or alias of the activity group (attacker) this alert is attributed to.

Returns:

  • a string



131
132
133
# File 'lib/models/alert.rb', line 131

def activity_group_name
    return @activity_group_name
end

#activity_group_name=(value) ⇒ Object

Sets the activityGroupName property value. Name or alias of the activity group (attacker) this alert is attributed to.

Parameters:

  • value

    Value to set for the activityGroupName property.

Returns:

  • a void



139
140
141
# File 'lib/models/alert.rb', line 139

def activity_group_name=(value)
    @activity_group_name = value
end

#alert_detectionsObject

Gets the alertDetections property value. The alertDetections property

Returns:

  • a alert_detection



146
147
148
# File 'lib/models/alert.rb', line 146

def alert_detections
    return @alert_detections
end

#alert_detections=(value) ⇒ Object

Sets the alertDetections property value. The alertDetections property

Parameters:

  • value

    Value to set for the alertDetections property.

Returns:

  • a void



154
155
156
# File 'lib/models/alert.rb', line 154

def alert_detections=(value)
    @alert_detections = value
end

#assigned_toObject

Gets the assignedTo property value. Name of the analyst the alert is assigned to for triage, investigation, or remediation (supports update).

Returns:

  • a string



161
162
163
# File 'lib/models/alert.rb', line 161

def assigned_to
    return @assigned_to
end

#assigned_to=(value) ⇒ Object

Sets the assignedTo property value. Name of the analyst the alert is assigned to for triage, investigation, or remediation (supports update).

Parameters:

  • value

    Value to set for the assignedTo property.

Returns:

  • a void



169
170
171
# File 'lib/models/alert.rb', line 169

def assigned_to=(value)
    @assigned_to = value
end

#azure_subscription_idObject

Gets the azureSubscriptionId property value. Azure subscription ID, present if this alert is related to an Azure resource.

Returns:

  • a string



176
177
178
# File 'lib/models/alert.rb', line 176

def azure_subscription_id
    return @azure_subscription_id
end

#azure_subscription_id=(value) ⇒ Object

Sets the azureSubscriptionId property value. Azure subscription ID, present if this alert is related to an Azure resource.

Parameters:

  • value

    Value to set for the azureSubscriptionId property.

Returns:

  • a void



184
185
186
# File 'lib/models/alert.rb', line 184

def azure_subscription_id=(value)
    @azure_subscription_id = value
end

#azure_tenant_idObject

Gets the azureTenantId property value. Azure Active Directory tenant ID. Required.

Returns:

  • a string



191
192
193
# File 'lib/models/alert.rb', line 191

def azure_tenant_id
    return @azure_tenant_id
end

#azure_tenant_id=(value) ⇒ Object

Sets the azureTenantId property value. Azure Active Directory tenant ID. Required.

Parameters:

  • value

    Value to set for the azureTenantId property.

Returns:

  • a void



199
200
201
# File 'lib/models/alert.rb', line 199

def azure_tenant_id=(value)
    @azure_tenant_id = value
end

#categoryObject

Gets the category property value. Category of the alert (for example, credentialTheft, ransomware, etc.).

Returns:

  • a string



206
207
208
# File 'lib/models/alert.rb', line 206

def category
    return @category
end

#category=(value) ⇒ Object

Sets the category property value. Category of the alert (for example, credentialTheft, ransomware, etc.).

Parameters:

  • value

    Value to set for the category property.

Returns:

  • a void



214
215
216
# File 'lib/models/alert.rb', line 214

def category=(value)
    @category = value
end

#closed_date_timeObject

Gets the closedDateTime property value. Time at which the alert was closed. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z (supports update).

Returns:

  • a date_time



221
222
223
# File 'lib/models/alert.rb', line 221

def closed_date_time
    return @closed_date_time
end

#closed_date_time=(value) ⇒ Object

Sets the closedDateTime property value. Time at which the alert was closed. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z (supports update).

Parameters:

  • value

    Value to set for the closedDateTime property.

Returns:

  • a void



229
230
231
# File 'lib/models/alert.rb', line 229

def closed_date_time=(value)
    @closed_date_time = value
end

#cloud_app_statesObject

Gets the cloudAppStates property value. Security-related stateful information generated by the provider about the cloud application/s related to this alert.

Returns:

  • a cloud_app_security_state



236
237
238
# File 'lib/models/alert.rb', line 236

def cloud_app_states
    return @cloud_app_states
end

#cloud_app_states=(value) ⇒ Object

Sets the cloudAppStates property value. Security-related stateful information generated by the provider about the cloud application/s related to this alert.

Parameters:

  • value

    Value to set for the cloudAppStates property.

Returns:

  • a void



244
245
246
# File 'lib/models/alert.rb', line 244

def cloud_app_states=(value)
    @cloud_app_states = value
end

#commentsObject

Gets the comments property value. Customer-provided comments on alert (for customer alert management) (supports update).

Returns:

  • a string



251
252
253
# File 'lib/models/alert.rb', line 251

def comments
    return @comments
end

#comments=(value) ⇒ Object

Sets the comments property value. Customer-provided comments on alert (for customer alert management) (supports update).

Parameters:

  • value

    Value to set for the comments property.

Returns:

  • a void



259
260
261
# File 'lib/models/alert.rb', line 259

def comments=(value)
    @comments = value
end

#confidenceObject

Gets the confidence property value. Confidence of the detection logic (percentage between 1-100).

Returns:

  • a integer



266
267
268
# File 'lib/models/alert.rb', line 266

def confidence
    return @confidence
end

#confidence=(value) ⇒ Object

Sets the confidence property value. Confidence of the detection logic (percentage between 1-100).

Parameters:

  • value

    Value to set for the confidence property.

Returns:

  • a void



274
275
276
# File 'lib/models/alert.rb', line 274

def confidence=(value)
    @confidence = value
end

#created_date_timeObject

Gets the createdDateTime property value. Time at which the alert was created by the alert provider. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Required.

Returns:

  • a date_time



288
289
290
# File 'lib/models/alert.rb', line 288

def created_date_time
    return @created_date_time
end

#created_date_time=(value) ⇒ Object

Sets the createdDateTime property value. Time at which the alert was created by the alert provider. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Required.

Parameters:

  • value

    Value to set for the createdDateTime property.

Returns:

  • a void



296
297
298
# File 'lib/models/alert.rb', line 296

def created_date_time=(value)
    @created_date_time = value
end

#descriptionObject

Gets the description property value. Alert description.

Returns:

  • a string



312
313
314
# File 'lib/models/alert.rb', line 312

def description
    return @description
end

#description=(value) ⇒ Object

Sets the description property value. Alert description.

Parameters:

  • value

    Value to set for the description property.

Returns:

  • a void



320
321
322
# File 'lib/models/alert.rb', line 320

def description=(value)
    @description = value
end

#detection_idsObject

Gets the detectionIds property value. Set of alerts related to this alert entity (each alert is pushed to the SIEM as a separate record).

Returns:

  • a string



327
328
329
# File 'lib/models/alert.rb', line 327

def detection_ids
    return @detection_ids
end

#detection_ids=(value) ⇒ Object

Sets the detectionIds property value. Set of alerts related to this alert entity (each alert is pushed to the SIEM as a separate record).

Parameters:

  • value

    Value to set for the detectionIds property.

Returns:

  • a void



335
336
337
# File 'lib/models/alert.rb', line 335

def detection_ids=(value)
    @detection_ids = value
end

#event_date_timeObject

Gets the eventDateTime property value. Time at which the event(s) that served as the trigger(s) to generate the alert occurred. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Required.

Returns:

  • a date_time



342
343
344
# File 'lib/models/alert.rb', line 342

def event_date_time
    return @event_date_time
end

#event_date_time=(value) ⇒ Object

Sets the eventDateTime property value. Time at which the event(s) that served as the trigger(s) to generate the alert occurred. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Required.

Parameters:

  • value

    Value to set for the eventDateTime property.

Returns:

  • a void



350
351
352
# File 'lib/models/alert.rb', line 350

def event_date_time=(value)
    @event_date_time = value
end

#feedbackObject

Gets the feedback property value. Analyst feedback on the alert. Possible values are: unknown, truePositive, falsePositive, benignPositive. (supports update)

Returns:

  • a alert_feedback



357
358
359
# File 'lib/models/alert.rb', line 357

def feedback
    return @feedback
end

#feedback=(value) ⇒ Object

Sets the feedback property value. Analyst feedback on the alert. Possible values are: unknown, truePositive, falsePositive, benignPositive. (supports update)

Parameters:

  • value

    Value to set for the feedback property.

Returns:

  • a void



365
366
367
# File 'lib/models/alert.rb', line 365

def feedback=(value)
    @feedback = value
end

#file_statesObject

Gets the fileStates property value. Security-related stateful information generated by the provider about the file(s) related to this alert.

Returns:

  • a file_security_state



372
373
374
# File 'lib/models/alert.rb', line 372

def file_states
    return @file_states
end

#file_states=(value) ⇒ Object

Sets the fileStates property value. Security-related stateful information generated by the provider about the file(s) related to this alert.

Parameters:

  • value

    Value to set for the fileStates property.

Returns:

  • a void



380
381
382
# File 'lib/models/alert.rb', line 380

def file_states=(value)
    @file_states = value
end

#get_field_deserializersObject

The deserialization information for the current model

Returns:

  • a i_dictionary



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
# File 'lib/models/alert.rb', line 387

def get_field_deserializers()
    return super.merge({
        "activityGroupName" => lambda {|n| @activity_group_name = n.get_string_value() },
        "alertDetections" => lambda {|n| @alert_detections = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::AlertDetection.create_from_discriminator_value(pn) }) },
        "assignedTo" => lambda {|n| @assigned_to = n.get_string_value() },
        "azureSubscriptionId" => lambda {|n| @azure_subscription_id = n.get_string_value() },
        "azureTenantId" => lambda {|n| @azure_tenant_id = n.get_string_value() },
        "category" => lambda {|n| @category = n.get_string_value() },
        "closedDateTime" => lambda {|n| @closed_date_time = n.get_date_time_value() },
        "cloudAppStates" => lambda {|n| @cloud_app_states = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::CloudAppSecurityState.create_from_discriminator_value(pn) }) },
        "comments" => lambda {|n| @comments = n.get_collection_of_primitive_values(String) },
        "confidence" => lambda {|n| @confidence = n.get_number_value() },
        "createdDateTime" => lambda {|n| @created_date_time = n.get_date_time_value() },
        "description" => lambda {|n| @description = n.get_string_value() },
        "detectionIds" => lambda {|n| @detection_ids = n.get_collection_of_primitive_values(String) },
        "eventDateTime" => lambda {|n| @event_date_time = n.get_date_time_value() },
        "feedback" => lambda {|n| @feedback = n.get_enum_value(MicrosoftGraph::Models::AlertFeedback) },
        "fileStates" => lambda {|n| @file_states = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::FileSecurityState.create_from_discriminator_value(pn) }) },
        "historyStates" => lambda {|n| @history_states = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::AlertHistoryState.create_from_discriminator_value(pn) }) },
        "hostStates" => lambda {|n| @host_states = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::HostSecurityState.create_from_discriminator_value(pn) }) },
        "incidentIds" => lambda {|n| @incident_ids = n.get_collection_of_primitive_values(String) },
        "investigationSecurityStates" => lambda {|n| @investigation_security_states = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::InvestigationSecurityState.create_from_discriminator_value(pn) }) },
        "lastEventDateTime" => lambda {|n| @last_event_date_time = n.get_date_time_value() },
        "lastModifiedDateTime" => lambda {|n| @last_modified_date_time = n.get_date_time_value() },
        "malwareStates" => lambda {|n| @malware_states = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::MalwareState.create_from_discriminator_value(pn) }) },
        "messageSecurityStates" => lambda {|n| @message_security_states = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::MessageSecurityState.create_from_discriminator_value(pn) }) },
        "networkConnections" => lambda {|n| @network_connections = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::NetworkConnection.create_from_discriminator_value(pn) }) },
        "processes" => lambda {|n| @processes = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::Process.create_from_discriminator_value(pn) }) },
        "recommendedActions" => lambda {|n| @recommended_actions = n.get_collection_of_primitive_values(String) },
        "registryKeyStates" => lambda {|n| @registry_key_states = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::RegistryKeyState.create_from_discriminator_value(pn) }) },
        "securityResources" => lambda {|n| @security_resources = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::SecurityResource.create_from_discriminator_value(pn) }) },
        "severity" => lambda {|n| @severity = n.get_enum_value(MicrosoftGraph::Models::AlertSeverity) },
        "sourceMaterials" => lambda {|n| @source_materials = n.get_collection_of_primitive_values(String) },
        "status" => lambda {|n| @status = n.get_enum_value(MicrosoftGraph::Models::AlertStatus) },
        "tags" => lambda {|n| @tags = n.get_collection_of_primitive_values(String) },
        "title" => lambda {|n| @title = n.get_string_value() },
        "triggers" => lambda {|n| @triggers = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::AlertTrigger.create_from_discriminator_value(pn) }) },
        "uriClickSecurityStates" => lambda {|n| @uri_click_security_states = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::UriClickSecurityState.create_from_discriminator_value(pn) }) },
        "userStates" => lambda {|n| @user_states = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::UserSecurityState.create_from_discriminator_value(pn) }) },
        "vendorInformation" => lambda {|n| @vendor_information = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::SecurityVendorInformation.create_from_discriminator_value(pn) }) },
        "vulnerabilityStates" => lambda {|n| @vulnerability_states = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::VulnerabilityState.create_from_discriminator_value(pn) }) },
    })
end

#history_statesObject

Gets the historyStates property value. The historyStates property

Returns:

  • a alert_history_state



434
435
436
# File 'lib/models/alert.rb', line 434

def history_states
    return @history_states
end

#history_states=(value) ⇒ Object

Sets the historyStates property value. The historyStates property

Parameters:

  • value

    Value to set for the historyStates property.

Returns:

  • a void



442
443
444
# File 'lib/models/alert.rb', line 442

def history_states=(value)
    @history_states = value
end

#host_statesObject

Gets the hostStates property value. Security-related stateful information generated by the provider about the host(s) related to this alert.

Returns:

  • a host_security_state



449
450
451
# File 'lib/models/alert.rb', line 449

def host_states
    return @host_states
end

#host_states=(value) ⇒ Object

Sets the hostStates property value. Security-related stateful information generated by the provider about the host(s) related to this alert.

Parameters:

  • value

    Value to set for the hostStates property.

Returns:

  • a void



457
458
459
# File 'lib/models/alert.rb', line 457

def host_states=(value)
    @host_states = value
end

#incident_idsObject

Gets the incidentIds property value. IDs of incidents related to current alert.

Returns:

  • a string



464
465
466
# File 'lib/models/alert.rb', line 464

def incident_ids
    return @incident_ids
end

#incident_ids=(value) ⇒ Object

Sets the incidentIds property value. IDs of incidents related to current alert.

Parameters:

  • value

    Value to set for the incidentIds property.

Returns:

  • a void



472
473
474
# File 'lib/models/alert.rb', line 472

def incident_ids=(value)
    @incident_ids = value
end

#investigation_security_statesObject

Gets the investigationSecurityStates property value. The investigationSecurityStates property

Returns:

  • a investigation_security_state



479
480
481
# File 'lib/models/alert.rb', line 479

def investigation_security_states
    return @investigation_security_states
end

#investigation_security_states=(value) ⇒ Object

Sets the investigationSecurityStates property value. The investigationSecurityStates property

Parameters:

  • value

    Value to set for the investigationSecurityStates property.

Returns:

  • a void



487
488
489
# File 'lib/models/alert.rb', line 487

def investigation_security_states=(value)
    @investigation_security_states = value
end

#last_event_date_timeObject

Gets the lastEventDateTime property value. The lastEventDateTime property

Returns:

  • a date_time



494
495
496
# File 'lib/models/alert.rb', line 494

def last_event_date_time
    return @last_event_date_time
end

#last_event_date_time=(value) ⇒ Object

Sets the lastEventDateTime property value. The lastEventDateTime property

Parameters:

  • value

    Value to set for the lastEventDateTime property.

Returns:

  • a void



502
503
504
# File 'lib/models/alert.rb', line 502

def last_event_date_time=(value)
    @last_event_date_time = value
end

#last_modified_date_timeObject

Gets the lastModifiedDateTime property value. Time at which the alert entity was last modified. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.

Returns:

  • a date_time



509
510
511
# File 'lib/models/alert.rb', line 509

def last_modified_date_time
    return @last_modified_date_time
end

#last_modified_date_time=(value) ⇒ Object

Sets the lastModifiedDateTime property value. Time at which the alert entity was last modified. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.

Parameters:

  • value

    Value to set for the lastModifiedDateTime property.

Returns:

  • a void



517
518
519
# File 'lib/models/alert.rb', line 517

def last_modified_date_time=(value)
    @last_modified_date_time = value
end

#malware_statesObject

Gets the malwareStates property value. Threat Intelligence pertaining to malware related to this alert.

Returns:

  • a malware_state



524
525
526
# File 'lib/models/alert.rb', line 524

def malware_states
    return @malware_states
end

#malware_states=(value) ⇒ Object

Sets the malwareStates property value. Threat Intelligence pertaining to malware related to this alert.

Parameters:

  • value

    Value to set for the malwareStates property.

Returns:

  • a void



532
533
534
# File 'lib/models/alert.rb', line 532

def malware_states=(value)
    @malware_states = value
end

#message_security_statesObject

Gets the messageSecurityStates property value. The messageSecurityStates property

Returns:

  • a message_security_state



539
540
541
# File 'lib/models/alert.rb', line 539

def message_security_states
    return @message_security_states
end

#message_security_states=(value) ⇒ Object

Sets the messageSecurityStates property value. The messageSecurityStates property

Parameters:

  • value

    Value to set for the messageSecurityStates property.

Returns:

  • a void



547
548
549
# File 'lib/models/alert.rb', line 547

def message_security_states=(value)
    @message_security_states = value
end

#network_connectionsObject

Gets the networkConnections property value. Security-related stateful information generated by the provider about the network connection(s) related to this alert.

Returns:

  • a network_connection



554
555
556
# File 'lib/models/alert.rb', line 554

def network_connections
    return @network_connections
end

#network_connections=(value) ⇒ Object

Sets the networkConnections property value. Security-related stateful information generated by the provider about the network connection(s) related to this alert.

Parameters:

  • value

    Value to set for the networkConnections property.

Returns:

  • a void



562
563
564
# File 'lib/models/alert.rb', line 562

def network_connections=(value)
    @network_connections = value
end

#processesObject

Gets the processes property value. Security-related stateful information generated by the provider about the process or processes related to this alert.

Returns:

  • a process



569
570
571
# File 'lib/models/alert.rb', line 569

def processes
    return @processes
end

#processes=(value) ⇒ Object

Sets the processes property value. Security-related stateful information generated by the provider about the process or processes related to this alert.

Parameters:

  • value

    Value to set for the processes property.

Returns:

  • a void



577
578
579
# File 'lib/models/alert.rb', line 577

def processes=(value)
    @processes = value
end

Gets the recommendedActions property value. Vendor/provider recommended action(s) to take as a result of the alert (for example, isolate machine, enforce2FA, reimage host).

Returns:

  • a string



584
585
586
# File 'lib/models/alert.rb', line 584

def recommended_actions
    return @recommended_actions
end

Sets the recommendedActions property value. Vendor/provider recommended action(s) to take as a result of the alert (for example, isolate machine, enforce2FA, reimage host).

Parameters:

  • value

    Value to set for the recommendedActions property.

Returns:

  • a void



592
593
594
# File 'lib/models/alert.rb', line 592

def recommended_actions=(value)
    @recommended_actions = value
end

#registry_key_statesObject

Gets the registryKeyStates property value. Security-related stateful information generated by the provider about the registry keys related to this alert.

Returns:

  • a registry_key_state



599
600
601
# File 'lib/models/alert.rb', line 599

def registry_key_states
    return @registry_key_states
end

#registry_key_states=(value) ⇒ Object

Sets the registryKeyStates property value. Security-related stateful information generated by the provider about the registry keys related to this alert.

Parameters:

  • value

    Value to set for the registryKeyStates property.

Returns:

  • a void



607
608
609
# File 'lib/models/alert.rb', line 607

def registry_key_states=(value)
    @registry_key_states = value
end

#security_resourcesObject

Gets the securityResources property value. Resources related to current alert. For example, for some alerts this can have the Azure Resource value.

Returns:

  • a security_resource



614
615
616
# File 'lib/models/alert.rb', line 614

def security_resources
    return @security_resources
end

#security_resources=(value) ⇒ Object

Sets the securityResources property value. Resources related to current alert. For example, for some alerts this can have the Azure Resource value.

Parameters:

  • value

    Value to set for the securityResources property.

Returns:

  • a void



622
623
624
# File 'lib/models/alert.rb', line 622

def security_resources=(value)
    @security_resources = value
end

#serialize(writer) ⇒ Object

Serializes information the current object

Parameters:

  • writer

    Serialization writer to use to serialize this model

Returns:

  • a void

Raises:

  • (StandardError)


630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
# File 'lib/models/alert.rb', line 630

def serialize(writer)
    raise StandardError, 'writer cannot be null' if writer.nil?
    super
    writer.write_string_value("activityGroupName", @activity_group_name)
    writer.write_collection_of_object_values("alertDetections", @alert_detections)
    writer.write_string_value("assignedTo", @assigned_to)
    writer.write_string_value("azureSubscriptionId", @azure_subscription_id)
    writer.write_string_value("azureTenantId", @azure_tenant_id)
    writer.write_string_value("category", @category)
    writer.write_date_time_value("closedDateTime", @closed_date_time)
    writer.write_collection_of_object_values("cloudAppStates", @cloud_app_states)
    writer.write_collection_of_primitive_values("comments", @comments)
    writer.write_number_value("confidence", @confidence)
    writer.write_date_time_value("createdDateTime", @created_date_time)
    writer.write_string_value("description", @description)
    writer.write_collection_of_primitive_values("detectionIds", @detection_ids)
    writer.write_date_time_value("eventDateTime", @event_date_time)
    writer.write_enum_value("feedback", @feedback)
    writer.write_collection_of_object_values("fileStates", @file_states)
    writer.write_collection_of_object_values("historyStates", @history_states)
    writer.write_collection_of_object_values("hostStates", @host_states)
    writer.write_collection_of_primitive_values("incidentIds", @incident_ids)
    writer.write_collection_of_object_values("investigationSecurityStates", @investigation_security_states)
    writer.write_date_time_value("lastEventDateTime", @last_event_date_time)
    writer.write_date_time_value("lastModifiedDateTime", @last_modified_date_time)
    writer.write_collection_of_object_values("malwareStates", @malware_states)
    writer.write_collection_of_object_values("messageSecurityStates", @message_security_states)
    writer.write_collection_of_object_values("networkConnections", @network_connections)
    writer.write_collection_of_object_values("processes", @processes)
    writer.write_collection_of_primitive_values("recommendedActions", @recommended_actions)
    writer.write_collection_of_object_values("registryKeyStates", @registry_key_states)
    writer.write_collection_of_object_values("securityResources", @security_resources)
    writer.write_enum_value("severity", @severity)
    writer.write_collection_of_primitive_values("sourceMaterials", @source_materials)
    writer.write_enum_value("status", @status)
    writer.write_collection_of_primitive_values("tags", @tags)
    writer.write_string_value("title", @title)
    writer.write_collection_of_object_values("triggers", @triggers)
    writer.write_collection_of_object_values("uriClickSecurityStates", @uri_click_security_states)
    writer.write_collection_of_object_values("userStates", @user_states)
    writer.write_object_value("vendorInformation", @vendor_information)
    writer.write_collection_of_object_values("vulnerabilityStates", @vulnerability_states)
end

#severityObject

Gets the severity property value. The severity property

Returns:

  • a alert_severity



677
678
679
# File 'lib/models/alert.rb', line 677

def severity
    return @severity
end

#severity=(value) ⇒ Object

Sets the severity property value. The severity property

Parameters:

  • value

    Value to set for the severity property.

Returns:

  • a void



685
686
687
# File 'lib/models/alert.rb', line 685

def severity=(value)
    @severity = value
end

#source_materialsObject

Gets the sourceMaterials property value. Hyperlinks (URIs) to the source material related to the alert, for example, provider’s user interface for alerts or log search, etc.

Returns:

  • a string



692
693
694
# File 'lib/models/alert.rb', line 692

def source_materials
    return @source_materials
end

#source_materials=(value) ⇒ Object

Sets the sourceMaterials property value. Hyperlinks (URIs) to the source material related to the alert, for example, provider’s user interface for alerts or log search, etc.

Parameters:

  • value

    Value to set for the sourceMaterials property.

Returns:

  • a void



700
701
702
# File 'lib/models/alert.rb', line 700

def source_materials=(value)
    @source_materials = value
end

#statusObject

Gets the status property value. The status property

Returns:

  • a alert_status



707
708
709
# File 'lib/models/alert.rb', line 707

def status
    return @status
end

#status=(value) ⇒ Object

Sets the status property value. The status property

Parameters:

  • value

    Value to set for the status property.

Returns:

  • a void



715
716
717
# File 'lib/models/alert.rb', line 715

def status=(value)
    @status = value
end

#tagsObject

Gets the tags property value. User-definable labels that can be applied to an alert and can serve as filter conditions (for example ‘HVA’, ‘SAW’, etc.) (supports update).

Returns:

  • a string



722
723
724
# File 'lib/models/alert.rb', line 722

def tags
    return @tags
end

#tags=(value) ⇒ Object

Sets the tags property value. User-definable labels that can be applied to an alert and can serve as filter conditions (for example ‘HVA’, ‘SAW’, etc.) (supports update).

Parameters:

  • value

    Value to set for the tags property.

Returns:

  • a void



730
731
732
# File 'lib/models/alert.rb', line 730

def tags=(value)
    @tags = value
end

#titleObject

Gets the title property value. Alert title. Required.

Returns:

  • a string



737
738
739
# File 'lib/models/alert.rb', line 737

def title
    return @title
end

#title=(value) ⇒ Object

Sets the title property value. Alert title. Required.

Parameters:

  • value

    Value to set for the title property.

Returns:

  • a void



745
746
747
# File 'lib/models/alert.rb', line 745

def title=(value)
    @title = value
end

#triggersObject

Gets the triggers property value. Security-related information about the specific properties that triggered the alert (properties appearing in the alert). Alerts might contain information about multiple users, hosts, files, ip addresses. This field indicates which properties triggered the alert generation.

Returns:

  • a alert_trigger



752
753
754
# File 'lib/models/alert.rb', line 752

def triggers
    return @triggers
end

#triggers=(value) ⇒ Object

Sets the triggers property value. Security-related information about the specific properties that triggered the alert (properties appearing in the alert). Alerts might contain information about multiple users, hosts, files, ip addresses. This field indicates which properties triggered the alert generation.

Parameters:

  • value

    Value to set for the triggers property.

Returns:

  • a void



760
761
762
# File 'lib/models/alert.rb', line 760

def triggers=(value)
    @triggers = value
end

#uri_click_security_statesObject

Gets the uriClickSecurityStates property value. The uriClickSecurityStates property

Returns:

  • a uri_click_security_state



767
768
769
# File 'lib/models/alert.rb', line 767

def uri_click_security_states
    return @uri_click_security_states
end

#uri_click_security_states=(value) ⇒ Object

Sets the uriClickSecurityStates property value. The uriClickSecurityStates property

Parameters:

  • value

    Value to set for the uriClickSecurityStates property.

Returns:

  • a void



775
776
777
# File 'lib/models/alert.rb', line 775

def uri_click_security_states=(value)
    @uri_click_security_states = value
end

#user_statesObject

Gets the userStates property value. Security-related stateful information generated by the provider about the user accounts related to this alert.

Returns:

  • a user_security_state



782
783
784
# File 'lib/models/alert.rb', line 782

def user_states
    return @user_states
end

#user_states=(value) ⇒ Object

Sets the userStates property value. Security-related stateful information generated by the provider about the user accounts related to this alert.

Parameters:

  • value

    Value to set for the userStates property.

Returns:

  • a void



790
791
792
# File 'lib/models/alert.rb', line 790

def user_states=(value)
    @user_states = value
end

#vendor_informationObject

Gets the vendorInformation property value. Complex type containing details about the security product/service vendor, provider, and subprovider (for example, vendor=Microsoft; provider=Windows Defender ATP; subProvider=AppLocker). Required.

Returns:

  • a security_vendor_information



797
798
799
# File 'lib/models/alert.rb', line 797

def vendor_information
    return @vendor_information
end

#vendor_information=(value) ⇒ Object

Sets the vendorInformation property value. Complex type containing details about the security product/service vendor, provider, and subprovider (for example, vendor=Microsoft; provider=Windows Defender ATP; subProvider=AppLocker). Required.

Parameters:

  • value

    Value to set for the vendorInformation property.

Returns:

  • a void



805
806
807
# File 'lib/models/alert.rb', line 805

def vendor_information=(value)
    @vendor_information = value
end

#vulnerability_statesObject

Gets the vulnerabilityStates property value. Threat intelligence pertaining to one or more vulnerabilities related to this alert.

Returns:

  • a vulnerability_state



812
813
814
# File 'lib/models/alert.rb', line 812

def vulnerability_states
    return @vulnerability_states
end

#vulnerability_states=(value) ⇒ Object

Sets the vulnerabilityStates property value. Threat intelligence pertaining to one or more vulnerabilities related to this alert.

Parameters:

  • value

    Value to set for the vulnerabilityStates property.

Returns:

  • a void



820
821
822
# File 'lib/models/alert.rb', line 820

def vulnerability_states=(value)
    @vulnerability_states = value
end