Class: Azure::ARM::Billing::BillingPeriods

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/generated/azure_mgmt_billing/billing_periods.rb

Overview

Billing client provides access to billing resources for Azure Web-Direct subscriptions. Other subscription types which were not purchased directly through the Azure web portal are not supported through this preview API.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ BillingPeriods

Creates and initializes a new instance of the BillingPeriods class.

Parameters:

  • client —

    service class for accessing basic functionality.



19
20
21
 
# File 'lib/generated/azure_mgmt_billing/billing_periods.rb', line 19

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ BillingManagementClient (readonly)

Returns reference to the BillingManagementClient.

Returns:



24
25
26
 
# File 'lib/generated/azure_mgmt_billing/billing_periods.rb', line 24

def client
  @client
end

Instance Method Details

#get(billing_period_name, custom_headers = nil) ⇒ BillingPeriod

Gets a named billing period.

will be added to the HTTP request.

Parameters:

  • billing_period_name (String) —

    The name of a BillingPeriod resource.

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (BillingPeriod) —

    operation results.



148
149
150
151
 
# File 'lib/generated/azure_mgmt_billing/billing_periods.rb', line 148

def get(billing_period_name, custom_headers = nil)
  response = get_async(billing_period_name, custom_headers).value!
  response.body unless response.nil?
end

#get_async(billing_period_name, custom_headers = nil) ⇒ Concurrent::Promise

Gets a named billing period.

to the HTTP request.

Parameters:

  • billing_period_name (String) —

    The name of a BillingPeriod resource.

  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
 
# File 'lib/generated/azure_mgmt_billing/billing_periods.rb', line 175

def get_async(billing_period_name, custom_headers = nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'billing_period_name is nil' if billing_period_name.nil?


  request_headers = {}

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'billingPeriodName' => billing_period_name},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:get, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::ARM::Billing::Models::BillingPeriod.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#get_with_http_info(billing_period_name, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Gets a named billing period.

will be added to the HTTP request.

Parameters:

  • billing_period_name (String) —

    The name of a BillingPeriod resource.

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



162
163
164
 
# File 'lib/generated/azure_mgmt_billing/billing_periods.rb', line 162

def get_with_http_info(billing_period_name, custom_headers = nil)
  get_async(billing_period_name, custom_headers).value!
end

#list(filter = nil, skiptoken = nil, top = nil, custom_headers = nil) ⇒ Array<BillingPeriod>

Lists the available billing periods for a subscription in reverse chronological order.

billingPeriodEndDate. The filter supports ‘eq’, ‘lt’, ‘gt’, ‘le’, ‘ge’, and ‘and’. It does not currently support ‘ne’, ‘or’, or ‘not’. returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. recent N billing periods. will be added to the HTTP request.

Parameters:

  • filter (String) (defaults to: nil) —

    May be used to filter billing periods by

  • skiptoken (String) (defaults to: nil) —

    Skiptoken is only used if a previous operation

  • top (Integer) (defaults to: nil) —

    May be used to limit the number of results to the most

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (Array<BillingPeriod>) —

    operation results.



44
45
46
47
 
# File 'lib/generated/azure_mgmt_billing/billing_periods.rb', line 44

def list(filter = nil, skiptoken = nil, top = nil, custom_headers = nil)
  first_page = list_as_lazy(filter, skiptoken, top, custom_headers)
  first_page.get_all_items
end

#list_as_lazy(filter = nil, skiptoken = nil, top = nil, custom_headers = nil) ⇒ BillingPeriodsListResult

Lists the available billing periods for a subscription in reverse chronological order.

billingPeriodEndDate. The filter supports ‘eq’, ‘lt’, ‘gt’, ‘le’, ‘ge’, and ‘and’. It does not currently support ‘ne’, ‘or’, or ‘not’. returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. recent N billing periods. will be added to the HTTP request.

response.

Parameters:

  • filter (String) (defaults to: nil) —

    May be used to filter billing periods by

  • skiptoken (String) (defaults to: nil) —

    Skiptoken is only used if a previous operation

  • top (Integer) (defaults to: nil) —

    May be used to limit the number of results to the most

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (BillingPeriodsListResult) —

    which provide lazy access to pages of the



335
336
337
338
339
340
341
342
343
344
 
# File 'lib/generated/azure_mgmt_billing/billing_periods.rb', line 335

def list_as_lazy(filter = nil, skiptoken = nil, top = nil, custom_headers = nil)
  response = list_async(filter, skiptoken, top, custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_next_async(next_page_link, custom_headers)
    end
    page
  end
end

#list_async(filter = nil, skiptoken = nil, top = nil, custom_headers = nil) ⇒ Concurrent::Promise

Lists the available billing periods for a subscription in reverse chronological order.

billingPeriodEndDate. The filter supports ‘eq’, ‘lt’, ‘gt’, ‘le’, ‘ge’, and ‘and’. It does not currently support ‘ne’, ‘or’, or ‘not’. returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. recent N billing periods. to the HTTP request.

Parameters:

  • filter (String) (defaults to: nil) —

    May be used to filter billing periods by

  • skiptoken (String) (defaults to: nil) —

    Skiptoken is only used if a previous operation

  • top (Integer) (defaults to: nil) —

    May be used to limit the number of results to the most

  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
 
# File 'lib/generated/azure_mgmt_billing/billing_periods.rb', line 89

def list_async(filter = nil, skiptoken = nil, top = nil, custom_headers = nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?


  request_headers = {}

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingPeriods'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version,'$filter' => filter,'$skiptoken' => skiptoken,'$top' => top},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:get, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::ARM::Billing::Models::BillingPeriodsListResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#list_next(next_page_link, custom_headers = nil) ⇒ BillingPeriodsListResult

Lists the available billing periods for a subscription in reverse chronological order.

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (BillingPeriodsListResult) —

    operation results.



237
238
239
240
 
# File 'lib/generated/azure_mgmt_billing/billing_periods.rb', line 237

def list_next(next_page_link, custom_headers = nil)
  response = list_next_async(next_page_link, custom_headers).value!
  response.body unless response.nil?
end

#list_next_async(next_page_link, custom_headers = nil) ⇒ Concurrent::Promise

Lists the available billing periods for a subscription in reverse chronological order.

to List operation. to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
 
# File 'lib/generated/azure_mgmt_billing/billing_periods.rb', line 268

def list_next_async(next_page_link, custom_headers = nil)
  fail ArgumentError, 'next_page_link is nil' if next_page_link.nil?


  request_headers = {}

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = '{nextLink}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      skip_encoding_path_params: {'nextLink' => next_page_link},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:get, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::ARM::Billing::Models::BillingPeriodsListResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#list_next_with_http_info(next_page_link, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Lists the available billing periods for a subscription in reverse chronological order.

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



253
254
255
 
# File 'lib/generated/azure_mgmt_billing/billing_periods.rb', line 253

def list_next_with_http_info(next_page_link, custom_headers = nil)
  list_next_async(next_page_link, custom_headers).value!
end

#list_with_http_info(filter = nil, skiptoken = nil, top = nil, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Lists the available billing periods for a subscription in reverse chronological order.

billingPeriodEndDate. The filter supports ‘eq’, ‘lt’, ‘gt’, ‘le’, ‘ge’, and ‘and’. It does not currently support ‘ne’, ‘or’, or ‘not’. returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. recent N billing periods. will be added to the HTTP request.

Parameters:

  • filter (String) (defaults to: nil) —

    May be used to filter billing periods by

  • skiptoken (String) (defaults to: nil) —

    Skiptoken is only used if a previous operation

  • top (Integer) (defaults to: nil) —

    May be used to limit the number of results to the most

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



67
68
69
 
# File 'lib/generated/azure_mgmt_billing/billing_periods.rb', line 67

def list_with_http_info(filter = nil, skiptoken = nil, top = nil, custom_headers = nil)
  list_async(filter, skiptoken, top, custom_headers).value!
end