Class: Azure::CostManagement::Mgmt::V2018_05_31::CostManagementClient

Inherits:
MsRestAzure::AzureServiceClient
  • Object
show all
Includes:
MsRestAzure, MsRestAzure::Serialization
Defined in:
lib/2018-05-31/generated/azure_mgmt_cost_management/cost_management_client.rb

Overview

A service client - single point of access to the REST API.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(credentials = nil, base_url = nil, options = nil) ⇒ CostManagementClient

Creates initializes a new instance of the CostManagementClient class.

Parameters:

  • credentials (MsRest::ServiceClientCredentials) (defaults to: nil) —

    credentials to authorize HTTP requests made by the service client.

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

    the base URI of the service.

  • options (Array) (defaults to: nil) —

    filters to be applied to the HTTP requests.



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/2018-05-31/generated/azure_mgmt_cost_management/cost_management_client.rb', line 60

def initialize(credentials = nil, base_url = nil, options = nil)
  super(credentials, options)
  @base_url = base_url || 'https://management.azure.com'

  fail ArgumentError, 'invalid type of credentials input parameter' unless credentials.is_a?(MsRest::ServiceClientCredentials) unless credentials.nil?
  @credentials = credentials

  @report_config_operations = ReportConfigOperations.new(self)
  @billing_account_dimensions = BillingAccountDimensions.new(self)
  @subscription_dimensions = SubscriptionDimensions.new(self)
  @resource_group_dimensions = ResourceGroupDimensions.new(self)
  @operations = Operations.new(self)
  @api_version = '2018-05-31'
  @accept_language = 'en-US'
  @long_running_operation_retry_timeout = 30
  @generate_client_request_id = true
  add_telemetry
end

Instance Attribute Details

#accept_language ⇒ String

Returns The preferred language for the response.

Returns:

  • (String) —

    The preferred language for the response.



28
29
30
 
# File 'lib/2018-05-31/generated/azure_mgmt_cost_management/cost_management_client.rb', line 28

def accept_language
  @accept_language
end

#api_version ⇒ String (readonly)

The current version is 2018-05-31.

Returns:

  • (String) —

    Version of the API to be used with the client request.



22
23
24
 
# File 'lib/2018-05-31/generated/azure_mgmt_cost_management/cost_management_client.rb', line 22

def api_version
  @api_version
end

#base_url ⇒ String

Returns the base URI of the service.

Returns:

  • (String) —

    the base URI of the service.



15
16
17
 
# File 'lib/2018-05-31/generated/azure_mgmt_cost_management/cost_management_client.rb', line 15

def base_url
  @base_url
end

#billing_account_dimensions ⇒ BillingAccountDimensions (readonly)

Returns billing_account_dimensions.

Returns:



43
44
45
 
# File 'lib/2018-05-31/generated/azure_mgmt_cost_management/cost_management_client.rb', line 43

def 
  @billing_account_dimensions
end

#credentials ⇒ Object (readonly)

Returns Credentials needed for the client to connect to Azure.

Returns:

  • Credentials needed for the client to connect to Azure.



18
19
20
 
# File 'lib/2018-05-31/generated/azure_mgmt_cost_management/cost_management_client.rb', line 18

def credentials
  @credentials
end

#generate_client_request_id ⇒ Boolean

generated. When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Returns:

  • (Boolean) —

    Whether a unique x-ms-client-request-id should be



37
38
39
 
# File 'lib/2018-05-31/generated/azure_mgmt_cost_management/cost_management_client.rb', line 37

def generate_client_request_id
  @generate_client_request_id
end

#long_running_operation_retry_timeout ⇒ Integer

Operations. Default value is 30.

Returns:

  • (Integer) —

    The retry timeout in seconds for Long Running



32
33
34
 
# File 'lib/2018-05-31/generated/azure_mgmt_cost_management/cost_management_client.rb', line 32

def long_running_operation_retry_timeout
  @long_running_operation_retry_timeout
end

#operations ⇒ Operations (readonly)

Returns operations.

Returns:



52
53
54
 
# File 'lib/2018-05-31/generated/azure_mgmt_cost_management/cost_management_client.rb', line 52

def operations
  @operations
end

#report_config_operations ⇒ ReportConfigOperations (readonly)

Returns report_config_operations.

Returns:



40
41
42
 
# File 'lib/2018-05-31/generated/azure_mgmt_cost_management/cost_management_client.rb', line 40

def report_config_operations
  @report_config_operations
end

#resource_group_dimensions ⇒ ResourceGroupDimensions (readonly)

Returns resource_group_dimensions.

Returns:



49
50
51
 
# File 'lib/2018-05-31/generated/azure_mgmt_cost_management/cost_management_client.rb', line 49

def resource_group_dimensions
  @resource_group_dimensions
end

#subscription_dimensions ⇒ SubscriptionDimensions (readonly)

Returns subscription_dimensions.

Returns:



46
47
48
 
# File 'lib/2018-05-31/generated/azure_mgmt_cost_management/cost_management_client.rb', line 46

def subscription_dimensions
  @subscription_dimensions
end

#subscription_id ⇒ String

Returns Azure Subscription ID.

Returns:

  • (String) —

    Azure Subscription ID.



25
26
27
 
# File 'lib/2018-05-31/generated/azure_mgmt_cost_management/cost_management_client.rb', line 25

def subscription_id
  @subscription_id
end

Instance Method Details

#make_request(method, path, options = {}) ⇒ Hash{String=>String}

Makes a request and returns the body of the response. Example:

request_content = "{'location':'westus','tags':{'tag1':'val1','tag2':'val2'}}"
path = "/path"
options = {
  body: request_content,
  query_params: {'api-version' => '2016-02-01'}
}
result = @client.make_request(:put, path, options)

Parameters:

  • method (Symbol) —

    with any of the following values :get, :put, :post, :patch, :delete.

  • path (String) —

    the path, relative to #base_url.

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

    specifying any request options like :body.

Returns:

  • (Hash{String=>String}) —

    containing the body of the response.



95
96
97
98
 
# File 'lib/2018-05-31/generated/azure_mgmt_cost_management/cost_management_client.rb', line 95

def make_request(method, path, options = {})
  result = make_request_with_http_info(method, path, options)
  result.body unless result.nil?
end

#make_request_async(method, path, options = {}) ⇒ Concurrent::Promise

Makes a request asynchronously.

Parameters:

  • method (Symbol) —

    with any of the following values :get, :put, :post, :patch, :delete.

  • path (String) —

    the path, relative to #base_url.

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

    specifying any request options like :body.

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/2018-05-31/generated/azure_mgmt_cost_management/cost_management_client.rb', line 120

def make_request_async(method, path, options = {})
  fail ArgumentError, 'method is nil' if method.nil?
  fail ArgumentError, 'path is nil' if path.nil?

  request_url = options[:base_url] || @base_url
  if(!options[:headers].nil? && !options[:headers]['Content-Type'].nil?)
    @request_headers['Content-Type'] = options[:headers]['Content-Type']
  end

  request_headers = @request_headers
  request_headers.merge!({'accept-language' => @accept_language}) unless @accept_language.nil?
  options.merge!({headers: request_headers.merge(options[:headers] || {})})
  options.merge!({credentials: @credentials}) unless @credentials.nil?

  super(request_url, method, path, options)
end

#make_request_with_http_info(method, path, options = {}) ⇒ MsRestAzure::AzureOperationResponse

Makes a request and returns the operation response.

Parameters:

  • method (Symbol) —

    with any of the following values :get, :put, :post, :patch, :delete.

  • path (String) —

    the path, relative to #base_url.

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

    specifying any request options like :body.

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    Operation response containing the request, response and status.



107
108
109
110
111
 
# File 'lib/2018-05-31/generated/azure_mgmt_cost_management/cost_management_client.rb', line 107

def make_request_with_http_info(method, path, options = {})
  result = make_request_async(method, path, options).value!
  result.body = result.response.body.to_s.empty? ? nil : JSON.load(result.response.body)
  result
end

#query_billing_account(billing_account_id, parameters, custom_headers: nil) ⇒ QueryResult

Lists the usage data for billing account.

CreateOrUpdate Report Config operation. will be added to the HTTP request.

Parameters:

  • billing_account_id (String) —

    BillingAccount ID

  • parameters (ReportConfigDefinition) —

    Parameters supplied to the

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

    A hash of custom headers that

Returns:

  • (QueryResult) —

    operation results.



352
353
354
355
 
# File 'lib/2018-05-31/generated/azure_mgmt_cost_management/cost_management_client.rb', line 352

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

#query_billing_account_async(billing_account_id, parameters, custom_headers: nil) ⇒ Concurrent::Promise

Lists the usage data for billing account.

CreateOrUpdate Report Config operation. to the HTTP request.

Parameters:

  • billing_account_id (String) —

    BillingAccount ID

  • parameters (ReportConfigDefinition) —

    Parameters supplied to the

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
 
# File 'lib/2018-05-31/generated/azure_mgmt_cost_management/cost_management_client.rb', line 383

def (, parameters, custom_headers:nil)
  fail ArgumentError, 'api_version is nil' if api_version.nil?
  fail ArgumentError, 'billing_account_id is nil' if .nil?
  fail ArgumentError, 'parameters is nil' if parameters.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'] = accept_language unless accept_language.nil?

  # Serialize Request
  request_mapper = Azure::CostManagement::Mgmt::V2018_05_31::Models::ReportConfigDefinition.mapper()
  request_content = self.serialize(request_mapper,  parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/Query'

  request_url = @base_url || self.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'billingAccountId' => },
      query_params: {'api-version' => api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.make_request_async(:post, 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::CostManagement::Mgmt::V2018_05_31::Models::QueryResult.mapper()
        result.body = self.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

#query_billing_account_with_http_info(billing_account_id, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists the usage data for billing account.

CreateOrUpdate Report Config operation. will be added to the HTTP request.

Parameters:

  • billing_account_id (String) —

    BillingAccount ID

  • parameters (ReportConfigDefinition) —

    Parameters supplied to the

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



368
369
370
 
# File 'lib/2018-05-31/generated/azure_mgmt_cost_management/cost_management_client.rb', line 368

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

#query_resource_group(resource_group_name, parameters, custom_headers: nil) ⇒ QueryResult

Lists the usage data for subscriptionId and resource group.

CreateOrUpdate Report Config operation. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Azure Resource Group Name.

  • parameters (ReportConfigDefinition) —

    Parameters supplied to the

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

    A hash of custom headers that

Returns:

  • (QueryResult) —

    operation results.



248
249
250
251
 
# File 'lib/2018-05-31/generated/azure_mgmt_cost_management/cost_management_client.rb', line 248

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

#query_resource_group_async(resource_group_name, parameters, custom_headers: nil) ⇒ Concurrent::Promise

Lists the usage data for subscriptionId and resource group.

CreateOrUpdate Report Config operation. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Azure Resource Group Name.

  • parameters (ReportConfigDefinition) —

    Parameters supplied to the

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
332
333
334
335
336
337
338
339
 
# File 'lib/2018-05-31/generated/azure_mgmt_cost_management/cost_management_client.rb', line 279

def query_resource_group_async(resource_group_name, parameters, custom_headers:nil)
  fail ArgumentError, 'api_version is nil' if api_version.nil?
  fail ArgumentError, 'subscription_id is nil' if subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'parameters is nil' if parameters.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'] = accept_language unless accept_language.nil?

  # Serialize Request
  request_mapper = Azure::CostManagement::Mgmt::V2018_05_31::Models::ReportConfigDefinition.mapper()
  request_content = self.serialize(request_mapper,  parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.CostManagement/Query'

  request_url = @base_url || self.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => subscription_id,'resourceGroupName' => resource_group_name},
      query_params: {'api-version' => api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.make_request_async(:post, 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::CostManagement::Mgmt::V2018_05_31::Models::QueryResult.mapper()
        result.body = self.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

#query_resource_group_with_http_info(resource_group_name, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists the usage data for subscriptionId and resource group.

CreateOrUpdate Report Config operation. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Azure Resource Group Name.

  • parameters (ReportConfigDefinition) —

    Parameters supplied to the

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



264
265
266
 
# File 'lib/2018-05-31/generated/azure_mgmt_cost_management/cost_management_client.rb', line 264

def query_resource_group_with_http_info(resource_group_name, parameters, custom_headers:nil)
  query_resource_group_async(resource_group_name, parameters, custom_headers:custom_headers).value!
end

#query_subscription(parameters, custom_headers: nil) ⇒ QueryResult

Lists the usage data for subscriptionId.

CreateOrUpdate Report Config operation. will be added to the HTTP request.

Parameters:

  • parameters (ReportConfigDefinition) —

    Parameters supplied to the

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

    A hash of custom headers that

Returns:

  • (QueryResult) —

    operation results.



147
148
149
150
 
# File 'lib/2018-05-31/generated/azure_mgmt_cost_management/cost_management_client.rb', line 147

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

#query_subscription_async(parameters, custom_headers: nil) ⇒ Concurrent::Promise

Lists the usage data for subscriptionId.

CreateOrUpdate Report Config operation. to the HTTP request.

Parameters:

  • parameters (ReportConfigDefinition) —

    Parameters supplied to the

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/2018-05-31/generated/azure_mgmt_cost_management/cost_management_client.rb', line 176

def query_subscription_async(parameters, custom_headers:nil)
  fail ArgumentError, 'api_version is nil' if api_version.nil?
  fail ArgumentError, 'subscription_id is nil' if subscription_id.nil?
  fail ArgumentError, 'parameters is nil' if parameters.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'] = accept_language unless accept_language.nil?

  # Serialize Request
  request_mapper = Azure::CostManagement::Mgmt::V2018_05_31::Models::ReportConfigDefinition.mapper()
  request_content = self.serialize(request_mapper,  parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/providers/Microsoft.CostManagement/Query'

  request_url = @base_url || self.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => subscription_id},
      query_params: {'api-version' => api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.make_request_async(:post, 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::CostManagement::Mgmt::V2018_05_31::Models::QueryResult.mapper()
        result.body = self.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

#query_subscription_with_http_info(parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists the usage data for subscriptionId.

CreateOrUpdate Report Config operation. will be added to the HTTP request.

Parameters:

  • parameters (ReportConfigDefinition) —

    Parameters supplied to the

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



162
163
164
 
# File 'lib/2018-05-31/generated/azure_mgmt_cost_management/cost_management_client.rb', line 162

def query_subscription_with_http_info(parameters, custom_headers:nil)
  query_subscription_async(parameters, custom_headers:custom_headers).value!
end