Class: Azure::SecurityInsights::Mgmt::V2019_01_01_preview::Models::ScheduledAlertRuleTemplate

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

Overview

Represents scheduled alert rule template.

Instance Attribute Summary collapse

Attributes inherited from AlertRuleTemplate

#id, #name, #type

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ ScheduledAlertRuleTemplate

Returns a new instance of ScheduledAlertRuleTemplate.



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

def initialize
  @kind = "Scheduled"
end

Instance Attribute Details

#alert_rules_created_by_template_count ⇒ Integer

template

Returns:

  • (Integer) —

    the number of alert rules that were created by this



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

def alert_rules_created_by_template_count
  @alert_rules_created_by_template_count
end

#created_date_utc ⇒ DateTime

added.

Returns:

  • (DateTime) —

    The time that this alert rule template has been



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

def created_date_utc
  @created_date_utc
end

#description ⇒ String

Returns The description of the alert rule template.

Returns:

  • (String) —

    The description of the alert rule template.



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

def description
  @description
end

#display_name ⇒ String

Returns The display name for alert rule template.

Returns:

  • (String) —

    The display name for alert rule template.



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

def display_name
  @display_name
end

#event_grouping_settings ⇒ EventGroupingSettings

Returns The event grouping settings.

Returns:



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

def event_grouping_settings
  @event_grouping_settings
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_template.rb', line 20

def kind
  @kind
end

#query ⇒ String

Returns The query that creates alerts for this rule.

Returns:

  • (String) —

    The query that creates alerts for this rule.



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

def query
  @query
end

#query_frequency ⇒ Duration

alert rule to run.

Returns:

  • (Duration) —

    The frequency (in ISO 8601 duration format) for this



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

def query_frequency
  @query_frequency
end

#query_period ⇒ Duration

alert rule looks at.

Returns:

  • (Duration) —

    The period (in ISO 8601 duration format) that this



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

def query_period
  @query_period
end

#required_data_connectors ⇒ Array<AlertRuleTemplateDataSource>

for this template

Returns:



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

def required_data_connectors
  @required_data_connectors
end

#severity ⇒ AlertSeverity

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

Returns:

  • (AlertSeverity) —

    The severity for alerts created by this alert



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

def severity
  @severity
end

#status ⇒ TemplateStatus

values include: ‘Installed’, ‘Available’, ‘NotAvailable’

Returns:



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

def status
  @status
end

#tactics ⇒ Array<AttackTactic>

Returns The tactics of the alert rule template.

Returns:

  • (Array<AttackTactic>) —

    The tactics of the alert rule template



71
72
73
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/models/scheduled_alert_rule_template.rb', line 71

def tactics
  @tactics
end

#trigger_operator ⇒ TriggerOperator

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

Returns:



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

def trigger_operator
  @trigger_operator
end

#trigger_threshold ⇒ Integer

Returns The threshold triggers this alert rule.

Returns:

  • (Integer) —

    The threshold triggers this alert rule.



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

def trigger_threshold
  @trigger_threshold
end

Class Method Details

.mapper ⇒ Object

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



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
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
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/models/scheduled_alert_rule_template.rb', line 78

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'Scheduled',
    type: {
      name: 'Composite',
      class_name: 'ScheduledAlertRuleTemplate',
      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'
          }
        },
        alert_rules_created_by_template_count: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.alertRulesCreatedByTemplateCount',
          type: {
            name: 'Number'
          }
        },
        created_date_utc: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.createdDateUTC',
          type: {
            name: 'DateTime'
          }
        },
        description: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.description',
          type: {
            name: 'String'
          }
        },
        display_name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.displayName',
          type: {
            name: 'String'
          }
        },
        required_data_connectors: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.requiredDataConnectors',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'AlertRuleTemplateDataSourceElementType',
                type: {
                  name: 'Composite',
                  class_name: 'AlertRuleTemplateDataSource'
                }
            }
          }
        },
        status: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.status',
          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'
          }
        },
        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'
                }
            }
          }
        }
      }
    }
  }
end