Class: Azure::Consumption::Mgmt::V2019_06_01::Balances

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-06-01/generated/azure_mgmt_consumption/balances.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) ⇒ Balances

Creates and initializes a new instance of the Balances class.

Parameters:

  • client —

    service class for accessing basic functionality.



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

def client
  @client
end

Instance Method Details

#get_by_billing_account(billing_account_id, custom_headers: nil) ⇒ Balance

Gets the balances for a scope by billingAccountId. Balances are available via this API only for May 1, 2014 or later.

will be added to the HTTP request.

Parameters:

  • billing_account_id (String) —

    BillingAccount ID

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

    A hash of custom headers that

Returns:

  • (Balance) —

    operation results.



35
36
37
38
 
# File 'lib/2019-06-01/generated/azure_mgmt_consumption/balances.rb', line 35

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

#get_by_billing_account_async(billing_account_id, custom_headers: nil) ⇒ Concurrent::Promise

Gets the balances for a scope by billingAccountId. Balances are available via this API only for May 1, 2014 or later.

to the HTTP request.

Parameters:

  • billing_account_id (String) —

    BillingAccount ID

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/2019-06-01/generated/azure_mgmt_consumption/balances.rb', line 64

def (, custom_headers:nil)
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'billing_account_id is nil' if .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 = 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Consumption/balances'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'billingAccountId' => },
      query_params: {'api-version' => @client.api_version},
      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_06_01::Models::Balance.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

#get_by_billing_account_with_http_info(billing_account_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets the balances for a scope by billingAccountId. Balances are available via this API only for May 1, 2014 or later.

will be added to the HTTP request.

Parameters:

  • billing_account_id (String) —

    BillingAccount ID

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



50
51
52
 
# File 'lib/2019-06-01/generated/azure_mgmt_consumption/balances.rb', line 50

def (, custom_headers:nil)
  (, custom_headers:custom_headers).value!
end

#get_for_billing_period_by_billing_account(billing_account_id, billing_period_name, custom_headers: nil) ⇒ Balance

Gets the balances for a scope by billing period and billingAccountId. Balances are available via this API only for May 1, 2014 or later.

will be added to the HTTP request.

Parameters:

  • billing_account_id (String) —

    BillingAccount ID

  • billing_period_name (String) —

    Billing Period Name.

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

    A hash of custom headers that

Returns:

  • (Balance) —

    operation results.



128
129
130
131
 
# File 'lib/2019-06-01/generated/azure_mgmt_consumption/balances.rb', line 128

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

#get_for_billing_period_by_billing_account_async(billing_account_id, billing_period_name, custom_headers: nil) ⇒ Concurrent::Promise

Gets the balances for a scope by billing period and billingAccountId. Balances are available via this API only for May 1, 2014 or later.

to the HTTP request.

Parameters:

  • billing_account_id (String) —

    BillingAccount ID

  • billing_period_name (String) —

    Billing Period Name.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
211
 
# File 'lib/2019-06-01/generated/azure_mgmt_consumption/balances.rb', line 159

def (, billing_period_name, custom_headers:nil)
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'billing_account_id is nil' if .nil?
  fail ArgumentError, 'billing_period_name is nil' if billing_period_name.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 = 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/balances'

  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: {'api-version' => @client.api_version},
      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_06_01::Models::Balance.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

#get_for_billing_period_by_billing_account_with_http_info(billing_account_id, billing_period_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets the balances for a scope by billing period and billingAccountId. Balances are available via this API only for May 1, 2014 or later.

will be added to the HTTP request.

Parameters:

  • billing_account_id (String) —

    BillingAccount ID

  • billing_period_name (String) —

    Billing Period Name.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



144
145
146
 
# File 'lib/2019-06-01/generated/azure_mgmt_consumption/balances.rb', line 144

def (, billing_period_name, custom_headers:nil)
  (, billing_period_name, custom_headers:custom_headers).value!
end