Class: Azure::AlertsManagement::Mgmt::V2019_03_01::Models::Essentials

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-03-01/generated/azure_mgmt_alerts_management/models/essentials.rb

Overview

This object contains consistent fields across different monitor services.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#alert_rule ⇒ String

the monitor service, this would be ARM id or name of the rule.

Returns:

  • (String) —

    Rule(monitor) which fired alert instance. Depending on



58
59
60
 
# File 'lib/2019-03-01/generated/azure_mgmt_alerts_management/models/essentials.rb', line 58

def alert_rule
  @alert_rule
end

#alert_state ⇒ AlertState

user. Possible values include: ‘New’, ‘Acknowledged’, ‘Closed’

Returns:

  • (AlertState) —

    Alert object state, which can be modified by the



26
27
28
 
# File 'lib/2019-03-01/generated/azure_mgmt_alerts_management/models/essentials.rb', line 26

def alert_state
  @alert_state
end

#last_modified_date_time ⇒ DateTime

instance.

Returns:

  • (DateTime) —

    Last modification time(ISO-8601 format) of alert



77
78
79
 
# File 'lib/2019-03-01/generated/azure_mgmt_alerts_management/models/essentials.rb', line 77

def last_modified_date_time
  @last_modified_date_time
end

#last_modified_user_name ⇒ String

service updates user would be ‘system’, otherwise name of the user.

Returns:

  • (String) —

    User who last modified the alert, in case of monitor



86
87
88
 
# File 'lib/2019-03-01/generated/azure_mgmt_alerts_management/models/essentials.rb', line 86

def last_modified_user_name
  @last_modified_user_name
end

#monitor_condition ⇒ MonitorCondition

represents whether the underlying conditions have crossed the defined alert rule thresholds. Possible values include: ‘Fired’, ‘Resolved’

Returns:



31
32
33
 
# File 'lib/2019-03-01/generated/azure_mgmt_alerts_management/models/essentials.rb', line 31

def monitor_condition
  @monitor_condition
end

#monitor_condition_resolved_date_time ⇒ DateTime

This will be updated when monitor service resolves the alert instance because the rule condition is no longer met.

Returns:

  • (DateTime) —

    Resolved time(ISO-8601 format) of alert instance.



82
83
84
 
# File 'lib/2019-03-01/generated/azure_mgmt_alerts_management/models/essentials.rb', line 82

def monitor_condition_resolved_date_time
  @monitor_condition_resolved_date_time
end

#monitor_service ⇒ MonitorService

set. Possible values include: ‘Application Insights’, ‘ActivityLog Administrative’, ‘ActivityLog Security’, ‘ActivityLog Recommendation’, ‘ActivityLog Policy’, ‘ActivityLog Autoscale’, ‘Log Analytics’, ‘Nagios’, ‘Platform’, ‘SCOM’, ‘ServiceHealth’, ‘SmartDetector’, ‘VM Insights’, ‘Zabbix’, ‘Resource Health’

Returns:



54
55
56
 
# File 'lib/2019-03-01/generated/azure_mgmt_alerts_management/models/essentials.rb', line 54

def monitor_service
  @monitor_service
end

#severity ⇒ Severity

lowest. Possible values include: ‘Sev0’, ‘Sev1’, ‘Sev2’, ‘Sev3’, ‘Sev4’

Returns:

  • (Severity) —

    Severity of alert Sev0 being highest and Sev4 being



17
18
19
 
# File 'lib/2019-03-01/generated/azure_mgmt_alerts_management/models/essentials.rb', line 17

def severity
  @severity
end

#signal_type ⇒ SignalType

could be metrics, logs or activity logs. Possible values include: ‘Metric’, ‘Log’, ‘Unknown’

Returns:

  • (SignalType) —

    The type of signal the alert is based on, which



22
23
24
 
# File 'lib/2019-03-01/generated/azure_mgmt_alerts_management/models/essentials.rb', line 22

def signal_type
  @signal_type
end

#smart_group_id ⇒ String

Returns Unique Id of the smart group.

Returns:

  • (String) —

    Unique Id of the smart group



66
67
68
 
# File 'lib/2019-03-01/generated/azure_mgmt_alerts_management/models/essentials.rb', line 66

def smart_group_id
  @smart_group_id
end

#smart_grouping_reason ⇒ String

instance is added to a smart group

Returns:

  • (String) —

    Verbose reason describing the reason why this alert



70
71
72
 
# File 'lib/2019-03-01/generated/azure_mgmt_alerts_management/models/essentials.rb', line 70

def smart_grouping_reason
  @smart_grouping_reason
end

#source_created_id ⇒ String

instance. This could be used to track the issue at the monitor service, in case of Nagios, Zabbix, SCOM etc.

Returns:

  • (String) —

    Unique Id created by monitor service for each alert



63
64
65
 
# File 'lib/2019-03-01/generated/azure_mgmt_alerts_management/models/essentials.rb', line 63

def source_created_id
  @source_created_id
end

#start_date_time ⇒ DateTime

Returns Creation time(ISO-8601 format) of alert instance.

Returns:

  • (DateTime) —

    Creation time(ISO-8601 format) of alert instance.



73
74
75
 
# File 'lib/2019-03-01/generated/azure_mgmt_alerts_management/models/essentials.rb', line 73

def start_date_time
  @start_date_time
end

#target_resource ⇒ String

Returns Target ARM resource, on which alert got created.

Returns:

  • (String) —

    Target ARM resource, on which alert got created.



34
35
36
 
# File 'lib/2019-03-01/generated/azure_mgmt_alerts_management/models/essentials.rb', line 34

def target_resource
  @target_resource
end

#target_resource_group ⇒ String

got created.

Returns:

  • (String) —

    Resource group of target ARM resource, on which alert



42
43
44
 
# File 'lib/2019-03-01/generated/azure_mgmt_alerts_management/models/essentials.rb', line 42

def target_resource_group
  @target_resource_group
end

#target_resource_name ⇒ String

got created.

Returns:

  • (String) —

    Name of the target ARM resource name, on which alert



38
39
40
 
# File 'lib/2019-03-01/generated/azure_mgmt_alerts_management/models/essentials.rb', line 38

def target_resource_name
  @target_resource_name
end

#target_resource_type ⇒ String

got created.

Returns:

  • (String) —

    Resource type of target ARM resource, on which alert



46
47
48
 
# File 'lib/2019-03-01/generated/azure_mgmt_alerts_management/models/essentials.rb', line 46

def target_resource_type
  @target_resource_type
end

Class Method Details

.mapper ⇒ Object

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



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
 
# File 'lib/2019-03-01/generated/azure_mgmt_alerts_management/models/essentials.rb', line 93

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'essentials',
    type: {
      name: 'Composite',
      class_name: 'Essentials',
      model_properties: {
        severity: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'severity',
          type: {
            name: 'String'
          }
        },
        signal_type: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'signalType',
          type: {
            name: 'String'
          }
        },
        alert_state: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'alertState',
          type: {
            name: 'String'
          }
        },
        monitor_condition: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'monitorCondition',
          type: {
            name: 'String'
          }
        },
        target_resource: {
          client_side_validation: true,
          required: false,
          serialized_name: 'targetResource',
          type: {
            name: 'String'
          }
        },
        target_resource_name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'targetResourceName',
          type: {
            name: 'String'
          }
        },
        target_resource_group: {
          client_side_validation: true,
          required: false,
          serialized_name: 'targetResourceGroup',
          type: {
            name: 'String'
          }
        },
        target_resource_type: {
          client_side_validation: true,
          required: false,
          serialized_name: 'targetResourceType',
          type: {
            name: 'String'
          }
        },
        monitor_service: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'monitorService',
          type: {
            name: 'String'
          }
        },
        alert_rule: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'alertRule',
          type: {
            name: 'String'
          }
        },
        source_created_id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'sourceCreatedId',
          type: {
            name: 'String'
          }
        },
        smart_group_id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'smartGroupId',
          type: {
            name: 'String'
          }
        },
        smart_grouping_reason: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'smartGroupingReason',
          type: {
            name: 'String'
          }
        },
        start_date_time: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'startDateTime',
          type: {
            name: 'DateTime'
          }
        },
        last_modified_date_time: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'lastModifiedDateTime',
          type: {
            name: 'DateTime'
          }
        },
        monitor_condition_resolved_date_time: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'monitorConditionResolvedDateTime',
          type: {
            name: 'DateTime'
          }
        },
        last_modified_user_name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'lastModifiedUserName',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end