Class: Azure::CostManagement::Mgmt::V2019_01_01::Exports

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-01-01/generated/azure_mgmt_cost_management/exports.rb

Overview

Exports

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Exports

Creates and initializes a new instance of the Exports class.

Parameters:

  • client —

    service class for accessing basic functionality.



17
18
19
 
# File 'lib/2019-01-01/generated/azure_mgmt_cost_management/exports.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ CostManagementClient (readonly)

Returns reference to the CostManagementClient.

Returns:



22
23
24
 
# File 'lib/2019-01-01/generated/azure_mgmt_cost_management/exports.rb', line 22

def client
  @client
end

Instance Method Details

#create_or_update(scope, export_name, parameters, custom_headers: nil) ⇒ Export

The operation to create or update a export. Update operation requires latest eTag to be set in the request. You may obtain the latest eTag by performing a get operation. Create operation does not require eTag.

includes '/subscriptions/subscriptionId' for subscription scope, '/subscriptions/subscriptionId/resourceGroups/resourceGroupName' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/billingAccountId' for Billing Account scope and '/providers/Microsoft.Billing/billingAccounts/billingAccountId/departments/departmentId' for Department scope, '/providers/Microsoft.Billing/billingAccounts/billingAccountId/enrollmentAccounts/enrollmentAccountId' for EnrollmentAccount scope. operation. will be added to the HTTP request.

Parameters:

  • scope (String) —

    The scope associated with export operations. This

  • export_name (String) —

    Export Name.

  • parameters (Export) —

    Parameters supplied to the CreateOrUpdate Export

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

    A hash of custom headers that

Returns:

  • (Export) —

    operation results.



284
285
286
287
 
# File 'lib/2019-01-01/generated/azure_mgmt_cost_management/exports.rb', line 284

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

#create_or_update_async(scope, export_name, parameters, custom_headers: nil) ⇒ Concurrent::Promise

The operation to create or update a export. Update operation requires latest eTag to be set in the request. You may obtain the latest eTag by performing a get operation. Create operation does not require eTag.

includes '/subscriptions/subscriptionId' for subscription scope, '/subscriptions/subscriptionId/resourceGroups/resourceGroupName' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/billingAccountId' for Billing Account scope and '/providers/Microsoft.Billing/billingAccounts/billingAccountId/departments/departmentId' for Department scope, '/providers/Microsoft.Billing/billingAccounts/billingAccountId/enrollmentAccounts/enrollmentAccountId' for EnrollmentAccount scope. operation. to the HTTP request.

Parameters:

  • scope (String) —

    The scope associated with export operations. This

  • export_name (String) —

    Export Name.

  • parameters (Export) —

    Parameters supplied to the CreateOrUpdate Export

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
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
 
# File 'lib/2019-01-01/generated/azure_mgmt_cost_management/exports.rb', line 339

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

  # Serialize Request
  request_mapper = Azure::CostManagement::Mgmt::V2019_01_01::Models::Export.mapper()
  request_content = @client.serialize(request_mapper,  parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = '{scope}/providers/Microsoft.CostManagement/exports/{exportName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'exportName' => export_name},
      skip_encoding_path_params: {'scope' => scope},
      query_params: {'api-version' => @client.api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:put, 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 || status_code == 201
      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::V2019_01_01::Models::Export.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
    # Deserialize Response
    if status_code == 201
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::CostManagement::Mgmt::V2019_01_01::Models::Export.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

#create_or_update_with_http_info(scope, export_name, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

The operation to create or update a export. Update operation requires latest eTag to be set in the request. You may obtain the latest eTag by performing a get operation. Create operation does not require eTag.

includes '/subscriptions/subscriptionId' for subscription scope, '/subscriptions/subscriptionId/resourceGroups/resourceGroupName' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/billingAccountId' for Billing Account scope and '/providers/Microsoft.Billing/billingAccounts/billingAccountId/departments/departmentId' for Department scope, '/providers/Microsoft.Billing/billingAccounts/billingAccountId/enrollmentAccounts/enrollmentAccountId' for EnrollmentAccount scope. operation. will be added to the HTTP request.

Parameters:

  • scope (String) —

    The scope associated with export operations. This

  • export_name (String) —

    Export Name.

  • parameters (Export) —

    Parameters supplied to the CreateOrUpdate Export

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



312
313
314
 
# File 'lib/2019-01-01/generated/azure_mgmt_cost_management/exports.rb', line 312

def create_or_update_with_http_info(scope, export_name, parameters, custom_headers:nil)
  create_or_update_async(scope, export_name, parameters, custom_headers:custom_headers).value!
end

#delete(scope, export_name, custom_headers: nil) ⇒ Object

The operation to delete a export.

includes '/subscriptions/subscriptionId' for subscription scope, '/subscriptions/subscriptionId/resourceGroups/resourceGroupName' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/billingAccountId' for Billing Account scope and '/providers/Microsoft.Billing/billingAccounts/billingAccountId/departments/departmentId' for Department scope, '/providers/Microsoft.Billing/billingAccounts/billingAccountId/enrollmentAccounts/enrollmentAccountId' for EnrollmentAccount scope. will be added to the HTTP request.

Parameters:

  • scope (String) —

    The scope associated with export operations. This

  • export_name (String) —

    Export Name.

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

    A hash of custom headers that



430
431
432
433
 
# File 'lib/2019-01-01/generated/azure_mgmt_cost_management/exports.rb', line 430

def delete(scope, export_name, custom_headers:nil)
  response = delete_async(scope, export_name, custom_headers:custom_headers).value!
  nil
end

#delete_async(scope, export_name, custom_headers: nil) ⇒ Concurrent::Promise

The operation to delete a export.

includes '/subscriptions/subscriptionId' for subscription scope, '/subscriptions/subscriptionId/resourceGroups/resourceGroupName' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/billingAccountId' for Billing Account scope and '/providers/Microsoft.Billing/billingAccounts/billingAccountId/departments/departmentId' for Department scope, '/providers/Microsoft.Billing/billingAccounts/billingAccountId/enrollmentAccounts/enrollmentAccountId' for EnrollmentAccount scope. to the HTTP request.

Parameters:

  • scope (String) —

    The scope associated with export operations. This

  • export_name (String) —

    Export Name.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
 
# File 'lib/2019-01-01/generated/azure_mgmt_cost_management/exports.rb', line 477

def delete_async(scope, export_name, custom_headers:nil)
  fail ArgumentError, 'scope is nil' if scope.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'export_name is nil' if export_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 = '{scope}/providers/Microsoft.CostManagement/exports/{exportName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'exportName' => export_name},
      skip_encoding_path_params: {'scope' => scope},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:delete, 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?

    result
  end

  promise.execute
end

#delete_with_http_info(scope, export_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

The operation to delete a export.

includes '/subscriptions/subscriptionId' for subscription scope, '/subscriptions/subscriptionId/resourceGroups/resourceGroupName' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/billingAccountId' for Billing Account scope and '/providers/Microsoft.Billing/billingAccounts/billingAccountId/departments/departmentId' for Department scope, '/providers/Microsoft.Billing/billingAccounts/billingAccountId/enrollmentAccounts/enrollmentAccountId' for EnrollmentAccount scope. will be added to the HTTP request.

Parameters:

  • scope (String) —

    The scope associated with export operations. This

  • export_name (String) —

    Export Name.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



454
455
456
 
# File 'lib/2019-01-01/generated/azure_mgmt_cost_management/exports.rb', line 454

def delete_with_http_info(scope, export_name, custom_headers:nil)
  delete_async(scope, export_name, custom_headers:custom_headers).value!
end

#execute(scope, export_name, custom_headers: nil) ⇒ Object

The operation to execute a export.

includes '/subscriptions/subscriptionId' for subscription scope, '/subscriptions/subscriptionId/resourceGroups/resourceGroupName' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/billingAccountId' for Billing Account scope and '/providers/Microsoft.Billing/billingAccounts/billingAccountId/departments/departmentId' for Department scope, '/providers/Microsoft.Billing/billingAccounts/billingAccountId/enrollmentAccounts/enrollmentAccountId' for EnrollmentAccount scope. will be added to the HTTP request.

Parameters:

  • scope (String) —

    The scope associated with export operations. This

  • export_name (String) —

    Export Name.

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

    A hash of custom headers that



540
541
542
543
 
# File 'lib/2019-01-01/generated/azure_mgmt_cost_management/exports.rb', line 540

def execute(scope, export_name, custom_headers:nil)
  response = execute_async(scope, export_name, custom_headers:custom_headers).value!
  nil
end

#execute_async(scope, export_name, custom_headers: nil) ⇒ Concurrent::Promise

The operation to execute a export.

includes '/subscriptions/subscriptionId' for subscription scope, '/subscriptions/subscriptionId/resourceGroups/resourceGroupName' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/billingAccountId' for Billing Account scope and '/providers/Microsoft.Billing/billingAccounts/billingAccountId/departments/departmentId' for Department scope, '/providers/Microsoft.Billing/billingAccounts/billingAccountId/enrollmentAccounts/enrollmentAccountId' for EnrollmentAccount scope. to the HTTP request.

Parameters:

  • scope (String) —

    The scope associated with export operations. This

  • export_name (String) —

    Export Name.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
 
# File 'lib/2019-01-01/generated/azure_mgmt_cost_management/exports.rb', line 587

def execute_async(scope, export_name, custom_headers:nil)
  fail ArgumentError, 'scope is nil' if scope.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'export_name is nil' if export_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 = '{scope}/providers/Microsoft.CostManagement/exports/{exportName}/run'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'exportName' => export_name},
      skip_encoding_path_params: {'scope' => scope},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.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?

    result
  end

  promise.execute
end

#execute_with_http_info(scope, export_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

The operation to execute a export.

includes '/subscriptions/subscriptionId' for subscription scope, '/subscriptions/subscriptionId/resourceGroups/resourceGroupName' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/billingAccountId' for Billing Account scope and '/providers/Microsoft.Billing/billingAccounts/billingAccountId/departments/departmentId' for Department scope, '/providers/Microsoft.Billing/billingAccounts/billingAccountId/enrollmentAccounts/enrollmentAccountId' for EnrollmentAccount scope. will be added to the HTTP request.

Parameters:

  • scope (String) —

    The scope associated with export operations. This

  • export_name (String) —

    Export Name.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



564
565
566
 
# File 'lib/2019-01-01/generated/azure_mgmt_cost_management/exports.rb', line 564

def execute_with_http_info(scope, export_name, custom_headers:nil)
  execute_async(scope, export_name, custom_headers:custom_headers).value!
end

#get(scope, export_name, custom_headers: nil) ⇒ Export

Gets the export for the defined scope by export name.

includes '/subscriptions/subscriptionId' for subscription scope, '/subscriptions/subscriptionId/resourceGroups/resourceGroupName' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/billingAccountId' for Billing Account scope and '/providers/Microsoft.Billing/billingAccounts/billingAccountId/departments/departmentId' for Department scope, '/providers/Microsoft.Billing/billingAccounts/billingAccountId/enrollmentAccounts/enrollmentAccountId' for EnrollmentAccount scope. will be added to the HTTP request.

Parameters:

  • scope (String) —

    The scope associated with export operations. This

  • export_name (String) —

    Export Name.

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

    A hash of custom headers that

Returns:

  • (Export) —

    operation results.



159
160
161
162
 
# File 'lib/2019-01-01/generated/azure_mgmt_cost_management/exports.rb', line 159

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

#get_async(scope, export_name, custom_headers: nil) ⇒ Concurrent::Promise

Gets the export for the defined scope by export name.

includes '/subscriptions/subscriptionId' for subscription scope, '/subscriptions/subscriptionId/resourceGroups/resourceGroupName' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/billingAccountId' for Billing Account scope and '/providers/Microsoft.Billing/billingAccounts/billingAccountId/departments/departmentId' for Department scope, '/providers/Microsoft.Billing/billingAccounts/billingAccountId/enrollmentAccounts/enrollmentAccountId' for EnrollmentAccount scope. to the HTTP request.

Parameters:

  • scope (String) —

    The scope associated with export operations. This

  • export_name (String) —

    Export Name.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/2019-01-01/generated/azure_mgmt_cost_management/exports.rb', line 206

def get_async(scope, export_name, custom_headers:nil)
  fail ArgumentError, 'scope is nil' if scope.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'export_name is nil' if export_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 = '{scope}/providers/Microsoft.CostManagement/exports/{exportName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'exportName' => export_name},
      skip_encoding_path_params: {'scope' => scope},
      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::CostManagement::Mgmt::V2019_01_01::Models::Export.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_execution_history(scope, export_name, custom_headers: nil) ⇒ ExportExecutionListResult

Gets the execution history of a export for the defined scope by export name.

includes '/subscriptions/subscriptionId' for subscription scope, '/subscriptions/subscriptionId/resourceGroups/resourceGroupName' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/billingAccountId' for Billing Account scope and '/providers/Microsoft.Billing/billingAccounts/billingAccountId/departments/departmentId' for Department scope, '/providers/Microsoft.Billing/billingAccounts/billingAccountId/enrollmentAccounts/enrollmentAccountId' for EnrollmentAccount scope. will be added to the HTTP request.

Parameters:

  • scope (String) —

    The scope associated with export operations. This

  • export_name (String) —

    Export Name.

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

    A hash of custom headers that

Returns:

  • (ExportExecutionListResult) —

    operation results.



651
652
653
654
 
# File 'lib/2019-01-01/generated/azure_mgmt_cost_management/exports.rb', line 651

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

#get_execution_history_async(scope, export_name, custom_headers: nil) ⇒ Concurrent::Promise

Gets the execution history of a export for the defined scope by export name.

includes '/subscriptions/subscriptionId' for subscription scope, '/subscriptions/subscriptionId/resourceGroups/resourceGroupName' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/billingAccountId' for Billing Account scope and '/providers/Microsoft.Billing/billingAccounts/billingAccountId/departments/departmentId' for Department scope, '/providers/Microsoft.Billing/billingAccounts/billingAccountId/enrollmentAccounts/enrollmentAccountId' for EnrollmentAccount scope. to the HTTP request.

Parameters:

  • scope (String) —

    The scope associated with export operations. This

  • export_name (String) —

    Export Name.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
 
# File 'lib/2019-01-01/generated/azure_mgmt_cost_management/exports.rb', line 698

def get_execution_history_async(scope, export_name, custom_headers:nil)
  fail ArgumentError, 'scope is nil' if scope.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'export_name is nil' if export_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 = '{scope}/providers/Microsoft.CostManagement/exports/{exportName}/runHistory'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'exportName' => export_name},
      skip_encoding_path_params: {'scope' => scope},
      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::CostManagement::Mgmt::V2019_01_01::Models::ExportExecutionListResult.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_execution_history_with_http_info(scope, export_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets the execution history of a export for the defined scope by export name.

includes '/subscriptions/subscriptionId' for subscription scope, '/subscriptions/subscriptionId/resourceGroups/resourceGroupName' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/billingAccountId' for Billing Account scope and '/providers/Microsoft.Billing/billingAccounts/billingAccountId/departments/departmentId' for Department scope, '/providers/Microsoft.Billing/billingAccounts/billingAccountId/enrollmentAccounts/enrollmentAccountId' for EnrollmentAccount scope. will be added to the HTTP request.

Parameters:

  • scope (String) —

    The scope associated with export operations. This

  • export_name (String) —

    Export Name.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



675
676
677
 
# File 'lib/2019-01-01/generated/azure_mgmt_cost_management/exports.rb', line 675

def get_execution_history_with_http_info(scope, export_name, custom_headers:nil)
  get_execution_history_async(scope, export_name, custom_headers:custom_headers).value!
end

#get_with_http_info(scope, export_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets the export for the defined scope by export name.

includes '/subscriptions/subscriptionId' for subscription scope, '/subscriptions/subscriptionId/resourceGroups/resourceGroupName' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/billingAccountId' for Billing Account scope and '/providers/Microsoft.Billing/billingAccounts/billingAccountId/departments/departmentId' for Department scope, '/providers/Microsoft.Billing/billingAccounts/billingAccountId/enrollmentAccounts/enrollmentAccountId' for EnrollmentAccount scope. will be added to the HTTP request.

Parameters:

  • scope (String) —

    The scope associated with export operations. This

  • export_name (String) —

    Export Name.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



183
184
185
 
# File 'lib/2019-01-01/generated/azure_mgmt_cost_management/exports.rb', line 183

def get_with_http_info(scope, export_name, custom_headers:nil)
  get_async(scope, export_name, custom_headers:custom_headers).value!
end

#list(scope, custom_headers: nil) ⇒ ExportListResult

Lists all exports at the given scope.

includes '/subscriptions/subscriptionId' for subscription scope, '/subscriptions/subscriptionId/resourceGroups/resourceGroupName' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/billingAccountId' for Billing Account scope and '/providers/Microsoft.Billing/billingAccounts/billingAccountId/departments/departmentId' for Department scope, '/providers/Microsoft.Billing/billingAccounts/billingAccountId/enrollmentAccounts/enrollmentAccountId' for EnrollmentAccount scope. will be added to the HTTP request.

Parameters:

  • scope (String) —

    The scope associated with export operations. This

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

    A hash of custom headers that

Returns:

  • (ExportListResult) —

    operation results.



42
43
44
45
 
# File 'lib/2019-01-01/generated/azure_mgmt_cost_management/exports.rb', line 42

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

#list_async(scope, custom_headers: nil) ⇒ Concurrent::Promise

Lists all exports at the given scope.

includes '/subscriptions/subscriptionId' for subscription scope, '/subscriptions/subscriptionId/resourceGroups/resourceGroupName' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/billingAccountId' for Billing Account scope and '/providers/Microsoft.Billing/billingAccounts/billingAccountId/departments/departmentId' for Department scope, '/providers/Microsoft.Billing/billingAccounts/billingAccountId/enrollmentAccounts/enrollmentAccountId' for EnrollmentAccount scope. to the HTTP request.

Parameters:

  • scope (String) —

    The scope associated with export operations. This

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/2019-01-01/generated/azure_mgmt_cost_management/exports.rb', line 87

def list_async(scope, 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.CostManagement/exports'

  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},
      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::CostManagement::Mgmt::V2019_01_01::Models::ExportListResult.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, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists all exports at the given scope.

includes '/subscriptions/subscriptionId' for subscription scope, '/subscriptions/subscriptionId/resourceGroups/resourceGroupName' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/billingAccountId' for Billing Account scope and '/providers/Microsoft.Billing/billingAccounts/billingAccountId/departments/departmentId' for Department scope, '/providers/Microsoft.Billing/billingAccounts/billingAccountId/enrollmentAccounts/enrollmentAccountId' for EnrollmentAccount scope. will be added to the HTTP request.

Parameters:

  • scope (String) —

    The scope associated with export operations. This

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



65
66
67
 
# File 'lib/2019-01-01/generated/azure_mgmt_cost_management/exports.rb', line 65

def list_with_http_info(scope, custom_headers:nil)
  list_async(scope, custom_headers:custom_headers).value!
end