Class: Azure::ResourceHealth::Mgmt::V2018_07_01::Models::AvailabilityStatusProperties

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2018-07-01/generated/azure_mgmt_resource_health/models/availability_status_properties.rb

Overview

Properties of availability state.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#availability_state ⇒ AvailabilityStateValues

When it is null, this availabilityStatus object represents an availability impacting event. Possible values include: ‘Available’, ‘Unavailable’, ‘Degraded’, ‘Unknown’

Returns:



19
20
21
 
# File 'lib/2018-07-01/generated/azure_mgmt_resource_health/models/availability_status_properties.rb', line 19

def availability_state
  @availability_state
end

#detailed_status ⇒ String

Returns Details of the availability status.

Returns:

  • (String) —

    Details of the availability status.



25
26
27
 
# File 'lib/2018-07-01/generated/azure_mgmt_resource_health/models/availability_status_properties.rb', line 25

def detailed_status
  @detailed_status
end

#health_event_category ⇒ String

describes the category of a PlatformInitiated health impacting event. Examples are Planned, Unplanned etc.

Returns:

  • (String) —

    In case of an availability impacting event, it



50
51
52
 
# File 'lib/2018-07-01/generated/azure_mgmt_resource_health/models/availability_status_properties.rb', line 50

def health_event_category
  @health_event_category
end

#health_event_cause ⇒ String

describes where the health impacting event was originated. Examples are PlatformInitiated, UserInitiated etc.

Returns:

  • (String) —

    In case of an availability impacting event, it



45
46
47
 
# File 'lib/2018-07-01/generated/azure_mgmt_resource_health/models/availability_status_properties.rb', line 45

def health_event_cause
  @health_event_cause
end

#health_event_id ⇒ String

Returns It is a unique Id that identifies the event.

Returns:

  • (String) —

    It is a unique Id that identifies the event



53
54
55
 
# File 'lib/2018-07-01/generated/azure_mgmt_resource_health/models/availability_status_properties.rb', line 53

def health_event_id
  @health_event_id
end

#health_event_type ⇒ String

describes when the health impacting event was originated. Examples are Lifecycle, Downtime, Fault Analysis etc.

Returns:

  • (String) —

    In case of an availability impacting event, it



40
41
42
 
# File 'lib/2018-07-01/generated/azure_mgmt_resource_health/models/availability_status_properties.rb', line 40

def health_event_type
  @health_event_type
end

#occurred_time ⇒ DateTime

occurred.

Returns:

  • (DateTime) —

    Timestamp for when last change in health status



62
63
64
 
# File 'lib/2018-07-01/generated/azure_mgmt_resource_health/models/availability_status_properties.rb', line 62

def occurred_time
  @occurred_time
end

#reason_chronicity ⇒ ReasonChronicityTypes

transition. Possible values include: ‘Transient’, ‘Persistent’

Returns:



66
67
68
 
# File 'lib/2018-07-01/generated/azure_mgmt_resource_health/models/availability_status_properties.rb', line 66

def reason_chronicity
  @reason_chronicity
end

#reason_type ⇒ String

it describes where the health impacting event was originated. Examples are planned, unplanned, user initiated or an outage etc.

Returns:

  • (String) —

    When the resource’s availabilityState is Unavailable,



30
31
32
 
# File 'lib/2018-07-01/generated/azure_mgmt_resource_health/models/availability_status_properties.rb', line 30

def reason_type
  @reason_type
end

#recently_resolved ⇒ AvailabilityStatusPropertiesRecentlyResolved

describing a change in the availabilityState to Available from Unavailable with a reasonType of type Unplanned

Returns:



74
75
76
 
# File 'lib/2018-07-01/generated/azure_mgmt_resource_health/models/availability_status_properties.rb', line 74

def recently_resolved
  @recently_resolved
end

#recommended_actions ⇒ Array<RecommendedAction>

based on the current availabilityState of the resource.

Returns:



78
79
80
 
# File 'lib/2018-07-01/generated/azure_mgmt_resource_health/models/availability_status_properties.rb', line 78

def recommended_actions
  @recommended_actions
end

#reported_time ⇒ DateTime

Returns Timestamp for when the health was last checked.

Returns:

  • (DateTime) —

    Timestamp for when the health was last checked.



69
70
71
 
# File 'lib/2018-07-01/generated/azure_mgmt_resource_health/models/availability_status_properties.rb', line 69

def reported_time
  @reported_time
end

#resolution_eta ⇒ DateTime

and the reasonType is not User Initiated, it provides the date and time for when the issue is expected to be resolved.

Returns:

  • (DateTime) —

    When the resource’s availabilityState is Unavailable



58
59
60
 
# File 'lib/2018-07-01/generated/azure_mgmt_resource_health/models/availability_status_properties.rb', line 58

def resolution_eta
  @resolution_eta
end

#root_cause_attribution_time ⇒ DateTime

Unavailable, it provides the Timestamp for when the health impacting event was received.

Returns:

  • (DateTime) —

    When the resource’s availabilityState is



35
36
37
 
# File 'lib/2018-07-01/generated/azure_mgmt_resource_health/models/availability_status_properties.rb', line 35

def root_cause_attribution_time
  @root_cause_attribution_time
end

#service_impacting_events ⇒ Array<ServiceImpactingEvent>

events that may be affecting the health of the resource.

Returns:



82
83
84
 
# File 'lib/2018-07-01/generated/azure_mgmt_resource_health/models/availability_status_properties.rb', line 82

def service_impacting_events
  @service_impacting_events
end

#summary ⇒ String

Returns Summary description of the availability status.

Returns:

  • (String) —

    Summary description of the availability status.



22
23
24
 
# File 'lib/2018-07-01/generated/azure_mgmt_resource_health/models/availability_status_properties.rb', line 22

def summary
  @summary
end

Class Method Details

.mapper ⇒ Object

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



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
 
# File 'lib/2018-07-01/generated/azure_mgmt_resource_health/models/availability_status_properties.rb', line 89

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'availabilityStatus_properties',
    type: {
      name: 'Composite',
      class_name: 'AvailabilityStatusProperties',
      model_properties: {
        availability_state: {
          client_side_validation: true,
          required: false,
          serialized_name: 'availabilityState',
          type: {
            name: 'String'
          }
        },
        summary: {
          client_side_validation: true,
          required: false,
          serialized_name: 'summary',
          type: {
            name: 'String'
          }
        },
        detailed_status: {
          client_side_validation: true,
          required: false,
          serialized_name: 'detailedStatus',
          type: {
            name: 'String'
          }
        },
        reason_type: {
          client_side_validation: true,
          required: false,
          serialized_name: 'reasonType',
          type: {
            name: 'String'
          }
        },
        root_cause_attribution_time: {
          client_side_validation: true,
          required: false,
          serialized_name: 'rootCauseAttributionTime',
          type: {
            name: 'DateTime'
          }
        },
        health_event_type: {
          client_side_validation: true,
          required: false,
          serialized_name: 'healthEventType',
          type: {
            name: 'String'
          }
        },
        health_event_cause: {
          client_side_validation: true,
          required: false,
          serialized_name: 'healthEventCause',
          type: {
            name: 'String'
          }
        },
        health_event_category: {
          client_side_validation: true,
          required: false,
          serialized_name: 'healthEventCategory',
          type: {
            name: 'String'
          }
        },
        health_event_id: {
          client_side_validation: true,
          required: false,
          serialized_name: 'healthEventId',
          type: {
            name: 'String'
          }
        },
        resolution_eta: {
          client_side_validation: true,
          required: false,
          serialized_name: 'resolutionETA',
          type: {
            name: 'DateTime'
          }
        },
        occurred_time: {
          client_side_validation: true,
          required: false,
          serialized_name: 'occurredTime',
          type: {
            name: 'DateTime'
          }
        },
        reason_chronicity: {
          client_side_validation: true,
          required: false,
          serialized_name: 'reasonChronicity',
          type: {
            name: 'String'
          }
        },
        reported_time: {
          client_side_validation: true,
          required: false,
          serialized_name: 'reportedTime',
          type: {
            name: 'DateTime'
          }
        },
        recently_resolved: {
          client_side_validation: true,
          required: false,
          serialized_name: 'recentlyResolved',
          type: {
            name: 'Composite',
            class_name: 'AvailabilityStatusPropertiesRecentlyResolved'
          }
        },
        recommended_actions: {
          client_side_validation: true,
          required: false,
          serialized_name: 'recommendedActions',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'RecommendedActionElementType',
                type: {
                  name: 'Composite',
                  class_name: 'RecommendedAction'
                }
            }
          }
        },
        service_impacting_events: {
          client_side_validation: true,
          required: false,
          serialized_name: 'serviceImpactingEvents',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'ServiceImpactingEventElementType',
                type: {
                  name: 'Composite',
                  class_name: 'ServiceImpactingEvent'
                }
            }
          }
        }
      }
    }
  }
end