Class: Azure::Consumption::Mgmt::V2019_06_01::Models::ReservationSummary

Inherits:
Resource
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-06-01/generated/azure_mgmt_consumption/models/reservation_summary.rb

Overview

reservation summary resource.

Instance Attribute Summary collapse

Attributes inherited from Resource

#id, #name, #tags, #type

Class Method Summary collapse

Methods inherited from Resource

#resource_group

Instance Attribute Details

#avg_utilization_percentage ⇒ Object

month depending on the grain)

Returns:

  • This is average utilization for the entire time range. (day or



52
53
54
 
# File 'lib/2019-06-01/generated/azure_mgmt_consumption/models/reservation_summary.rb', line 52

def avg_utilization_percentage
  @avg_utilization_percentage
end

#kind ⇒ String

Returns The reservation kind.

Returns:

  • (String) —

    The reservation kind.



61
62
63
 
# File 'lib/2019-06-01/generated/azure_mgmt_consumption/models/reservation_summary.rb', line 61

def kind
  @kind
end

#max_utilization_percentage ⇒ Object

or month). E.g. if usage record corresponds to 12/10/2017 and on that for hour 4 and 5, utilization was 100%, this field will return 100% for that day.

Returns:

  • This is the maximum hourly utilization in the usage time (day



58
59
60
 
# File 'lib/2019-06-01/generated/azure_mgmt_consumption/models/reservation_summary.rb', line 58

def max_utilization_percentage
  @max_utilization_percentage
end

#min_utilization_percentage ⇒ Object

or month). E.g. if usage record corresponds to 12/10/2017 and on that for hour 4 and 5, utilization was 10%, this field will return 10% for that day

Returns:

  • This is the minimum hourly utilization in the usage time (day



48
49
50
 
# File 'lib/2019-06-01/generated/azure_mgmt_consumption/models/reservation_summary.rb', line 48

def min_utilization_percentage
  @min_utilization_percentage
end

#purchased_quantity ⇒ Object

Returns This is the purchased quantity for the reservationId.

Returns:

  • This is the purchased quantity for the reservationId.



64
65
66
 
# File 'lib/2019-06-01/generated/azure_mgmt_consumption/models/reservation_summary.rb', line 64

def purchased_quantity
  @purchased_quantity
end

#remaining_quantity ⇒ Object

Returns This is the remaining quantity for the reservationId.

Returns:

  • This is the remaining quantity for the reservationId.



67
68
69
 
# File 'lib/2019-06-01/generated/azure_mgmt_consumption/models/reservation_summary.rb', line 67

def remaining_quantity
  @remaining_quantity
end

#reservation_id ⇒ String

within a reservation order. Each reservation is the grouping for applying the benefit scope and also specifies the number of instances to which the reservation benefit can be applied to.

Returns:

  • (String) —

    The reservation ID is the identifier of a reservation



26
27
28
 
# File 'lib/2019-06-01/generated/azure_mgmt_consumption/models/reservation_summary.rb', line 26

def reservation_id
  @reservation_id
end

#reservation_order_id ⇒ String

reservation purchase. Each reservation order ID represents a single purchase transaction. A reservation order contains reservations. The reservation order specifies the VM size and region for the reservations.

Returns:

  • (String) —

    The reservation order ID is the identifier for a



20
21
22
 
# File 'lib/2019-06-01/generated/azure_mgmt_consumption/models/reservation_summary.rb', line 20

def reservation_order_id
  @reservation_order_id
end

#reserved_hours ⇒ Object

instance was made on 1 PM, this will be 11 hours for that day and 24 hours from subsequent days

Returns:

  • This is the total hours reserved. E.g. if reservation for 1



35
36
37
 
# File 'lib/2019-06-01/generated/azure_mgmt_consumption/models/reservation_summary.rb', line 35

def reserved_hours
  @reserved_hours
end

#sku_name ⇒ String

the serviceType field in additional info in usage records.

Returns:

  • (String) —

    This is the ARM Sku name. It can be used to join with



30
31
32
 
# File 'lib/2019-06-01/generated/azure_mgmt_consumption/models/reservation_summary.rb', line 30

def sku_name
  @sku_name
end

#total_reserved_quantity ⇒ Object

reservationId.

Returns:

  • This is the total count of instances that are reserved for the



71
72
73
 
# File 'lib/2019-06-01/generated/azure_mgmt_consumption/models/reservation_summary.rb', line 71

def total_reserved_quantity
  @total_reserved_quantity
end

#usage_date ⇒ DateTime

grain of data is monthly, it will be first day of month.

Returns:

  • (DateTime) —

    Data corresponding to the utilization record. If the



39
40
41
 
# File 'lib/2019-06-01/generated/azure_mgmt_consumption/models/reservation_summary.rb', line 39

def usage_date
  @usage_date
end

#used_hours ⇒ Object

Returns Total used hours by the reservation.

Returns:

  • Total used hours by the reservation



42
43
44
 
# File 'lib/2019-06-01/generated/azure_mgmt_consumption/models/reservation_summary.rb', line 42

def used_hours
  @used_hours
end

#used_quantity ⇒ Object

Returns This is the used quantity for the reservationId.

Returns:

  • This is the used quantity for the reservationId.



74
75
76
 
# File 'lib/2019-06-01/generated/azure_mgmt_consumption/models/reservation_summary.rb', line 74

def used_quantity
  @used_quantity
end

#utilized_percentage ⇒ Object

Returns This is the utilized percentage for the reservation Id.

Returns:

  • This is the utilized percentage for the reservation Id.



77
78
79
 
# File 'lib/2019-06-01/generated/azure_mgmt_consumption/models/reservation_summary.rb', line 77

def utilized_percentage
  @utilized_percentage
end

Class Method Details

.mapper ⇒ Object

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



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
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/2019-06-01/generated/azure_mgmt_consumption/models/reservation_summary.rb', line 84

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'ReservationSummary',
    type: {
      name: 'Composite',
      class_name: 'ReservationSummary',
      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'
          }
        },
        tags: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'tags',
          type: {
            name: 'Dictionary',
            value: {
                client_side_validation: true,
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        reservation_order_id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.reservationOrderId',
          type: {
            name: 'String'
          }
        },
        reservation_id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.reservationId',
          type: {
            name: 'String'
          }
        },
        sku_name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.skuName',
          type: {
            name: 'String'
          }
        },
        reserved_hours: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.reservedHours',
          type: {
            name: 'Number'
          }
        },
        usage_date: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.usageDate',
          type: {
            name: 'DateTime'
          }
        },
        used_hours: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.usedHours',
          type: {
            name: 'Number'
          }
        },
        min_utilization_percentage: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.minUtilizationPercentage',
          type: {
            name: 'Number'
          }
        },
        avg_utilization_percentage: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.avgUtilizationPercentage',
          type: {
            name: 'Number'
          }
        },
        max_utilization_percentage: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.maxUtilizationPercentage',
          type: {
            name: 'Number'
          }
        },
        kind: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.kind',
          type: {
            name: 'String'
          }
        },
        purchased_quantity: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.purchasedQuantity',
          type: {
            name: 'Number'
          }
        },
        remaining_quantity: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.remainingQuantity',
          type: {
            name: 'Number'
          }
        },
        total_reserved_quantity: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.totalReservedQuantity',
          type: {
            name: 'Number'
          }
        },
        used_quantity: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.usedQuantity',
          type: {
            name: 'Number'
          }
        },
        utilized_percentage: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.utilizedPercentage',
          type: {
            name: 'Number'
          }
        }
      }
    }
  }
end