Class: Azure::Consumption::Mgmt::V2019_04_01_preview::UsageDetails

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-04-01-preview/generated/azure_mgmt_consumption/usage_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) ⇒ UsageDetails

Creates and initializes a new instance of the UsageDetails class.

Parameters:

  • client —

    service class for accessing basic functionality.



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

def client
  @client
end

Instance Method Details

#begin_download(scope, metric: nil, custom_headers: nil) ⇒ UsageDetailsDownloadResponse

Download usage details data.

This includes '/subscriptions/subscriptionId/' for subscription scope, '/providers/Microsoft.Billing/billingAccounts/billingAccountId' for Billing Account scope, '/providers/Microsoft.Billing/departments/departmentId' for Department scope, '/providers/Microsoft.Billing/enrollmentAccounts/enrollmentAccountId' for EnrollmentAccount scope and '/providers/Microsoft.Management/managementGroups/managementGroupId' for Management Group scope. For subscription, billing account, department, enrollment account and management group, you can also add billing period to the scope using '/providers/Microsoft.Billing/billingPeriods/billingPeriodName'. For e.g. to specify billing period at department scope use '/providers/Microsoft.Billing/departments/departmentId/providers/Microsoft.Billing/billingPeriods/billingPeriodName' records. Possible values include: 'ActualCostMetricType', 'AmortizedCostMetricType', 'UsageMetricType' will be added to the HTTP request.

Parameters:

  • scope (String) —

    The scope associated with usage details operations.

  • metric (Metrictype) (defaults to: nil) —

    Allows to select different type of cost/usage

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

    A hash of custom headers that

Returns:

  • (UsageDetailsDownloadResponse) —

    operation results.



309
310
311
312
 
# File 'lib/2019-04-01-preview/generated/azure_mgmt_consumption/usage_details.rb', line 309

def begin_download(scope, metric:nil, custom_headers:nil)
  response = begin_download_async(scope, metric:metric, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#begin_download_async(scope, metric: nil, custom_headers: nil) ⇒ Concurrent::Promise

Download usage details data.

This includes '/subscriptions/subscriptionId/' for subscription scope, '/providers/Microsoft.Billing/billingAccounts/billingAccountId' for Billing Account scope, '/providers/Microsoft.Billing/departments/departmentId' for Department scope, '/providers/Microsoft.Billing/enrollmentAccounts/enrollmentAccountId' for EnrollmentAccount scope and '/providers/Microsoft.Management/managementGroups/managementGroupId' for Management Group scope. For subscription, billing account, department, enrollment account and management group, you can also add billing period to the scope using '/providers/Microsoft.Billing/billingPeriods/billingPeriodName'. For e.g. to specify billing period at department scope use '/providers/Microsoft.Billing/departments/departmentId/providers/Microsoft.Billing/billingPeriods/billingPeriodName' records. Possible values include: 'ActualCostMetricType', 'AmortizedCostMetricType', 'UsageMetricType' to the HTTP request.

Parameters:

  • scope (String) —

    The scope associated with usage details operations.

  • metric (Metrictype) (defaults to: nil) —

    Allows to select different type of cost/usage

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
406
407
408
409
410
411
412
413
414
415
416
417
418
419
 
# File 'lib/2019-04-01-preview/generated/azure_mgmt_consumption/usage_details.rb', line 368

def begin_download_async(scope, metric: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/usageDetails/download'

  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: {'api-version' => @client.api_version,'metric' => metric},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:post, 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 || status_code == 202
      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::UsageDetailsDownloadResponse.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

#begin_download_with_http_info(scope, metric: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Download usage details data.

This includes '/subscriptions/subscriptionId/' for subscription scope, '/providers/Microsoft.Billing/billingAccounts/billingAccountId' for Billing Account scope, '/providers/Microsoft.Billing/departments/departmentId' for Department scope, '/providers/Microsoft.Billing/enrollmentAccounts/enrollmentAccountId' for EnrollmentAccount scope and '/providers/Microsoft.Management/managementGroups/managementGroupId' for Management Group scope. For subscription, billing account, department, enrollment account and management group, you can also add billing period to the scope using '/providers/Microsoft.Billing/billingPeriods/billingPeriodName'. For e.g. to specify billing period at department scope use '/providers/Microsoft.Billing/departments/departmentId/providers/Microsoft.Billing/billingPeriods/billingPeriodName' records. Possible values include: 'ActualCostMetricType', 'AmortizedCostMetricType', 'UsageMetricType' will be added to the HTTP request.

Parameters:

  • scope (String) —

    The scope associated with usage details operations.

  • metric (Metrictype) (defaults to: nil) —

    Allows to select different type of cost/usage

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



339
340
341
 
# File 'lib/2019-04-01-preview/generated/azure_mgmt_consumption/usage_details.rb', line 339

def begin_download_with_http_info(scope, metric:nil, custom_headers:nil)
  begin_download_async(scope, metric:metric, custom_headers:custom_headers).value!
end

#download(scope, metric: nil, custom_headers: nil) ⇒ UsageDetailsDownloadResponse

Download usage details data.

This includes '/subscriptions/subscriptionId/' for subscription scope, '/providers/Microsoft.Billing/billingAccounts/billingAccountId' for Billing Account scope, '/providers/Microsoft.Billing/departments/departmentId' for Department scope, '/providers/Microsoft.Billing/enrollmentAccounts/enrollmentAccountId' for EnrollmentAccount scope and '/providers/Microsoft.Management/managementGroups/managementGroupId' for Management Group scope. For subscription, billing account, department, enrollment account and management group, you can also add billing period to the scope using '/providers/Microsoft.Billing/billingPeriods/billingPeriodName'. For e.g. to specify billing period at department scope use '/providers/Microsoft.Billing/departments/departmentId/providers/Microsoft.Billing/billingPeriods/billingPeriodName' records. Possible values include: 'ActualCostMetricType', 'AmortizedCostMetricType', 'UsageMetricType' will be added to the HTTP request.

Parameters:

  • scope (String) —

    The scope associated with usage details operations.

  • metric (Metrictype) (defaults to: nil) —

    Allows to select different type of cost/usage

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

    A hash of custom headers that

Returns:

  • (UsageDetailsDownloadResponse) —

    operation results.



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

def download(scope, metric:nil, custom_headers:nil)
  response = download_async(scope, metric:metric, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#download_async(scope, metric: nil, custom_headers: nil) ⇒ Concurrent::Promise

This includes '/subscriptions/subscriptionId/' for subscription scope, '/providers/Microsoft.Billing/billingAccounts/billingAccountId' for Billing Account scope, '/providers/Microsoft.Billing/departments/departmentId' for Department scope, '/providers/Microsoft.Billing/enrollmentAccounts/enrollmentAccountId' for EnrollmentAccount scope and '/providers/Microsoft.Management/managementGroups/managementGroupId' for Management Group scope. For subscription, billing account, department, enrollment account and management group, you can also add billing period to the scope using '/providers/Microsoft.Billing/billingPeriods/billingPeriodName'. For e.g. to specify billing period at department scope use '/providers/Microsoft.Billing/departments/departmentId/providers/Microsoft.Billing/billingPeriods/billingPeriodName' records. Possible values include: 'ActualCostMetricType', 'AmortizedCostMetricType', 'UsageMetricType' will be added to the HTTP request.

response.

Parameters:

  • scope (String) —

    The scope associated with usage details operations.

  • metric (Metrictype) (defaults to: nil) —

    Allows to select different type of cost/usage

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/2019-04-01-preview/generated/azure_mgmt_consumption/usage_details.rb', line 266

def download_async(scope, metric:nil, custom_headers:nil)
  # Send request
  promise = begin_download_async(scope, metric:metric, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = Azure::Consumption::Mgmt::V2019_04_01_preview::Models::UsageDetailsDownloadResponse.mapper()
      parsed_response = @client.deserialize(result_mapper, parsed_response)
    end

    # Waiting for response.
    @client.get_long_running_operation_result(response, deserialize_method, FinalStateVia::LOCATION)
  end

  promise
end

#list(scope, expand: nil, filter: nil, skiptoken: nil, top: nil, metric: nil, custom_headers: nil) ⇒ Array<UsageDetail>

Lists the usage details for the defined scope. Usage details are available via this API only for May 1, 2014 or later.

This includes '/subscriptions/subscriptionId/' for subscription scope, '/providers/Microsoft.Billing/billingAccounts/billingAccountId' for Billing Account scope, '/providers/Microsoft.Billing/departments/departmentId' for Department scope, '/providers/Microsoft.Billing/enrollmentAccounts/enrollmentAccountId' for EnrollmentAccount scope and '/providers/Microsoft.Management/managementGroups/managementGroupId' for Management Group scope. For subscription, billing account, department, enrollment account and management group, you can also add billing period to the scope using '/providers/Microsoft.Billing/billingPeriods/billingPeriodName'. For e.g. to specify billing period at department scope use '/providers/Microsoft.Billing/departments/departmentId/providers/Microsoft.Billing/billingPeriods/billingPeriodName' properties/meterDetails within a list of usage details. By default, these fields are not included when listing usage details. properties/resourceGroup, properties/resourceName, properties/resourceId, properties/chargeType, properties/reservationId or tags. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value is separated by a colon (:). returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. recent N usageDetails. records. Possible values include: 'ActualCostMetricType', 'AmortizedCostMetricType', 'UsageMetricType' will be added to the HTTP request.

Parameters:

  • scope (String) —

    The scope associated with usage details operations.

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

    May be used to expand the properties/additionalInfo or

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

    May be used to filter usageDetails by

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

    Skiptoken is only used if a previous operation

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

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

  • metric (Metrictype) (defaults to: nil) —

    Allows to select different type of cost/usage

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

    A hash of custom headers that

Returns:

  • (Array<UsageDetail>) —

    operation results.



66
67
68
69
 
# File 'lib/2019-04-01-preview/generated/azure_mgmt_consumption/usage_details.rb', line 66

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

#list_as_lazy(scope, expand: nil, filter: nil, skiptoken: nil, top: nil, metric: nil, custom_headers: nil) ⇒ UsageDetailsListResult

Lists the usage details for the defined scope. Usage details are available via this API only for May 1, 2014 or later.

This includes '/subscriptions/subscriptionId/' for subscription scope, '/providers/Microsoft.Billing/billingAccounts/billingAccountId' for Billing Account scope, '/providers/Microsoft.Billing/departments/departmentId' for Department scope, '/providers/Microsoft.Billing/enrollmentAccounts/enrollmentAccountId' for EnrollmentAccount scope and '/providers/Microsoft.Management/managementGroups/managementGroupId' for Management Group scope. For subscription, billing account, department, enrollment account and management group, you can also add billing period to the scope using '/providers/Microsoft.Billing/billingPeriods/billingPeriodName'. For e.g. to specify billing period at department scope use '/providers/Microsoft.Billing/departments/departmentId/providers/Microsoft.Billing/billingPeriods/billingPeriodName' properties/meterDetails within a list of usage details. By default, these fields are not included when listing usage details. properties/resourceGroup, properties/resourceName, properties/resourceId, properties/chargeType, properties/reservationId or tags. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value is separated by a colon (:). returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. recent N usageDetails. records. Possible values include: 'ActualCostMetricType', 'AmortizedCostMetricType', 'UsageMetricType' will be added to the HTTP request.

response.

Parameters:

  • scope (String) —

    The scope associated with usage details operations.

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

    May be used to expand the properties/additionalInfo or

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

    May be used to filter usageDetails by

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

    Skiptoken is only used if a previous operation

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

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

  • metric (Metrictype) (defaults to: nil) —

    Allows to select different type of cost/usage

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

    A hash of custom headers that

Returns:

  • (UsageDetailsListResult) —

    which provide lazy access to pages of the



556
557
558
559
560
561
562
563
564
565
 
# File 'lib/2019-04-01-preview/generated/azure_mgmt_consumption/usage_details.rb', line 556

def list_as_lazy(scope, expand:nil, filter:nil, skiptoken:nil, top:nil, metric:nil, custom_headers:nil)
  response = list_async(scope, expand:expand, filter:filter, skiptoken:skiptoken, top:top, metric:metric, 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, expand: nil, filter: nil, skiptoken: nil, top: nil, metric: nil, custom_headers: nil) ⇒ Concurrent::Promise

Lists the usage details for the defined scope. Usage details are available via this API only for May 1, 2014 or later.

This includes '/subscriptions/subscriptionId/' for subscription scope, '/providers/Microsoft.Billing/billingAccounts/billingAccountId' for Billing Account scope, '/providers/Microsoft.Billing/departments/departmentId' for Department scope, '/providers/Microsoft.Billing/enrollmentAccounts/enrollmentAccountId' for EnrollmentAccount scope and '/providers/Microsoft.Management/managementGroups/managementGroupId' for Management Group scope. For subscription, billing account, department, enrollment account and management group, you can also add billing period to the scope using '/providers/Microsoft.Billing/billingPeriods/billingPeriodName'. For e.g. to specify billing period at department scope use '/providers/Microsoft.Billing/departments/departmentId/providers/Microsoft.Billing/billingPeriods/billingPeriodName' properties/meterDetails within a list of usage details. By default, these fields are not included when listing usage details. properties/resourceGroup, properties/resourceName, properties/resourceId, properties/chargeType, properties/reservationId or tags. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value is separated by a colon (:). returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. recent N usageDetails. records. Possible values include: 'ActualCostMetricType', 'AmortizedCostMetricType', 'UsageMetricType' to the HTTP request.

Parameters:

  • scope (String) —

    The scope associated with usage details operations.

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

    May be used to expand the properties/additionalInfo or

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

    May be used to filter usageDetails by

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

    Skiptoken is only used if a previous operation

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

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

  • metric (Metrictype) (defaults to: nil) —

    Allows to select different type of cost/usage

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/2019-04-01-preview/generated/azure_mgmt_consumption/usage_details.rb', line 157

def list_async(scope, expand:nil, filter:nil, skiptoken:nil, top:nil, metric:nil, custom_headers:nil)
  fail ArgumentError, 'scope is nil' if scope.nil?
  fail ArgumentError, "'top' should satisfy the constraint - 'InclusiveMaximum': '1000'" if !top.nil? && top > 1000
  fail ArgumentError, "'top' should satisfy the constraint - 'InclusiveMinimum': '1'" if !top.nil? && top < 1
  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/usageDetails'

  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: {'$expand' => expand,'$filter' => filter,'$skiptoken' => skiptoken,'$top' => top,'api-version' => @client.api_version,'metric' => metric},
      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::UsageDetailsListResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#list_next(next_page_link, custom_headers: nil) ⇒ UsageDetailsListResult

Lists the usage details for the defined scope. Usage details are available via this API only for May 1, 2014 or later.

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:

  • (UsageDetailsListResult) —

    operation results.



432
433
434
435
 
# File 'lib/2019-04-01-preview/generated/azure_mgmt_consumption/usage_details.rb', line 432

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 usage details for the defined scope. Usage details are available via this API only for May 1, 2014 or later.

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.



463
464
465
466
467
468
469
470
471
472
473
474
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
 
# File 'lib/2019-04-01-preview/generated/azure_mgmt_consumption/usage_details.rb', line 463

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_04_01_preview::Models::UsageDetailsListResult.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 usage details for the defined scope. Usage details are available via this API only for May 1, 2014 or later.

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.



448
449
450
 
# File 'lib/2019-04-01-preview/generated/azure_mgmt_consumption/usage_details.rb', line 448

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, expand: nil, filter: nil, skiptoken: nil, top: nil, metric: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists the usage details for the defined scope. Usage details are available via this API only for May 1, 2014 or later.

This includes '/subscriptions/subscriptionId/' for subscription scope, '/providers/Microsoft.Billing/billingAccounts/billingAccountId' for Billing Account scope, '/providers/Microsoft.Billing/departments/departmentId' for Department scope, '/providers/Microsoft.Billing/enrollmentAccounts/enrollmentAccountId' for EnrollmentAccount scope and '/providers/Microsoft.Management/managementGroups/managementGroupId' for Management Group scope. For subscription, billing account, department, enrollment account and management group, you can also add billing period to the scope using '/providers/Microsoft.Billing/billingPeriods/billingPeriodName'. For e.g. to specify billing period at department scope use '/providers/Microsoft.Billing/departments/departmentId/providers/Microsoft.Billing/billingPeriods/billingPeriodName' properties/meterDetails within a list of usage details. By default, these fields are not included when listing usage details. properties/resourceGroup, properties/resourceName, properties/resourceId, properties/chargeType, properties/reservationId or tags. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value is separated by a colon (:). returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. recent N usageDetails. records. Possible values include: 'ActualCostMetricType', 'AmortizedCostMetricType', 'UsageMetricType' will be added to the HTTP request.

Parameters:

  • scope (String) —

    The scope associated with usage details operations.

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

    May be used to expand the properties/additionalInfo or

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

    May be used to filter usageDetails by

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

    Skiptoken is only used if a previous operation

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

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

  • metric (Metrictype) (defaults to: nil) —

    Allows to select different type of cost/usage

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



112
113
114
 
# File 'lib/2019-04-01-preview/generated/azure_mgmt_consumption/usage_details.rb', line 112

def list_with_http_info(scope, expand:nil, filter:nil, skiptoken:nil, top:nil, metric:nil, custom_headers:nil)
  list_async(scope, expand:expand, filter:filter, skiptoken:skiptoken, top:top, metric:metric, custom_headers:custom_headers).value!
end