Class: Azure::Consumption::Mgmt::V2019_05_01_preview::Charges

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-05-01-preview/generated/azure_mgmt_consumption/charges.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) ⇒ Charges

Creates and initializes a new instance of the Charges class.

Parameters:

  • client —

    service class for accessing basic functionality.



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

def client
  @client
end

Instance Method Details

#list_by_scope(scope, filter: nil, custom_headers: nil) ⇒ ChargeSummary

Lists the charges based for the defined scope.

This includes ‘/providers/Microsoft.Billing/billingAccounts/billingAccountId/departments/departmentId’ for Department scope and ‘/providers/Microsoft.Billing/billingAccounts/billingAccountId/enrollmentAccounts/enrollmentAccountId’ for EnrollmentAccount scope. For department and enrollment accounts, 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/billingAccounts/billingAccountId/departments/departmentId/providers/Microsoft.Billing/billingPeriods/billingPeriodName’ (Utc time), properties/usageStart (Utc time). 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 (:). will be added to the HTTP request.

Parameters:

  • scope (String) —

    The scope associated with usage details operations.

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

    May be used to filter charges by properties/usageEnd

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

    A hash of custom headers that

Returns:

  • (ChargeSummary) —

    operation results.



48
49
50
51
 
# File 'lib/2019-05-01-preview/generated/azure_mgmt_consumption/charges.rb', line 48

def list_by_scope(scope, filter:nil, custom_headers:nil)
  response = list_by_scope_async(scope, filter:filter, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#list_by_scope_async(scope, filter: nil, custom_headers: nil) ⇒ Concurrent::Promise

Lists the charges based for the defined scope.

This includes ‘/providers/Microsoft.Billing/billingAccounts/billingAccountId/departments/departmentId’ for Department scope and ‘/providers/Microsoft.Billing/billingAccounts/billingAccountId/enrollmentAccounts/enrollmentAccountId’ for EnrollmentAccount scope. For department and enrollment accounts, 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/billingAccounts/billingAccountId/departments/departmentId/providers/Microsoft.Billing/billingPeriods/billingPeriodName’ (Utc time), properties/usageStart (Utc time). 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 (:). to the HTTP request.

Parameters:

  • scope (String) —

    The scope associated with usage details operations.

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

    May be used to filter charges by properties/usageEnd

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
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
 
# File 'lib/2019-05-01-preview/generated/azure_mgmt_consumption/charges.rb', line 103

def list_by_scope_async(scope, filter: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/charges'

  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,'$filter' => filter},
      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_05_01_preview::Models::ChargeSummary.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_scope_with_http_info(scope, filter: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists the charges based for the defined scope.

This includes ‘/providers/Microsoft.Billing/billingAccounts/billingAccountId/departments/departmentId’ for Department scope and ‘/providers/Microsoft.Billing/billingAccounts/billingAccountId/enrollmentAccounts/enrollmentAccountId’ for EnrollmentAccount scope. For department and enrollment accounts, 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/billingAccounts/billingAccountId/departments/departmentId/providers/Microsoft.Billing/billingPeriods/billingPeriodName’ (Utc time), properties/usageStart (Utc time). 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 (:). will be added to the HTTP request.

Parameters:

  • scope (String) —

    The scope associated with usage details operations.

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

    May be used to filter charges by properties/usageEnd

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



76
77
78
 
# File 'lib/2019-05-01-preview/generated/azure_mgmt_consumption/charges.rb', line 76

def list_by_scope_with_http_info(scope, filter:nil, custom_headers:nil)
  list_by_scope_async(scope, filter:filter, custom_headers:custom_headers).value!
end