Class: Azure::Consumption::Mgmt::V2019_10_01::ReservationsSummaries

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-10-01/generated/azure_mgmt_consumption/reservations_summaries.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) ⇒ ReservationsSummaries

Creates and initializes a new instance of the ReservationsSummaries class.

Parameters:

  • client —

    service class for accessing basic functionality.



18
19
20
 
# File 'lib/2019-10-01/generated/azure_mgmt_consumption/reservations_summaries.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_summaries.rb', line 23

def client
  @client
end

Instance Method Details

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

Lists the reservations summaries for the defined scope daily or monthly grain.

operations. This includes ‘/providers/Microsoft.Billing/billingAccounts/billingAccountId’ for BillingAccount scope (legacy), and ‘/providers/Microsoft.Billing/billingAccounts/billingAccountId/billingProfiles/billingProfileId’ for BillingProfile scope (modern). ‘DailyGrain’, ‘MonthlyGrain’ 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 summaries

  • grain (Datagrain) —

    Can be daily or monthly. Possible values include:

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

    Start date

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

    End date

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

    Required only for daily grain. The

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

    A hash of custom headers that

Returns:

  • (Array<ReservationSummary>) —

    operation results.



261
262
263
264
 
# File 'lib/2019-10-01/generated/azure_mgmt_consumption/reservations_summaries.rb', line 261

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

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

Lists the reservations summaries for the defined scope daily or monthly grain.

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

of the response.

Parameters:

  • scope (String) —

    The scope associated with reservations summaries

  • grain (Datagrain) —

    Can be daily or monthly. Possible values include:

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

    Start date

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

    End date

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

    Required only for daily grain. The

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

    A hash of custom headers that

Returns:

  • (ReservationSummariesListResult) —

    which provide lazy access to pages



717
718
719
720
721
722
723
724
725
726
 
# File 'lib/2019-10-01/generated/azure_mgmt_consumption/reservations_summaries.rb', line 717

def list_as_lazy(scope, grain, start_date:nil, end_date:nil, filter:nil, custom_headers:nil)
  response = list_async(scope, grain, 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, grain, start_date: nil, end_date: nil, filter: nil, custom_headers: nil) ⇒ Concurrent::Promise

Lists the reservations summaries for the defined scope daily or monthly grain.

operations. This includes ‘/providers/Microsoft.Billing/billingAccounts/billingAccountId’ for BillingAccount scope (legacy), and ‘/providers/Microsoft.Billing/billingAccounts/billingAccountId/billingProfiles/billingProfileId’ for BillingProfile scope (modern). ‘DailyGrain’, ‘MonthlyGrain’ 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 summaries

  • grain (Datagrain) —

    Can be daily or monthly. Possible values include:

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

    Start date

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

    End date

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

    Required only for daily grain. The

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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

def list_async(scope, grain, start_date:nil, end_date:nil, filter:nil, custom_headers:nil)
  fail ArgumentError, 'scope is nil' if scope.nil?
  fail ArgumentError, 'grain is nil' if grain.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/reservationSummaries'

  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: {'grain' => grain,'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::ReservationSummariesListResult.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, grain, filter: nil, custom_headers: nil) ⇒ Array<ReservationSummary>

Lists the reservations summaries for daily or monthly grain.

‘DailyGrain’, ‘MonthlyGrain’ 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

  • grain (Datagrain) —

    Can be daily or monthly. Possible values include:

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

    Required only for daily grain. The

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

    A hash of custom headers that

Returns:

  • (Array<ReservationSummary>) —

    operation results.



39
40
41
42
 
# File 'lib/2019-10-01/generated/azure_mgmt_consumption/reservations_summaries.rb', line 39

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

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

Lists the reservations summaries for daily or monthly grain.

‘DailyGrain’, ‘MonthlyGrain’ 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

  • grain (Datagrain) —

    Can be daily or monthly. Possible values include:

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

    Required only for daily grain. The

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

    A hash of custom headers that

Returns:

  • (Array<ReservationSummary>) —

    operation results.



145
146
147
148
 
# File 'lib/2019-10-01/generated/azure_mgmt_consumption/reservations_summaries.rb', line 145

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

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

Lists the reservations summaries for daily or monthly grain.

‘DailyGrain’, ‘MonthlyGrain’ properties/UsageDate for start date and end date. The filter supports ‘le’ and ‘ge’ will be added to the HTTP request.

of the response.

Parameters:

  • reservation_order_id (String) —

    Order Id of the reservation

  • reservation_id (String) —

    Id of the reservation

  • grain (Datagrain) —

    Can be daily or monthly. Possible values include:

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

    Required only for daily grain. The

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

    A hash of custom headers that

Returns:

  • (ReservationSummariesListResult) —

    which provide lazy access to pages



683
684
685
686
687
688
689
690
691
692
 
# File 'lib/2019-10-01/generated/azure_mgmt_consumption/reservations_summaries.rb', line 683

def list_by_reservation_order_and_reservation_as_lazy(reservation_order_id, reservation_id, grain, filter:nil, custom_headers:nil)
  response = list_by_reservation_order_and_reservation_async(reservation_order_id, reservation_id, grain, filter: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, grain, filter: nil, custom_headers: nil) ⇒ Concurrent::Promise

Lists the reservations summaries for daily or monthly grain.

‘DailyGrain’, ‘MonthlyGrain’ 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

  • grain (Datagrain) —

    Can be daily or monthly. Possible values include:

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

    Required only for daily grain. The

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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

def list_by_reservation_order_and_reservation_async(reservation_order_id, reservation_id, grain, filter:nil, 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, 'grain is nil' if grain.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/reservationSummaries'

  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: {'grain' => grain,'$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::ReservationSummariesListResult.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) ⇒ ReservationSummariesListResult

Lists the reservations summaries for daily or monthly grain.

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:

  • (ReservationSummariesListResult) —

    operation results.



468
469
470
471
 
# File 'lib/2019-10-01/generated/azure_mgmt_consumption/reservations_summaries.rb', line 468

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 summaries for daily or monthly grain.

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.



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

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::ReservationSummariesListResult.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 summaries for daily or monthly grain.

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.



483
484
485
 
# File 'lib/2019-10-01/generated/azure_mgmt_consumption/reservations_summaries.rb', line 483

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, grain, filter: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists the reservations summaries for daily or monthly grain.

‘DailyGrain’, ‘MonthlyGrain’ 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

  • grain (Datagrain) —

    Can be daily or monthly. Possible values include:

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

    Required only for daily grain. The

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



165
166
167
 
# File 'lib/2019-10-01/generated/azure_mgmt_consumption/reservations_summaries.rb', line 165

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

#list_by_reservation_order_as_lazy(reservation_order_id, grain, filter: nil, custom_headers: nil) ⇒ ReservationSummariesListResult

Lists the reservations summaries for daily or monthly grain.

‘DailyGrain’, ‘MonthlyGrain’ properties/UsageDate for start date and end date. The filter supports ‘le’ and ‘ge’ will be added to the HTTP request.

of the response.

Parameters:

  • reservation_order_id (String) —

    Order Id of the reservation

  • grain (Datagrain) —

    Can be daily or monthly. Possible values include:

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

    Required only for daily grain. The

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

    A hash of custom headers that

Returns:

  • (ReservationSummariesListResult) —

    which provide lazy access to pages



656
657
658
659
660
661
662
663
664
665
 
# File 'lib/2019-10-01/generated/azure_mgmt_consumption/reservations_summaries.rb', line 656

def list_by_reservation_order_as_lazy(reservation_order_id, grain, filter:nil, custom_headers:nil)
  response = list_by_reservation_order_async(reservation_order_id, grain, filter: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, grain, filter: nil, custom_headers: nil) ⇒ Concurrent::Promise

Lists the reservations summaries for daily or monthly grain.

‘DailyGrain’, ‘MonthlyGrain’ 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

  • grain (Datagrain) —

    Can be daily or monthly. Possible values include:

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

    Required only for daily grain. The

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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

def list_by_reservation_order_async(reservation_order_id, grain, filter:nil, custom_headers:nil)
  fail ArgumentError, 'reservation_order_id is nil' if reservation_order_id.nil?
  fail ArgumentError, 'grain is nil' if grain.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/reservationSummaries'

  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: {'grain' => grain,'$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::ReservationSummariesListResult.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) ⇒ ReservationSummariesListResult

Lists the reservations summaries for daily or monthly grain.

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:

  • (ReservationSummariesListResult) —

    operation results.



378
379
380
381
 
# File 'lib/2019-10-01/generated/azure_mgmt_consumption/reservations_summaries.rb', line 378

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 summaries for daily or monthly grain.

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.



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

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::ReservationSummariesListResult.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 summaries for daily or monthly grain.

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.



393
394
395
 
# File 'lib/2019-10-01/generated/azure_mgmt_consumption/reservations_summaries.rb', line 393

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, grain, filter: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists the reservations summaries for daily or monthly grain.

‘DailyGrain’, ‘MonthlyGrain’ 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

  • grain (Datagrain) —

    Can be daily or monthly. Possible values include:

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

    Required only for daily grain. The

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



58
59
60
 
# File 'lib/2019-10-01/generated/azure_mgmt_consumption/reservations_summaries.rb', line 58

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

#list_next(next_page_link, custom_headers: nil) ⇒ ReservationSummariesListResult

Lists the reservations summaries for the defined scope daily or monthly grain.

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:

  • (ReservationSummariesListResult) —

    operation results.



559
560
561
562
 
# File 'lib/2019-10-01/generated/azure_mgmt_consumption/reservations_summaries.rb', line 559

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 summaries for the defined scope daily or monthly grain.

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.



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
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
 
# File 'lib/2019-10-01/generated/azure_mgmt_consumption/reservations_summaries.rb', line 590

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::ReservationSummariesListResult.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 summaries for the defined scope daily or monthly grain.

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.



575
576
577
 
# File 'lib/2019-10-01/generated/azure_mgmt_consumption/reservations_summaries.rb', line 575

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, grain, start_date: nil, end_date: nil, filter: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists the reservations summaries for the defined scope daily or monthly grain.

operations. This includes ‘/providers/Microsoft.Billing/billingAccounts/billingAccountId’ for BillingAccount scope (legacy), and ‘/providers/Microsoft.Billing/billingAccounts/billingAccountId/billingProfiles/billingProfileId’ for BillingProfile scope (modern). ‘DailyGrain’, ‘MonthlyGrain’ 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 summaries

  • grain (Datagrain) —

    Can be daily or monthly. Possible values include:

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

    Start date

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

    End date

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

    Required only for daily grain. The

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



288
289
290
 
# File 'lib/2019-10-01/generated/azure_mgmt_consumption/reservations_summaries.rb', line 288

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