Class: Azure::Consumption::Mgmt::V2019_10_01::Charges

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

def client
  @client
end

Instance Method Details

#list(scope, start_date: nil, end_date: nil, filter: nil, apply: nil, custom_headers: nil) ⇒ ChargesListResult

Lists the charges based for the defined scope.

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'. 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. (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 (:). by properties/billingProfileId, properties/invoiceSectionId, properties/customerId (specific for Partner Led), or for billingProfile scope by properties/invoiceSectionId. will be added to the HTTP request.

Parameters:

  • scope (String) —

    The scope associated with charges operations. This

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

    Start date

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

    End date

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

    May be used to filter charges by properties/usageEnd

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

    May be used to group charges for billingAccount scope

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

    A hash of custom headers that

Returns:

  • (ChargesListResult) —

    operation results.



63
64
65
66
 
# File 'lib/2019-10-01/generated/azure_mgmt_consumption/charges.rb', line 63

def list(scope, start_date:nil, end_date:nil, filter:nil, apply:nil, custom_headers:nil)
  response = list_async(scope, start_date:start_date, end_date:end_date, filter:filter, apply:apply, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#list_async(scope, start_date: nil, end_date: nil, filter: nil, apply: nil, custom_headers: nil) ⇒ Concurrent::Promise

Lists the charges based for the defined scope.

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'. 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. (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 (:). by properties/billingProfileId, properties/invoiceSectionId, properties/customerId (specific for Partner Led), or for billingProfile scope by properties/invoiceSectionId. to the HTTP request.

Parameters:

  • scope (String) —

    The scope associated with charges operations. This

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

    Start date

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

    End date

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

    May be used to filter charges by properties/usageEnd

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

    May be used to group charges for billingAccount scope

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/2019-10-01/generated/azure_mgmt_consumption/charges.rb', line 148

def list_async(scope, start_date:nil, end_date:nil, filter:nil, apply: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,'startDate' => start_date,'endDate' => end_date,'$filter' => filter,'$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::V2019_10_01::Models::ChargesListResult.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_with_http_info(scope, start_date: nil, end_date: nil, filter: nil, apply: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists the charges based for the defined scope.

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'. 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. (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 (:). by properties/billingProfileId, properties/invoiceSectionId, properties/customerId (specific for Partner Led), or for billingProfile scope by properties/invoiceSectionId. will be added to the HTTP request.

Parameters:

  • scope (String) —

    The scope associated with charges operations. This

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

    Start date

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

    End date

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

    May be used to filter charges by properties/usageEnd

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

    May be used to group charges for billingAccount scope

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



106
107
108
 
# File 'lib/2019-10-01/generated/azure_mgmt_consumption/charges.rb', line 106

def list_with_http_info(scope, start_date:nil, end_date:nil, filter:nil, apply:nil, custom_headers:nil)
  list_async(scope, start_date:start_date, end_date:end_date, filter:filter, apply:apply, custom_headers:custom_headers).value!
end