Class: Azure::Consumption::Mgmt::V2019_05_01::Models::Balance

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

Overview

A balance 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

#adjustment_details ⇒ Array<BalancePropertiesAdjustmentDetailsItem>

Adjustments (Promo credit, SIE credit etc.).

Returns:



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

def adjustment_details
  @adjustment_details
end

#adjustments ⇒ Object

Returns Total adjustment amount.

Returns:

  • Total adjustment amount.



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

def adjustments
  @adjustments
end

#azure_marketplace_service_charges ⇒ Object

Returns Total charges for Azure Marketplace.

Returns:

  • Total charges for Azure Marketplace.



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

def azure_marketplace_service_charges
  @azure_marketplace_service_charges
end

#beginning_balance ⇒ Object

Returns The beginning balance for the billing period.

Returns:

  • The beginning balance for the billing period.



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

def beginning_balance
  @beginning_balance
end

#billing_frequency ⇒ BillingFrequency

include: ‘Month’, ‘Quarter’, ‘Year’

Returns:



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

def billing_frequency
  @billing_frequency
end

#charges_billed_separately ⇒ Object

Returns Charges Billed separately.

Returns:

  • Charges Billed separately.



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

def charges_billed_separately
  @charges_billed_separately
end

#currency ⇒ String

example, USD.

Returns:

  • (String) —

    The ISO currency in which the meter is charged, for



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

def currency
  @currency
end

#ending_balance ⇒ Object

this will be updated daily).

Returns:

  • The ending balance for the billing period (for open periods



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

def ending_balance
  @ending_balance
end

#new_purchases ⇒ Object

Returns Total new purchase amount.

Returns:

  • Total new purchase amount.



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

def new_purchases
  @new_purchases
end

#new_purchases_details ⇒ Array<BalancePropertiesNewPurchasesDetailsItem>

purchases.

Returns:



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

def new_purchases_details
  @new_purchases_details
end

#price_hidden ⇒ Boolean

Returns Price is hidden or not.

Returns:

  • (Boolean) —

    Price is hidden or not.



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

def price_hidden
  @price_hidden
end

#service_overage ⇒ Object

Returns Overage for Azure services.

Returns:

  • Overage for Azure services.



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

def service_overage
  @service_overage
end

#total_overage ⇒ Object

Returns serviceOverage + chargesBilledSeparately.

Returns:

  • serviceOverage + chargesBilledSeparately.



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

def total_overage
  @total_overage
end

#total_usage ⇒ Object

Returns Azure service commitment + total Overage.

Returns:

  • Azure service commitment + total Overage.



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

def total_usage
  @total_usage
end

#utilized ⇒ Object

Returns Total Commitment usage.

Returns:

  • Total Commitment usage.



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

def utilized
  @utilized
end

Class Method Details

.mapper ⇒ Object

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



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
 
# File 'lib/2019-05-01/generated/azure_mgmt_consumption/models/balance.rb', line 70

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'Balance',
    type: {
      name: 'Composite',
      class_name: 'Balance',
      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'
                }
            }
          }
        },
        currency: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.currency',
          type: {
            name: 'String'
          }
        },
        beginning_balance: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.beginningBalance',
          type: {
            name: 'Number'
          }
        },
        ending_balance: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.endingBalance',
          type: {
            name: 'Number'
          }
        },
        new_purchases: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.newPurchases',
          type: {
            name: 'Number'
          }
        },
        adjustments: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.adjustments',
          type: {
            name: 'Number'
          }
        },
        utilized: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.utilized',
          type: {
            name: 'Number'
          }
        },
        service_overage: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.serviceOverage',
          type: {
            name: 'Number'
          }
        },
        charges_billed_separately: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.chargesBilledSeparately',
          type: {
            name: 'Number'
          }
        },
        total_overage: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.totalOverage',
          type: {
            name: 'Number'
          }
        },
        total_usage: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.totalUsage',
          type: {
            name: 'Number'
          }
        },
        azure_marketplace_service_charges: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.azureMarketplaceServiceCharges',
          type: {
            name: 'Number'
          }
        },
        billing_frequency: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.billingFrequency',
          type: {
            name: 'String'
          }
        },
        price_hidden: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.priceHidden',
          type: {
            name: 'Boolean'
          }
        },
        new_purchases_details: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.newPurchasesDetails',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'BalancePropertiesNewPurchasesDetailsItemElementType',
                type: {
                  name: 'Composite',
                  class_name: 'BalancePropertiesNewPurchasesDetailsItem'
                }
            }
          }
        },
        adjustment_details: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.adjustmentDetails',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'BalancePropertiesAdjustmentDetailsItemElementType',
                type: {
                  name: 'Composite',
                  class_name: 'BalancePropertiesAdjustmentDetailsItem'
                }
            }
          }
        }
      }
    }
  }
end