Class: Azure::Consumption::Mgmt::V2019_04_01_preview::ReservationsDetails

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-04-01-preview/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.

[View source]

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

def client
  @client
end

Instance Method Details

#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.

[View source]

37
38
39
40
 
# File 'lib/2019-04-01-preview/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.

[View source]

137
138
139
140
 
# File 'lib/2019-04-01-preview/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

[View source]

445
446
447
448
449
450
451
452
453
454
 
# File 'lib/2019-04-01-preview/generated/azure_mgmt_consumption/reservations_details.rb', line 445

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.

[View source]

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-04-01-preview/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_04_01_preview::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.

[View source]

327
328
329
330
 
# File 'lib/2019-04-01-preview/generated/azure_mgmt_consumption/reservations_details.rb', line 327

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.

[View source]

356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/2019-04-01-preview/generated/azure_mgmt_consumption/reservations_details.rb', line 356

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_04_01_preview::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.

[View source]

342
343
344
 
# File 'lib/2019-04-01-preview/generated/azure_mgmt_consumption/reservations_details.rb', line 342

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.

[View source]

155
156
157
 
# File 'lib/2019-04-01-preview/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

[View source]

420
421
422
423
424
425
426
427
428
429
 
# File 'lib/2019-04-01-preview/generated/azure_mgmt_consumption/reservations_details.rb', line 420

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.

[View source]

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-04-01-preview/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_04_01_preview::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.

[View source]

237
238
239
240
 
# File 'lib/2019-04-01-preview/generated/azure_mgmt_consumption/reservations_details.rb', line 237

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.

[View source]

266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/2019-04-01-preview/generated/azure_mgmt_consumption/reservations_details.rb', line 266

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_04_01_preview::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.

[View source]

252
253
254
 
# File 'lib/2019-04-01-preview/generated/azure_mgmt_consumption/reservations_details.rb', line 252

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.

[View source]

54
55
56
 
# File 'lib/2019-04-01-preview/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