Class: Azure::SecurityInsights::Mgmt::V2020_01_01::Models::ScheduledAlertRuleCommonProperties

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2020-01-01/generated/azure_mgmt_security_insights/models/scheduled_alert_rule_common_properties.rb

Overview

Schedule alert rule template property bag.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#query ⇒ String

Returns The query that creates alerts for this rule.

Returns:

  • (String) —

    The query that creates alerts for this rule.



16
17
18
 
# File 'lib/2020-01-01/generated/azure_mgmt_security_insights/models/scheduled_alert_rule_common_properties.rb', line 16

def query
  @query
end

#query_frequency ⇒ Duration

alert rule to run.

Returns:

  • (Duration) —

    The frequency (in ISO 8601 duration format) for this



20
21
22
 
# File 'lib/2020-01-01/generated/azure_mgmt_security_insights/models/scheduled_alert_rule_common_properties.rb', line 20

def query_frequency
  @query_frequency
end

#query_period ⇒ Duration

alert rule looks at.

Returns:

  • (Duration) —

    The period (in ISO 8601 duration format) that this



24
25
26
 
# File 'lib/2020-01-01/generated/azure_mgmt_security_insights/models/scheduled_alert_rule_common_properties.rb', line 24

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



28
29
30
 
# File 'lib/2020-01-01/generated/azure_mgmt_security_insights/models/scheduled_alert_rule_common_properties.rb', line 28

def severity
  @severity
end

#trigger_operator ⇒ TriggerOperator

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

Returns:



33
34
35
 
# File 'lib/2020-01-01/generated/azure_mgmt_security_insights/models/scheduled_alert_rule_common_properties.rb', line 33

def trigger_operator
  @trigger_operator
end

#trigger_threshold ⇒ Integer

Returns The threshold triggers this alert rule.

Returns:

  • (Integer) —

    The threshold triggers this alert rule.



36
37
38
 
# File 'lib/2020-01-01/generated/azure_mgmt_security_insights/models/scheduled_alert_rule_common_properties.rb', line 36

def trigger_threshold
  @trigger_threshold
end

Class Method Details

.mapper ⇒ Object

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



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/2020-01-01/generated/azure_mgmt_security_insights/models/scheduled_alert_rule_common_properties.rb', line 43

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'ScheduledAlertRuleCommonProperties',
    type: {
      name: 'Composite',
      class_name: 'ScheduledAlertRuleCommonProperties',
      model_properties: {
        query: {
          client_side_validation: true,
          required: false,
          serialized_name: 'query',
          type: {
            name: 'String'
          }
        },
        query_frequency: {
          client_side_validation: true,
          required: false,
          serialized_name: 'queryFrequency',
          type: {
            name: 'TimeSpan'
          }
        },
        query_period: {
          client_side_validation: true,
          required: false,
          serialized_name: 'queryPeriod',
          type: {
            name: 'TimeSpan'
          }
        },
        severity: {
          client_side_validation: true,
          required: false,
          serialized_name: 'severity',
          type: {
            name: 'String'
          }
        },
        trigger_operator: {
          client_side_validation: true,
          required: false,
          serialized_name: 'triggerOperator',
          type: {
            name: 'Enum',
            module: 'TriggerOperator'
          }
        },
        trigger_threshold: {
          client_side_validation: true,
          required: false,
          serialized_name: 'triggerThreshold',
          type: {
            name: 'Number'
          }
        }
      }
    }
  }
end