Class: Azure::Consumption::Mgmt::V2018_03_31::UsageDetailsByBillingAccount

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2018-03-31/generated/azure_mgmt_consumption/usage_details_by_billing_account.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) ⇒ UsageDetailsByBillingAccount

Creates and initializes a new instance of the UsageDetailsByBillingAccount class.

Parameters:

  • client —

    service class for accessing basic functionality.



18
19
20
 
# File 'lib/2018-03-31/generated/azure_mgmt_consumption/usage_details_by_billing_account.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/2018-03-31/generated/azure_mgmt_consumption/usage_details_by_billing_account.rb', line 23

def client
  @client
end

Instance Method Details

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

Lists the usage details by billingAccountId for a scope by current billing period. Usage details are available via this API only for May 1, 2014 or later.

properties/additionalProperties or properties/meterDetails within a list of usage details. By default, these fields are not included when listing usage details. properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName, properties/instanceId 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. will be added to the HTTP request.

Parameters:

  • billing_account_id (String) —

    BillingAccount ID

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

    May be used to expand the

  • 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

  • query_options (QueryOptions) (defaults to: nil) —

    Additional parameters for the operation

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

    A hash of custom headers that

Returns:

  • (Array<UsageDetail>) —

    operation results.



53
54
55
56
 
# File 'lib/2018-03-31/generated/azure_mgmt_consumption/usage_details_by_billing_account.rb', line 53

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

#list_as_lazy(billing_account_id, expand: nil, filter: nil, skiptoken: nil, top: nil, query_options: nil, custom_headers: nil) ⇒ UsageDetailsListResult

Lists the usage details by billingAccountId for a scope by current billing period. Usage details are available via this API only for May 1, 2014 or later.

properties/additionalProperties or properties/meterDetails within a list of usage details. By default, these fields are not included when listing usage details. properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName, properties/instanceId 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. will be added to the HTTP request.

response.

Parameters:

  • billing_account_id (String) —

    BillingAccount ID

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

    May be used to expand the

  • 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

  • query_options (QueryOptions) (defaults to: nil) —

    Additional parameters for the operation

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

    A hash of custom headers that

Returns:

  • (UsageDetailsListResult) —

    which provide lazy access to pages of the



554
555
556
557
558
559
560
561
562
563
 
# File 'lib/2018-03-31/generated/azure_mgmt_consumption/usage_details_by_billing_account.rb', line 554

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

Lists the usage details by billingAccountId for a scope by current billing period. Usage details are available via this API only for May 1, 2014 or later.

properties/additionalProperties or properties/meterDetails within a list of usage details. By default, these fields are not included when listing usage details. properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName, properties/instanceId 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. to the HTTP request.

Parameters:

  • billing_account_id (String) —

    BillingAccount ID

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

    May be used to expand the

  • 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

  • query_options (QueryOptions) (defaults to: nil) —

    Additional parameters for the operation

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/2018-03-31/generated/azure_mgmt_consumption/usage_details_by_billing_account.rb', line 118

def list_async(, expand:nil, filter:nil, skiptoken:nil, top:nil, query_options:nil, custom_headers:nil)
  fail ArgumentError, 'billing_account_id is nil' if .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?

  apply = nil
  unless query_options.nil?
    apply = query_options.Apply
  end

  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.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Consumption/usageDetails'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'billingAccountId' => },
      query_params: {'$expand' => expand,'$filter' => filter,'$skiptoken' => skiptoken,'$top' => top,'api-version' => @client.api_version,'$apply' => apply},
      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::V2018_03_31::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_by_billing_period(billing_account_id, billing_period_name, expand: nil, filter: nil, skiptoken: nil, top: nil, query_options: nil, custom_headers: nil) ⇒ Array<UsageDetail>

Lists the usage details based on billingAccountId for a scope by billing period. Usage details are available via this API only for May 1, 2014 or later.

properties/additionalProperties or properties/meterDetails within a list of usage details. By default, these fields are not included when listing usage details. properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName or properties/instanceId. 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. will be added to the HTTP request.

Parameters:

  • billing_account_id (String) —

    BillingAccount ID

  • billing_period_name (String) —

    Billing Period Name.

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

    May be used to expand the

  • 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

  • query_options (QueryOptions) (defaults to: nil) —

    Additional parameters for the operation

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

    A hash of custom headers that

Returns:

  • (Array<UsageDetail>) —

    operation results.



206
207
208
209
 
# File 'lib/2018-03-31/generated/azure_mgmt_consumption/usage_details_by_billing_account.rb', line 206

def list_by_billing_period(, billing_period_name, expand:nil, filter:nil, skiptoken:nil, top:nil, query_options:nil, custom_headers:nil)
  first_page = list_by_billing_period_as_lazy(, billing_period_name, expand:expand, filter:filter, skiptoken:skiptoken, top:top, query_options:query_options, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_by_billing_period_as_lazy(billing_account_id, billing_period_name, expand: nil, filter: nil, skiptoken: nil, top: nil, query_options: nil, custom_headers: nil) ⇒ UsageDetailsListResult

Lists the usage details based on billingAccountId for a scope by billing period. Usage details are available via this API only for May 1, 2014 or later.

properties/additionalProperties or properties/meterDetails within a list of usage details. By default, these fields are not included when listing usage details. properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName or properties/instanceId. 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. will be added to the HTTP request.

response.

Parameters:

  • billing_account_id (String) —

    BillingAccount ID

  • billing_period_name (String) —

    Billing Period Name.

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

    May be used to expand the

  • 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

  • query_options (QueryOptions) (defaults to: nil) —

    Additional parameters for the operation

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

    A hash of custom headers that

Returns:

  • (UsageDetailsListResult) —

    which provide lazy access to pages of the



595
596
597
598
599
600
601
602
603
604
 
# File 'lib/2018-03-31/generated/azure_mgmt_consumption/usage_details_by_billing_account.rb', line 595

def list_by_billing_period_as_lazy(, billing_period_name, expand:nil, filter:nil, skiptoken:nil, top:nil, query_options:nil, custom_headers:nil)
  response = list_by_billing_period_async(, billing_period_name, expand:expand, filter:filter, skiptoken:skiptoken, top:top, query_options:query_options, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_by_billing_period_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

#list_by_billing_period_async(billing_account_id, billing_period_name, expand: nil, filter: nil, skiptoken: nil, top: nil, query_options: nil, custom_headers: nil) ⇒ Concurrent::Promise

Lists the usage details based on billingAccountId for a scope by billing period. Usage details are available via this API only for May 1, 2014 or later.

properties/additionalProperties or properties/meterDetails within a list of usage details. By default, these fields are not included when listing usage details. properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName or properties/instanceId. 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. to the HTTP request.

Parameters:

  • billing_account_id (String) —

    BillingAccount ID

  • billing_period_name (String) —

    Billing Period Name.

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

    May be used to expand the

  • 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

  • query_options (QueryOptions) (defaults to: nil) —

    Additional parameters for the operation

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/2018-03-31/generated/azure_mgmt_consumption/usage_details_by_billing_account.rb', line 273

def list_by_billing_period_async(, billing_period_name, expand:nil, filter:nil, skiptoken:nil, top:nil, query_options:nil, custom_headers:nil)
  fail ArgumentError, 'billing_account_id is nil' if .nil?
  fail ArgumentError, 'billing_period_name is nil' if billing_period_name.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?

  apply = nil
  unless query_options.nil?
    apply = query_options.Apply
  end

  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.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/usageDetails'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'billingAccountId' => ,'billingPeriodName' => billing_period_name},
      query_params: {'$expand' => expand,'$filter' => filter,'$skiptoken' => skiptoken,'$top' => top,'api-version' => @client.api_version,'$apply' => apply},
      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::V2018_03_31::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_by_billing_period_next(next_page_link, custom_headers: nil) ⇒ UsageDetailsListResult

Lists the usage details based on billingAccountId for a scope by billing period. 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.



441
442
443
444
 
# File 'lib/2018-03-31/generated/azure_mgmt_consumption/usage_details_by_billing_account.rb', line 441

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

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

Lists the usage details based on billingAccountId for a scope by billing period. 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.



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
513
514
515
516
517
518
519
520
521
522
523
 
# File 'lib/2018-03-31/generated/azure_mgmt_consumption/usage_details_by_billing_account.rb', line 474

def list_by_billing_period_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::V2018_03_31::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_by_billing_period_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists the usage details based on billingAccountId for a scope by billing period. 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.



458
459
460
 
# File 'lib/2018-03-31/generated/azure_mgmt_consumption/usage_details_by_billing_account.rb', line 458

def list_by_billing_period_next_with_http_info(next_page_link, custom_headers:nil)
  list_by_billing_period_next_async(next_page_link, custom_headers:custom_headers).value!
end

#list_by_billing_period_with_http_info(billing_account_id, billing_period_name, expand: nil, filter: nil, skiptoken: nil, top: nil, query_options: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists the usage details based on billingAccountId for a scope by billing period. Usage details are available via this API only for May 1, 2014 or later.

properties/additionalProperties or properties/meterDetails within a list of usage details. By default, these fields are not included when listing usage details. properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName or properties/instanceId. 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. will be added to the HTTP request.

Parameters:

  • billing_account_id (String) —

    BillingAccount ID

  • billing_period_name (String) —

    Billing Period Name.

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

    May be used to expand the

  • 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

  • query_options (QueryOptions) (defaults to: nil) —

    Additional parameters for the operation

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



240
241
242
 
# File 'lib/2018-03-31/generated/azure_mgmt_consumption/usage_details_by_billing_account.rb', line 240

def list_by_billing_period_with_http_info(, billing_period_name, expand:nil, filter:nil, skiptoken:nil, top:nil, query_options:nil, custom_headers:nil)
  list_by_billing_period_async(, billing_period_name, expand:expand, filter:filter, skiptoken:skiptoken, top:top, query_options:query_options, custom_headers:custom_headers).value!
end

#list_next(next_page_link, custom_headers: nil) ⇒ UsageDetailsListResult

Lists the usage details by billingAccountId for a scope by current billing period. 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.



345
346
347
348
 
# File 'lib/2018-03-31/generated/azure_mgmt_consumption/usage_details_by_billing_account.rb', line 345

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 by billingAccountId for a scope by current billing period. 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.



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
420
421
422
423
424
425
426
427
 
# File 'lib/2018-03-31/generated/azure_mgmt_consumption/usage_details_by_billing_account.rb', line 378

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::V2018_03_31::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 by billingAccountId for a scope by current billing period. 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.



362
363
364
 
# File 'lib/2018-03-31/generated/azure_mgmt_consumption/usage_details_by_billing_account.rb', line 362

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

Lists the usage details by billingAccountId for a scope by current billing period. Usage details are available via this API only for May 1, 2014 or later.

properties/additionalProperties or properties/meterDetails within a list of usage details. By default, these fields are not included when listing usage details. properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName, properties/instanceId 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. will be added to the HTTP request.

Parameters:

  • billing_account_id (String) —

    BillingAccount ID

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

    May be used to expand the

  • 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

  • query_options (QueryOptions) (defaults to: nil) —

    Additional parameters for the operation

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



86
87
88
 
# File 'lib/2018-03-31/generated/azure_mgmt_consumption/usage_details_by_billing_account.rb', line 86

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