Class: Azure::Consumption::Mgmt::V2019_10_01::UsageDetails

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-10-01/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-10-01/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-10-01/generated/azure_mgmt_consumption/usage_details.rb', line 23

def client
  @client
end

Instance Method Details

#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'. Also, Modern Commerce Account scopes are '/providers/Microsoft.Billing/billingAccounts/billingAccountId' for billingAccount scope, '/providers/Microsoft.Billing/billingAccounts/billingAccountId/billingProfiles/billingProfileId' for billingProfile scope, 'providers/Microsoft.Billing/billingAccounts/billingAccountId/billingProfiles/billingProfileId/invoiceSections/invoiceSectionId' for invoiceSection scope, and 'providers/Microsoft.Billing/billingAccounts/billingAccountId/customers/customerId' specific for partners. 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, properties/publisherType 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 (:). PublisherType Filter accepts two values azure and marketplace and it is currently supported for Web Direct Offer Type 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.



77
78
79
80
 
# File 'lib/2019-10-01/generated/azure_mgmt_consumption/usage_details.rb', line 77

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'. Also, Modern Commerce Account scopes are '/providers/Microsoft.Billing/billingAccounts/billingAccountId' for billingAccount scope, '/providers/Microsoft.Billing/billingAccounts/billingAccountId/billingProfiles/billingProfileId' for billingProfile scope, 'providers/Microsoft.Billing/billingAccounts/billingAccountId/billingProfiles/billingProfileId/invoiceSections/invoiceSectionId' for invoiceSection scope, and 'providers/Microsoft.Billing/billingAccounts/billingAccountId/customers/customerId' specific for partners. 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, properties/publisherType 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 (:). PublisherType Filter accepts two values azure and marketplace and it is currently supported for Web Direct Offer Type 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



391
392
393
394
395
396
397
398
399
400
 
# File 'lib/2019-10-01/generated/azure_mgmt_consumption/usage_details.rb', line 391

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'. Also, Modern Commerce Account scopes are '/providers/Microsoft.Billing/billingAccounts/billingAccountId' for billingAccount scope, '/providers/Microsoft.Billing/billingAccounts/billingAccountId/billingProfiles/billingProfileId' for billingProfile scope, 'providers/Microsoft.Billing/billingAccounts/billingAccountId/billingProfiles/billingProfileId/invoiceSections/invoiceSectionId' for invoiceSection scope, and 'providers/Microsoft.Billing/billingAccounts/billingAccountId/customers/customerId' specific for partners. 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, properties/publisherType 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 (:). PublisherType Filter accepts two values azure and marketplace and it is currently supported for Web Direct Offer Type 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.



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
238
239
240
241
242
243
 
# File 'lib/2019-10-01/generated/azure_mgmt_consumption/usage_details.rb', line 190

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



256
257
258
259
 
# File 'lib/2019-10-01/generated/azure_mgmt_consumption/usage_details.rb', line 256

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.



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
332
333
334
335
336
 
# File 'lib/2019-10-01/generated/azure_mgmt_consumption/usage_details.rb', line 287

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



272
273
274
 
# File 'lib/2019-10-01/generated/azure_mgmt_consumption/usage_details.rb', line 272

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'. Also, Modern Commerce Account scopes are '/providers/Microsoft.Billing/billingAccounts/billingAccountId' for billingAccount scope, '/providers/Microsoft.Billing/billingAccounts/billingAccountId/billingProfiles/billingProfileId' for billingProfile scope, 'providers/Microsoft.Billing/billingAccounts/billingAccountId/billingProfiles/billingProfileId/invoiceSections/invoiceSectionId' for invoiceSection scope, and 'providers/Microsoft.Billing/billingAccounts/billingAccountId/customers/customerId' specific for partners. 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, properties/publisherType 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 (:). PublisherType Filter accepts two values azure and marketplace and it is currently supported for Web Direct Offer Type 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.



134
135
136
 
# File 'lib/2019-10-01/generated/azure_mgmt_consumption/usage_details.rb', line 134

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