Class: Azure::Consumption::Mgmt::V2019_10_01::ReservationsDetails

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-10-01/generated/azure_mgmt_consumption/reservations_details.rb

Overview

Consumption management client provides access to consumption resources for Azure Enterprise Subscriptions.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ ReservationsDetails

Creates and initializes a new instance of the ReservationsDetails class.

Parameters:

  • client —

    service class for accessing basic functionality.



18
19
20
 
# File 'lib/2019-10-01/generated/azure_mgmt_consumption/reservations_details.rb', line 18

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ ConsumptionManagementClient (readonly)

Returns reference to the ConsumptionManagementClient.

Returns:



23
24
25
 
# File 'lib/2019-10-01/generated/azure_mgmt_consumption/reservations_details.rb', line 23

def client
  @client
end

Instance Method Details

#list(scope, start_date: nil, end_date: nil, filter: nil, custom_headers: nil) ⇒ Array<ReservationDetail>

Lists the reservations details for the defined scope and provided date range.

operations. This includes '/providers/Microsoft.Billing/billingAccounts/billingAccountId' for BillingAccount scope (legacy), and '/providers/Microsoft.Billing/billingAccounts/billingAccountId/billingProfiles/billingProfileId' for BillingProfile scope (modern). properties/UsageDate for start date and end date. The filter supports 'le' and 'ge' will be added to the HTTP request.

Parameters:

  • scope (String) —

    The scope associated with reservations details

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

    Start date

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

    End date

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

    Filter reservation details by date range. The

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

    A hash of custom headers that

Returns:

  • (Array<ReservationDetail>) —

    operation results.



246
247
248
249
 
# File 'lib/2019-10-01/generated/azure_mgmt_consumption/reservations_details.rb', line 246

def list(scope, start_date:nil, end_date:nil, filter:nil, custom_headers:nil)
  first_page = list_as_lazy(scope, start_date:start_date, end_date:end_date, filter:filter, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_as_lazy(scope, start_date: nil, end_date: nil, filter: nil, custom_headers: nil) ⇒ ReservationDetailsListResult

Lists the reservations details for the defined scope and provided date range.

operations. This includes '/providers/Microsoft.Billing/billingAccounts/billingAccountId' for BillingAccount scope (legacy), and '/providers/Microsoft.Billing/billingAccounts/billingAccountId/billingProfiles/billingProfileId' for BillingProfile scope (modern). properties/UsageDate for start date and end date. The filter supports 'le' and 'ge' will be added to the HTTP request.

the response.

Parameters:

  • scope (String) —

    The scope associated with reservations details

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

    Start date

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

    End date

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

    Filter reservation details by date range. The

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

    A hash of custom headers that

Returns:

  • (ReservationDetailsListResult) —

    which provide lazy access to pages of



685
686
687
688
689
690
691
692
693
694
 
# File 'lib/2019-10-01/generated/azure_mgmt_consumption/reservations_details.rb', line 685

def list_as_lazy(scope, start_date:nil, end_date:nil, filter:nil, custom_headers:nil)
  response = list_async(scope, start_date:start_date, end_date:end_date, filter:filter, custom_headers: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:custom_headers)
    end
    page
  end
end

#list_async(scope, start_date: nil, end_date: nil, filter: nil, custom_headers: nil) ⇒ Concurrent::Promise

Lists the reservations details for the defined scope and provided date range.

operations. This includes '/providers/Microsoft.Billing/billingAccounts/billingAccountId' for BillingAccount scope (legacy), and '/providers/Microsoft.Billing/billingAccounts/billingAccountId/billingProfiles/billingProfileId' for BillingProfile scope (modern). properties/UsageDate for start date and end date. The filter supports 'le' and 'ge' to the HTTP request.

Parameters:

  • scope (String) —

    The scope associated with reservations details

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

    Start date

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

    End date

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

    Filter reservation details by date range. The

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
 
# File 'lib/2019-10-01/generated/azure_mgmt_consumption/reservations_details.rb', line 293

def list_async(scope, start_date:nil, end_date:nil, filter:nil, custom_headers:nil)
  fail ArgumentError, 'scope is nil' if scope.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # 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 = '{scope}/providers/Microsoft.Consumption/reservationDetails'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      skip_encoding_path_params: {'scope' => scope},
      query_params: {'startDate' => start_date,'endDate' => end_date,'$filter' => filter,'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?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-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::Consumption::Mgmt::V2019_10_01::Models::ReservationDetailsListResult.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_by_reservation_order(reservation_order_id, filter, custom_headers: nil) ⇒ Array<ReservationDetail>

Lists the reservations details for provided date range.

properties/UsageDate for start date and end date. The filter supports 'le' and 'ge' will be added to the HTTP request.

Parameters:

  • reservation_order_id (String) —

    Order Id of the reservation

  • filter (String) —

    Filter reservation details by date range. The

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

    A hash of custom headers that

Returns:

  • (Array<ReservationDetail>) —

    operation results.



37
38
39
40
 
# File 'lib/2019-10-01/generated/azure_mgmt_consumption/reservations_details.rb', line 37

def list_by_reservation_order(reservation_order_id, filter, custom_headers:nil)
  first_page = list_by_reservation_order_as_lazy(reservation_order_id, filter, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_by_reservation_order_and_reservation(reservation_order_id, reservation_id, filter, custom_headers: nil) ⇒ Array<ReservationDetail>

Lists the reservations details for provided date range.

properties/UsageDate for start date and end date. The filter supports 'le' and 'ge' will be added to the HTTP request.

Parameters:

  • reservation_order_id (String) —

    Order Id of the reservation

  • reservation_id (String) —

    Id of the reservation

  • filter (String) —

    Filter reservation details by date range. The

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

    A hash of custom headers that

Returns:

  • (Array<ReservationDetail>) —

    operation results.



137
138
139
140
 
# File 'lib/2019-10-01/generated/azure_mgmt_consumption/reservations_details.rb', line 137

def list_by_reservation_order_and_reservation(reservation_order_id, reservation_id, filter, custom_headers:nil)
  first_page = list_by_reservation_order_and_reservation_as_lazy(reservation_order_id, reservation_id, filter, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_by_reservation_order_and_reservation_as_lazy(reservation_order_id, reservation_id, filter, custom_headers: nil) ⇒ ReservationDetailsListResult

Lists the reservations details for provided date range.

properties/UsageDate for start date and end date. The filter supports 'le' and 'ge' will be added to the HTTP request.

the response.

Parameters:

  • reservation_order_id (String) —

    Order Id of the reservation

  • reservation_id (String) —

    Id of the reservation

  • filter (String) —

    Filter reservation details by date range. The

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

    A hash of custom headers that

Returns:

  • (ReservationDetailsListResult) —

    which provide lazy access to pages of



654
655
656
657
658
659
660
661
662
663
 
# File 'lib/2019-10-01/generated/azure_mgmt_consumption/reservations_details.rb', line 654

def list_by_reservation_order_and_reservation_as_lazy(reservation_order_id, reservation_id, filter, custom_headers:nil)
  response = list_by_reservation_order_and_reservation_async(reservation_order_id, reservation_id, filter, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_by_reservation_order_and_reservation_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

#list_by_reservation_order_and_reservation_async(reservation_order_id, reservation_id, filter, custom_headers: nil) ⇒ Concurrent::Promise

Lists the reservations details for provided date range.

properties/UsageDate for start date and end date. The filter supports 'le' and 'ge' to the HTTP request.

Parameters:

  • reservation_order_id (String) —

    Order Id of the reservation

  • reservation_id (String) —

    Id of the reservation

  • filter (String) —

    Filter reservation details by date range. The

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
 
# File 'lib/2019-10-01/generated/azure_mgmt_consumption/reservations_details.rb', line 172

def list_by_reservation_order_and_reservation_async(reservation_order_id, reservation_id, filter, custom_headers:nil)
  fail ArgumentError, 'reservation_order_id is nil' if reservation_order_id.nil?
  fail ArgumentError, 'reservation_id is nil' if reservation_id.nil?
  fail ArgumentError, 'filter is nil' if filter.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # 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 = 'providers/Microsoft.Capacity/reservationorders/{reservationOrderId}/reservations/{reservationId}/providers/Microsoft.Consumption/reservationDetails'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'reservationOrderId' => reservation_order_id,'reservationId' => reservation_id},
      query_params: {'$filter' => filter,'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?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-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::Consumption::Mgmt::V2019_10_01::Models::ReservationDetailsListResult.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_by_reservation_order_and_reservation_next(next_page_link, custom_headers: nil) ⇒ ReservationDetailsListResult

Lists the reservations details for provided date range.

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:

  • (ReservationDetailsListResult) —

    operation results.



446
447
448
449
 
# File 'lib/2019-10-01/generated/azure_mgmt_consumption/reservations_details.rb', line 446

def list_by_reservation_order_and_reservation_next(next_page_link, custom_headers:nil)
  response = list_by_reservation_order_and_reservation_next_async(next_page_link, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#list_by_reservation_order_and_reservation_next_async(next_page_link, custom_headers: nil) ⇒ Concurrent::Promise

Lists the reservations details for provided date range.

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.



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
 
# File 'lib/2019-10-01/generated/azure_mgmt_consumption/reservations_details.rb', line 475

def list_by_reservation_order_and_reservation_next_async(next_page_link, custom_headers:nil)
  fail ArgumentError, 'next_page_link is nil' if next_page_link.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # 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?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-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::Consumption::Mgmt::V2019_10_01::Models::ReservationDetailsListResult.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_by_reservation_order_and_reservation_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists the reservations details for provided date range.

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.



461
462
463
 
# File 'lib/2019-10-01/generated/azure_mgmt_consumption/reservations_details.rb', line 461

def list_by_reservation_order_and_reservation_next_with_http_info(next_page_link, custom_headers:nil)
  list_by_reservation_order_and_reservation_next_async(next_page_link, custom_headers:custom_headers).value!
end

#list_by_reservation_order_and_reservation_with_http_info(reservation_order_id, reservation_id, filter, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists the reservations details for provided date range.

properties/UsageDate for start date and end date. The filter supports 'le' and 'ge' will be added to the HTTP request.

Parameters:

  • reservation_order_id (String) —

    Order Id of the reservation

  • reservation_id (String) —

    Id of the reservation

  • filter (String) —

    Filter reservation details by date range. The

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



155
156
157
 
# File 'lib/2019-10-01/generated/azure_mgmt_consumption/reservations_details.rb', line 155

def list_by_reservation_order_and_reservation_with_http_info(reservation_order_id, reservation_id, filter, custom_headers:nil)
  list_by_reservation_order_and_reservation_async(reservation_order_id, reservation_id, filter, custom_headers:custom_headers).value!
end

#list_by_reservation_order_as_lazy(reservation_order_id, filter, custom_headers: nil) ⇒ ReservationDetailsListResult

Lists the reservations details for provided date range.

properties/UsageDate for start date and end date. The filter supports 'le' and 'ge' will be added to the HTTP request.

the response.

Parameters:

  • reservation_order_id (String) —

    Order Id of the reservation

  • filter (String) —

    Filter reservation details by date range. The

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

    A hash of custom headers that

Returns:

  • (ReservationDetailsListResult) —

    which provide lazy access to pages of



629
630
631
632
633
634
635
636
637
638
 
# File 'lib/2019-10-01/generated/azure_mgmt_consumption/reservations_details.rb', line 629

def list_by_reservation_order_as_lazy(reservation_order_id, filter, custom_headers:nil)
  response = list_by_reservation_order_async(reservation_order_id, filter, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_by_reservation_order_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

#list_by_reservation_order_async(reservation_order_id, filter, custom_headers: nil) ⇒ Concurrent::Promise

Lists the reservations details for provided date range.

properties/UsageDate for start date and end date. The filter supports 'le' and 'ge' to the HTTP request.

Parameters:

  • reservation_order_id (String) —

    Order Id of the reservation

  • filter (String) —

    Filter reservation details by date range. The

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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

def list_by_reservation_order_async(reservation_order_id, filter, custom_headers:nil)
  fail ArgumentError, 'reservation_order_id is nil' if reservation_order_id.nil?
  fail ArgumentError, 'filter is nil' if filter.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # 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 = 'providers/Microsoft.Capacity/reservationorders/{reservationOrderId}/providers/Microsoft.Consumption/reservationDetails'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'reservationOrderId' => reservation_order_id},
      query_params: {'$filter' => filter,'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?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-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::Consumption::Mgmt::V2019_10_01::Models::ReservationDetailsListResult.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_by_reservation_order_next(next_page_link, custom_headers: nil) ⇒ ReservationDetailsListResult

Lists the reservations details for provided date range.

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:

  • (ReservationDetailsListResult) —

    operation results.



356
357
358
359
 
# File 'lib/2019-10-01/generated/azure_mgmt_consumption/reservations_details.rb', line 356

def list_by_reservation_order_next(next_page_link, custom_headers:nil)
  response = list_by_reservation_order_next_async(next_page_link, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#list_by_reservation_order_next_async(next_page_link, custom_headers: nil) ⇒ Concurrent::Promise

Lists the reservations details for provided date range.

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.



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
 
# File 'lib/2019-10-01/generated/azure_mgmt_consumption/reservations_details.rb', line 385

def list_by_reservation_order_next_async(next_page_link, custom_headers:nil)
  fail ArgumentError, 'next_page_link is nil' if next_page_link.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # 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?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-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::Consumption::Mgmt::V2019_10_01::Models::ReservationDetailsListResult.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_by_reservation_order_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists the reservations details for provided date range.

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.



371
372
373
 
# File 'lib/2019-10-01/generated/azure_mgmt_consumption/reservations_details.rb', line 371

def list_by_reservation_order_next_with_http_info(next_page_link, custom_headers:nil)
  list_by_reservation_order_next_async(next_page_link, custom_headers:custom_headers).value!
end

#list_by_reservation_order_with_http_info(reservation_order_id, filter, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists the reservations details for provided date range.

properties/UsageDate for start date and end date. The filter supports 'le' and 'ge' will be added to the HTTP request.

Parameters:

  • reservation_order_id (String) —

    Order Id of the reservation

  • filter (String) —

    Filter reservation details by date range. The

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



54
55
56
 
# File 'lib/2019-10-01/generated/azure_mgmt_consumption/reservations_details.rb', line 54

def list_by_reservation_order_with_http_info(reservation_order_id, filter, custom_headers:nil)
  list_by_reservation_order_async(reservation_order_id, filter, custom_headers:custom_headers).value!
end

#list_next(next_page_link, custom_headers: nil) ⇒ ReservationDetailsListResult

Lists the reservations details for the defined scope and provided date range.

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:

  • (ReservationDetailsListResult) —

    operation results.



536
537
538
539
 
# File 'lib/2019-10-01/generated/azure_mgmt_consumption/reservations_details.rb', line 536

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

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

Lists the reservations details for the defined scope and provided date range.

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.



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
607
608
609
610
611
612
613
614
 
# File 'lib/2019-10-01/generated/azure_mgmt_consumption/reservations_details.rb', line 565

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


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # 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?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-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::Consumption::Mgmt::V2019_10_01::Models::ReservationDetailsListResult.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 reservations details for the defined scope and provided date range.

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.



551
552
553
 
# File 'lib/2019-10-01/generated/azure_mgmt_consumption/reservations_details.rb', line 551

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

#list_with_http_info(scope, start_date: nil, end_date: nil, filter: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists the reservations details for the defined scope and provided date range.

operations. This includes '/providers/Microsoft.Billing/billingAccounts/billingAccountId' for BillingAccount scope (legacy), and '/providers/Microsoft.Billing/billingAccounts/billingAccountId/billingProfiles/billingProfileId' for BillingProfile scope (modern). properties/UsageDate for start date and end date. The filter supports 'le' and 'ge' will be added to the HTTP request.

Parameters:

  • scope (String) —

    The scope associated with reservations details

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

    Start date

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

    End date

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

    Filter reservation details by date range. The

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



270
271
272
 
# File 'lib/2019-10-01/generated/azure_mgmt_consumption/reservations_details.rb', line 270

def list_with_http_info(scope, start_date:nil, end_date:nil, filter:nil, custom_headers:nil)
  list_async(scope, start_date:start_date, end_date:end_date, filter:filter, custom_headers:custom_headers).value!
end