Class: Azure::Consumption::Mgmt::V2019_05_01::Models::UsageDetail

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

Overview

An usage detail resource.

Instance Attribute Summary collapse

Attributes inherited from Resource

#id, #name, #tags, #type

Class Method Summary collapse

Instance Attribute Details

#account_name ⇒ String

Returns Account Name.

Returns:

  • (String) —

    Account Name.



37
38
39
 
# File 'lib/2019-05-01/generated/azure_mgmt_consumption/models/usage_detail.rb', line 37

def 
  @account_name
end

#account_owner_id ⇒ String

Returns Account Owner Id.

Returns:

  • (String) —

    Account Owner Id.



34
35
36
 
# File 'lib/2019-05-01/generated/azure_mgmt_consumption/models/usage_detail.rb', line 34

def 
  @account_owner_id
end

#additional_info ⇒ String

is not populated, unless it's specified in $expand. Use this field to get usage line item specific details such as the actual VM Size (ServiceType) or the ratio in which the reservation discount is applied.

Returns:

  • (String) —

    Additional details of this usage item. By default this



107
108
109
 
# File 'lib/2019-05-01/generated/azure_mgmt_consumption/models/usage_detail.rb', line 107

def additional_info
  @additional_info
end

#billing_account_id ⇒ String

Returns Billing Account identifier.

Returns:

  • (String) —

    Billing Account identifier.



16
17
18
 
# File 'lib/2019-05-01/generated/azure_mgmt_consumption/models/usage_detail.rb', line 16

def 
  @billing_account_id
end

#billing_account_name ⇒ String

Returns Billing Account Name.

Returns:

  • (String) —

    Billing Account Name.



19
20
21
 
# File 'lib/2019-05-01/generated/azure_mgmt_consumption/models/usage_detail.rb', line 19

def 
  @billing_account_name
end

#billing_currency ⇒ String

Returns Billing Currency.

Returns:

  • (String) —

    Billing Currency.



80
81
82
 
# File 'lib/2019-05-01/generated/azure_mgmt_consumption/models/usage_detail.rb', line 80

def billing_currency
  @billing_currency
end

#billing_period_end_date ⇒ DateTime

Returns The billing period end date.

Returns:

  • (DateTime) —

    The billing period end date.



25
26
27
 
# File 'lib/2019-05-01/generated/azure_mgmt_consumption/models/usage_detail.rb', line 25

def billing_period_end_date
  @billing_period_end_date
end

#billing_period_start_date ⇒ DateTime

Returns The billing period start date.

Returns:

  • (DateTime) —

    The billing period start date.



22
23
24
 
# File 'lib/2019-05-01/generated/azure_mgmt_consumption/models/usage_detail.rb', line 22

def billing_period_start_date
  @billing_period_start_date
end

#billing_profile_id ⇒ String

Returns Billing Profile identifier.

Returns:

  • (String) —

    Billing Profile identifier.



28
29
30
 
# File 'lib/2019-05-01/generated/azure_mgmt_consumption/models/usage_detail.rb', line 28

def billing_profile_id
  @billing_profile_id
end

#billing_profile_name ⇒ String

Returns Billing Profile Name.

Returns:

  • (String) —

    Billing Profile Name.



31
32
33
 
# File 'lib/2019-05-01/generated/azure_mgmt_consumption/models/usage_detail.rb', line 31

def billing_profile_name
  @billing_profile_name
end

#charge_type ⇒ String

Marketplace purchase, a reservation fee, or a refund.

Returns:

  • (String) —

    Indicates a charge represents credits, usage, a



158
159
160
 
# File 'lib/2019-05-01/generated/azure_mgmt_consumption/models/usage_detail.rb', line 158

def charge_type
  @charge_type
end

#consumed_service ⇒ String

provider that emits the usage or was purchased. This value is not provided for marketplace usage.

Returns:

  • (String) —

    Consumed service name. Name of the azure resource



88
89
90
 
# File 'lib/2019-05-01/generated/azure_mgmt_consumption/models/usage_detail.rb', line 88

def consumed_service
  @consumed_service
end

#cost ⇒ Object

Returns The amount of cost before tax.

Returns:

  • The amount of cost before tax.



73
74
75
 
# File 'lib/2019-05-01/generated/azure_mgmt_consumption/models/usage_detail.rb', line 73

def cost
  @cost
end

#cost_center ⇒ String

department and a cost center is provided.

Returns:

  • (String) —

    The cost center of this department if it is a



114
115
116
 
# File 'lib/2019-05-01/generated/azure_mgmt_consumption/models/usage_detail.rb', line 114

def cost_center
  @cost_center
end

#date ⇒ DateTime

Returns Date for the usage record.

Returns:

  • (DateTime) —

    Date for the usage record.



46
47
48
 
# File 'lib/2019-05-01/generated/azure_mgmt_consumption/models/usage_detail.rb', line 46

def date
  @date
end

#effective_price ⇒ Object

Returns Effective Price that’s charged for the usage.

Returns:

  • Effective Price that’s charged for the usage.



70
71
72
 
# File 'lib/2019-05-01/generated/azure_mgmt_consumption/models/usage_detail.rb', line 70

def effective_price
  @effective_price
end

#frequency ⇒ String

OneTime for purchases which only happen once, Monthly for fees which recur every month, and UsageBased for charges based on how much a service is used.

Returns:

  • (String) —

    Indicates how frequently this charge will occur.



164
165
166
 
# File 'lib/2019-05-01/generated/azure_mgmt_consumption/models/usage_detail.rb', line 164

def frequency
  @frequency
end

#invoice_section ⇒ String

Returns Invoice Section Name.

Returns:

  • (String) —

    Invoice Section Name.



110
111
112
 
# File 'lib/2019-05-01/generated/azure_mgmt_consumption/models/usage_detail.rb', line 110

def invoice_section
  @invoice_section
end

#is_azure_credit_eligible ⇒ Boolean

Returns Is Azure Credit Eligible.

Returns:

  • (Boolean) —

    Is Azure Credit Eligible.



140
141
142
 
# File 'lib/2019-05-01/generated/azure_mgmt_consumption/models/usage_detail.rb', line 140

def is_azure_credit_eligible
  @is_azure_credit_eligible
end

#meter_details ⇒ MeterDetailsResponse

this is not populated, unless it's specified in $expand.

Returns:



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

def meter_details
  @meter_details
end

#meter_id ⇒ Object

reserved instance this represents the primary meter for which the reservation was purchased. For the actual VM Size for which the reservation is purchased see productOrderName.

Returns:

  • The meter id (GUID). Not available for marketplace. For



60
61
62
 
# File 'lib/2019-05-01/generated/azure_mgmt_consumption/models/usage_detail.rb', line 60

def meter_id
  @meter_id
end

#offer_id ⇒ String

Returns Offer Id. Ex: MS-AZR-0017P, MS-AZR-0148P.

Returns:

  • (String) —

    Offer Id. Ex: MS-AZR-0017P, MS-AZR-0148P.



137
138
139
 
# File 'lib/2019-05-01/generated/azure_mgmt_consumption/models/usage_detail.rb', line 137

def offer_id
  @offer_id
end

#part_number ⇒ String

with the price sheet. Not available for marketplace.

Returns:

  • (String) —

    Part Number of the service used. Can be used to join



54
55
56
 
# File 'lib/2019-05-01/generated/azure_mgmt_consumption/models/usage_detail.rb', line 54

def part_number
  @part_number
end

#plan_name ⇒ String

Returns Plan Name.

Returns:

  • (String) —

    Plan Name.



154
155
156
 
# File 'lib/2019-05-01/generated/azure_mgmt_consumption/models/usage_detail.rb', line 154

def plan_name
  @plan_name
end

#product ⇒ String

available for Marketplace.

Returns:

  • (String) —

    Product name for the consumed service or purchase. Not



50
51
52
 
# File 'lib/2019-05-01/generated/azure_mgmt_consumption/models/usage_detail.rb', line 50

def product
  @product
end

#product_order_id ⇒ String

Reservation Order ID.

Returns:

  • (String) —

    Product Order Id. For reservations this is the



130
131
132
 
# File 'lib/2019-05-01/generated/azure_mgmt_consumption/models/usage_detail.rb', line 130

def product_order_id
  @product_order_id
end

#product_order_name ⇒ String

that was purchased.

Returns:

  • (String) —

    Product Order Name. For reservations this is the SKU



134
135
136
 
# File 'lib/2019-05-01/generated/azure_mgmt_consumption/models/usage_detail.rb', line 134

def product_order_name
  @product_order_name
end

#publisher_name ⇒ String

Returns Publisher Name.

Returns:

  • (String) —

    Publisher Name.



148
149
150
 
# File 'lib/2019-05-01/generated/azure_mgmt_consumption/models/usage_detail.rb', line 148

def publisher_name
  @publisher_name
end

#publisher_type ⇒ String

Returns Publisher Type.

Returns:

  • (String) —

    Publisher Type.



151
152
153
 
# File 'lib/2019-05-01/generated/azure_mgmt_consumption/models/usage_detail.rb', line 151

def publisher_type
  @publisher_type
end

#quantity ⇒ Object

Returns The usage quantity.

Returns:

  • The usage quantity.



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

def quantity
  @quantity
end

#reservation_id ⇒ String

records relevant to reservations.

Returns:

  • (String) —

    ARM resource id of the reservation. Only applies to



121
122
123
 
# File 'lib/2019-05-01/generated/azure_mgmt_consumption/models/usage_detail.rb', line 121

def reservation_id
  @reservation_id
end

#reservation_name ⇒ String

known name for a particular day is populated in the daily data. Only applies to records relevant to reservations.

Returns:

  • (String) —

    User provided display name of the reservation. Last



126
127
128
 
# File 'lib/2019-05-01/generated/azure_mgmt_consumption/models/usage_detail.rb', line 126

def reservation_name
  @reservation_name
end

#resource_group ⇒ String

Returns Resource Group Name.

Returns:

  • (String) —

    Resource Group Name.



117
118
119
 
# File 'lib/2019-05-01/generated/azure_mgmt_consumption/models/usage_detail.rb', line 117

def resource_group
  @resource_group
end

#resource_id ⇒ String

Returns Azure resource manager resource identifier.

Returns:

  • (String) —

    Azure resource manager resource identifier.



91
92
93
 
# File 'lib/2019-05-01/generated/azure_mgmt_consumption/models/usage_detail.rb', line 91

def resource_id
  @resource_id
end

#resource_location ⇒ String

Returns Resource Location.

Returns:

  • (String) —

    Resource Location.



83
84
85
 
# File 'lib/2019-05-01/generated/azure_mgmt_consumption/models/usage_detail.rb', line 83

def resource_location
  @resource_location
end

#resource_name ⇒ String

Returns Resource Name.

Returns:

  • (String) —

    Resource Name.



94
95
96
 
# File 'lib/2019-05-01/generated/azure_mgmt_consumption/models/usage_detail.rb', line 94

def resource_name
  @resource_name
end

#service_info1 ⇒ String

Returns Service Info 1.

Returns:

  • (String) —

    Service Info 1.



97
98
99
 
# File 'lib/2019-05-01/generated/azure_mgmt_consumption/models/usage_detail.rb', line 97

def service_info1
  @service_info1
end

#service_info2 ⇒ String

Returns Service Info 2.

Returns:

  • (String) —

    Service Info 2.



100
101
102
 
# File 'lib/2019-05-01/generated/azure_mgmt_consumption/models/usage_detail.rb', line 100

def service_info2
  @service_info2
end

#subscription_id ⇒ String

Returns Subscription guid.

Returns:

  • (String) —

    Subscription guid.



40
41
42
 
# File 'lib/2019-05-01/generated/azure_mgmt_consumption/models/usage_detail.rb', line 40

def subscription_id
  @subscription_id
end

#subscription_name ⇒ String

Returns Subscription name.

Returns:

  • (String) —

    Subscription name.



43
44
45
 
# File 'lib/2019-05-01/generated/azure_mgmt_consumption/models/usage_detail.rb', line 43

def subscription_name
  @subscription_name
end

#term ⇒ String

purchase. 12 months for a 1 year reservation. 36 months for a 3 year reservation.

Returns:

  • (String) —

    Term (in months). 1 month for monthly recurring



145
146
147
 
# File 'lib/2019-05-01/generated/azure_mgmt_consumption/models/usage_detail.rb', line 145

def term
  @term
end

#unit_price ⇒ Object

contract price).

Returns:

  • Unit Price is the price applicable to you. (your EA or other



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

def unit_price
  @unit_price
end

Class Method Details

.mapper ⇒ Object

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



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
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
 
# File 'lib/2019-05-01/generated/azure_mgmt_consumption/models/usage_detail.rb', line 171

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'UsageDetail',
    type: {
      name: 'Composite',
      class_name: 'UsageDetail',
      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'
                }
            }
          }
        },
        billing_account_id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.billingAccountId',
          type: {
            name: 'String'
          }
        },
        billing_account_name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.billingAccountName',
          type: {
            name: 'String'
          }
        },
        billing_period_start_date: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.billingPeriodStartDate',
          type: {
            name: 'DateTime'
          }
        },
        billing_period_end_date: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.billingPeriodEndDate',
          type: {
            name: 'DateTime'
          }
        },
        billing_profile_id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.billingProfileId',
          type: {
            name: 'String'
          }
        },
        billing_profile_name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.billingProfileName',
          type: {
            name: 'String'
          }
        },
        account_owner_id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.accountOwnerId',
          type: {
            name: 'String'
          }
        },
        account_name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.accountName',
          type: {
            name: 'String'
          }
        },
        subscription_id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.subscriptionId',
          type: {
            name: 'String'
          }
        },
        subscription_name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.subscriptionName',
          type: {
            name: 'String'
          }
        },
        date: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.date',
          type: {
            name: 'DateTime'
          }
        },
        product: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.product',
          type: {
            name: 'String'
          }
        },
        part_number: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.partNumber',
          type: {
            name: 'String'
          }
        },
        meter_id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.meterId',
          type: {
            name: 'String'
          }
        },
        meter_details: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.meterDetails',
          type: {
            name: 'Composite',
            class_name: 'MeterDetailsResponse'
          }
        },
        quantity: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.quantity',
          type: {
            name: 'Number'
          }
        },
        effective_price: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.effectivePrice',
          type: {
            name: 'Number'
          }
        },
        cost: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.cost',
          type: {
            name: 'Number'
          }
        },
        unit_price: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.unitPrice',
          type: {
            name: 'Number'
          }
        },
        billing_currency: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.billingCurrency',
          type: {
            name: 'String'
          }
        },
        resource_location: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.resourceLocation',
          type: {
            name: 'String'
          }
        },
        consumed_service: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.consumedService',
          type: {
            name: 'String'
          }
        },
        resource_id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.resourceId',
          type: {
            name: 'String'
          }
        },
        resource_name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.resourceName',
          type: {
            name: 'String'
          }
        },
        service_info1: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.serviceInfo1',
          type: {
            name: 'String'
          }
        },
        service_info2: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.serviceInfo2',
          type: {
            name: 'String'
          }
        },
        additional_info: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.additionalInfo',
          type: {
            name: 'String'
          }
        },
        invoice_section: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.invoiceSection',
          type: {
            name: 'String'
          }
        },
        cost_center: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.costCenter',
          type: {
            name: 'String'
          }
        },
        resource_group: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.resourceGroup',
          type: {
            name: 'String'
          }
        },
        reservation_id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.reservationId',
          type: {
            name: 'String'
          }
        },
        reservation_name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.reservationName',
          type: {
            name: 'String'
          }
        },
        product_order_id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.productOrderId',
          type: {
            name: 'String'
          }
        },
        product_order_name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.productOrderName',
          type: {
            name: 'String'
          }
        },
        offer_id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.offerId',
          type: {
            name: 'String'
          }
        },
        is_azure_credit_eligible: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.isAzureCreditEligible',
          type: {
            name: 'Boolean'
          }
        },
        term: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.term',
          type: {
            name: 'String'
          }
        },
        publisher_name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.publisherName',
          type: {
            name: 'String'
          }
        },
        publisher_type: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.publisherType',
          type: {
            name: 'String'
          }
        },
        plan_name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.planName',
          type: {
            name: 'String'
          }
        },
        charge_type: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.chargeType',
          type: {
            name: 'String'
          }
        },
        frequency: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.frequency',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end