-
Notifications
You must be signed in to change notification settings - Fork 180
/
ReservationSummary.yml
363 lines (343 loc) · 11.2 KB
/
ReservationSummary.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
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
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
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
### YamlMime:TSType
name: ReservationSummary
uid: '@azure/arm-consumption.ReservationSummary'
package: '@azure/arm-consumption'
summary: reservation summary resource.
fullName: ReservationSummary
remarks: ''
isDeprecated: false
type: interface
properties:
- name: avgUtilizationPercentage
uid: '@azure/arm-consumption.ReservationSummary.avgUtilizationPercentage'
package: '@azure/arm-consumption'
summary: >-
This is average utilization for the entire time range. (day or month
depending on the grain)
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: avgUtilizationPercentage
remarks: ''
isDeprecated: false
syntax:
content: 'avgUtilizationPercentage?: number'
return:
description: ''
type: number
- name: kind
uid: '@azure/arm-consumption.ReservationSummary.kind'
package: '@azure/arm-consumption'
summary: >-
The reservation kind.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: kind
remarks: ''
isDeprecated: false
syntax:
content: 'kind?: string'
return:
description: ''
type: string
- name: maxUtilizationPercentage
uid: '@azure/arm-consumption.ReservationSummary.maxUtilizationPercentage'
package: '@azure/arm-consumption'
summary: >-
This is the maximum hourly utilization in the usage time (day 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.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: maxUtilizationPercentage
remarks: ''
isDeprecated: false
syntax:
content: 'maxUtilizationPercentage?: number'
return:
description: ''
type: number
- name: minUtilizationPercentage
uid: '@azure/arm-consumption.ReservationSummary.minUtilizationPercentage'
package: '@azure/arm-consumption'
summary: >-
This is the minimum hourly utilization in the usage time (day 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
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: minUtilizationPercentage
remarks: ''
isDeprecated: false
syntax:
content: 'minUtilizationPercentage?: number'
return:
description: ''
type: number
- name: purchasedQuantity
uid: '@azure/arm-consumption.ReservationSummary.purchasedQuantity'
package: '@azure/arm-consumption'
summary: >-
This is the purchased quantity for the reservationId.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: purchasedQuantity
remarks: ''
isDeprecated: false
syntax:
content: 'purchasedQuantity?: number'
return:
description: ''
type: number
- name: remainingQuantity
uid: '@azure/arm-consumption.ReservationSummary.remainingQuantity'
package: '@azure/arm-consumption'
summary: >-
This is the remaining quantity for the reservationId.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: remainingQuantity
remarks: ''
isDeprecated: false
syntax:
content: 'remainingQuantity?: number'
return:
description: ''
type: number
- name: reservationId
uid: '@azure/arm-consumption.ReservationSummary.reservationId'
package: '@azure/arm-consumption'
summary: >-
The reservation ID is the identifier of a reservation 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.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: reservationId
remarks: ''
isDeprecated: false
syntax:
content: 'reservationId?: string'
return:
description: ''
type: string
- name: reservationOrderId
uid: '@azure/arm-consumption.ReservationSummary.reservationOrderId'
package: '@azure/arm-consumption'
summary: >-
The reservation order ID is the identifier for a 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.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: reservationOrderId
remarks: ''
isDeprecated: false
syntax:
content: 'reservationOrderId?: string'
return:
description: ''
type: string
- name: reservedHours
uid: '@azure/arm-consumption.ReservationSummary.reservedHours'
package: '@azure/arm-consumption'
summary: >-
This is the total hours reserved. E.g. if reservation for 1 instance was
made on 1 PM, this will be 11 hours for that day and 24 hours from
subsequent days
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: reservedHours
remarks: ''
isDeprecated: false
syntax:
content: 'reservedHours?: number'
return:
description: ''
type: number
- name: skuName
uid: '@azure/arm-consumption.ReservationSummary.skuName'
package: '@azure/arm-consumption'
summary: >-
This is the ARM Sku name. It can be used to join with the serviceType
field in additional info in usage records.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: skuName
remarks: ''
isDeprecated: false
syntax:
content: 'skuName?: string'
return:
description: ''
type: string
- name: totalReservedQuantity
uid: '@azure/arm-consumption.ReservationSummary.totalReservedQuantity'
package: '@azure/arm-consumption'
summary: >-
This is the total count of instances that are reserved for the
reservationId.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: totalReservedQuantity
remarks: ''
isDeprecated: false
syntax:
content: 'totalReservedQuantity?: number'
return:
description: ''
type: number
- name: usageDate
uid: '@azure/arm-consumption.ReservationSummary.usageDate'
package: '@azure/arm-consumption'
summary: >-
Data corresponding to the utilization record. If the grain of data is
monthly, it will be first day of month.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: usageDate
remarks: ''
isDeprecated: false
syntax:
content: 'usageDate?: Date'
return:
description: ''
type: Date
- name: usedHours
uid: '@azure/arm-consumption.ReservationSummary.usedHours'
package: '@azure/arm-consumption'
summary: >-
Total used hours by the reservation
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: usedHours
remarks: ''
isDeprecated: false
syntax:
content: 'usedHours?: number'
return:
description: ''
type: number
- name: usedQuantity
uid: '@azure/arm-consumption.ReservationSummary.usedQuantity'
package: '@azure/arm-consumption'
summary: >-
This is the used quantity for the reservationId.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: usedQuantity
remarks: ''
isDeprecated: false
syntax:
content: 'usedQuantity?: number'
return:
description: ''
type: number
- name: utilizedPercentage
uid: '@azure/arm-consumption.ReservationSummary.utilizedPercentage'
package: '@azure/arm-consumption'
summary: >-
This is the utilized percentage for the reservation Id.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: utilizedPercentage
remarks: ''
isDeprecated: false
syntax:
content: 'utilizedPercentage?: number'
return:
description: ''
type: number
inheritedProperties:
- name: etag
uid: '@azure/arm-consumption.ReservationSummary.etag'
package: '@azure/arm-consumption'
summary: >-
The etag for the resource.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: etag
remarks: ''
isDeprecated: false
syntax:
content: 'etag?: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[Resource.etag](xref:@azure/arm-consumption.Resource.etag)
- name: id
uid: '@azure/arm-consumption.ReservationSummary.id'
package: '@azure/arm-consumption'
summary: >-
The full qualified ARM ID of an event.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: id
remarks: ''
isDeprecated: false
syntax:
content: 'id?: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[Resource.id](xref:@azure/arm-consumption.Resource.id)
- name: name
uid: '@azure/arm-consumption.ReservationSummary.name'
package: '@azure/arm-consumption'
summary: >-
The ID that uniquely identifies an event.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: name
remarks: ''
isDeprecated: false
syntax:
content: 'name?: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[Resource.name](xref:@azure/arm-consumption.Resource.name)
- name: tags
uid: '@azure/arm-consumption.ReservationSummary.tags'
package: '@azure/arm-consumption'
summary: >-
Resource tags.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: tags
remarks: ''
isDeprecated: false
syntax:
content: 'tags?: {[propertyName: string]: string}'
return:
description: ''
type: '{[propertyName: string]: string}'
inheritanceDescription: >-
<b>Inherited From</b>
[Resource.tags](xref:@azure/arm-consumption.Resource.tags)
- name: type
uid: '@azure/arm-consumption.ReservationSummary.type'
package: '@azure/arm-consumption'
summary: >-
Resource type.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: type
remarks: ''
isDeprecated: false
syntax:
content: 'type?: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[Resource.type](xref:@azure/arm-consumption.Resource.type)
extends: <xref uid="@azure/arm-consumption.Resource" />