Class: Azure::Consumption::Mgmt::V2019_05_01_preview::Budgets

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

Creates and initializes a new instance of the Budgets class.

Parameters:

  • client —

    service class for accessing basic functionality.



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

def client
  @client
end

Instance Method Details

#create_or_update(scope, budget_name, parameters, custom_headers: nil) ⇒ Budget

The operation to create or update a budget. Update operation requires latest eTag to be set in the request mandatorily. 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, ‘/providers/Microsoft.Billing/billingAccounts/billingAccountId/departments/departmentId’ for Department scope, ‘/providers/Microsoft.Billing/billingAccounts/billingAccountId/enrollmentAccounts/enrollmentAccountId’ for EnrollmentAccount scope, ‘/providers/Microsoft.Management/managementGroups/managementGroupId’ for Management Group scope, ‘/providers/Microsoft.Billing/billingAccounts/billingAccountId/billingProfiles/billingProfileId’ for billingProfile scope, ‘providers/Microsoft.Billing/billingAccounts/billingAccountId/invoiceSections/invoiceSectionId’ for invoiceSection scope. operation. will be added to the HTTP request.

Parameters:

  • scope (String) —

    The scope associated with budget operations. This

  • budget_name (String) —

    Budget Name.

  • parameters (Budget) —

    Parameters supplied to the Create Budget

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

    A hash of custom headers that

Returns:

  • (Budget) —

    operation results.



327
328
329
330
 
# File 'lib/2019-05-01-preview/generated/azure_mgmt_consumption/budgets.rb', line 327

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

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

The operation to create or update a budget. Update operation requires latest eTag to be set in the request mandatorily. 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, ‘/providers/Microsoft.Billing/billingAccounts/billingAccountId/departments/departmentId’ for Department scope, ‘/providers/Microsoft.Billing/billingAccounts/billingAccountId/enrollmentAccounts/enrollmentAccountId’ for EnrollmentAccount scope, ‘/providers/Microsoft.Management/managementGroups/managementGroupId’ for Management Group scope, ‘/providers/Microsoft.Billing/billingAccounts/billingAccountId/billingProfiles/billingProfileId’ for billingProfile scope, ‘providers/Microsoft.Billing/billingAccounts/billingAccountId/invoiceSections/invoiceSectionId’ for invoiceSection scope. operation. to the HTTP request.

Parameters:

  • scope (String) —

    The scope associated with budget operations. This

  • budget_name (String) —

    Budget Name.

  • parameters (Budget) —

    Parameters supplied to the Create Budget

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
 
# File 'lib/2019-05-01-preview/generated/azure_mgmt_consumption/budgets.rb', line 394

def create_or_update_async(scope, budget_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, 'budget_name is nil' if budget_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::Consumption::Mgmt::V2019_05_01_preview::Models::Budget.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.Consumption/budgets/{budgetName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'budgetName' => budget_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::Consumption::Mgmt::V2019_05_01_preview::Models::Budget.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::Consumption::Mgmt::V2019_05_01_preview::Models::Budget.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, budget_name, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

The operation to create or update a budget. Update operation requires latest eTag to be set in the request mandatorily. 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, ‘/providers/Microsoft.Billing/billingAccounts/billingAccountId/departments/departmentId’ for Department scope, ‘/providers/Microsoft.Billing/billingAccounts/billingAccountId/enrollmentAccounts/enrollmentAccountId’ for EnrollmentAccount scope, ‘/providers/Microsoft.Management/managementGroups/managementGroupId’ for Management Group scope, ‘/providers/Microsoft.Billing/billingAccounts/billingAccountId/billingProfiles/billingProfileId’ for billingProfile scope, ‘providers/Microsoft.Billing/billingAccounts/billingAccountId/invoiceSections/invoiceSectionId’ for invoiceSection scope. operation. will be added to the HTTP request.

Parameters:

  • scope (String) —

    The scope associated with budget operations. This

  • budget_name (String) —

    Budget Name.

  • parameters (Budget) —

    Parameters supplied to the Create Budget

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



361
362
363
 
# File 'lib/2019-05-01-preview/generated/azure_mgmt_consumption/budgets.rb', line 361

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

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

The operation to delete a budget.

includes ‘/subscriptions/subscriptionId/’ for subscription scope, ‘/subscriptions/subscriptionId/resourceGroups/resourceGroupName’ for resourceGroup scope, ‘/providers/Microsoft.Billing/billingAccounts/billingAccountId’ for Billing Account scope, ‘/providers/Microsoft.Billing/billingAccounts/billingAccountId/departments/departmentId’ for Department scope, ‘/providers/Microsoft.Billing/billingAccounts/billingAccountId/enrollmentAccounts/enrollmentAccountId’ for EnrollmentAccount scope, ‘/providers/Microsoft.Management/managementGroups/managementGroupId’ for Management Group scope, ‘/providers/Microsoft.Billing/billingAccounts/billingAccountId/billingProfiles/billingProfileId’ for billingProfile scope, ‘providers/Microsoft.Billing/billingAccounts/billingAccountId/invoiceSections/invoiceSectionId’ for invoiceSection scope. will be added to the HTTP request.

Parameters:

  • scope (String) —

    The scope associated with budget operations. This

  • budget_name (String) —

    Budget Name.

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

    A hash of custom headers that



491
492
493
494
 
# File 'lib/2019-05-01-preview/generated/azure_mgmt_consumption/budgets.rb', line 491

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

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

The operation to delete a budget.

includes ‘/subscriptions/subscriptionId/’ for subscription scope, ‘/subscriptions/subscriptionId/resourceGroups/resourceGroupName’ for resourceGroup scope, ‘/providers/Microsoft.Billing/billingAccounts/billingAccountId’ for Billing Account scope, ‘/providers/Microsoft.Billing/billingAccounts/billingAccountId/departments/departmentId’ for Department scope, ‘/providers/Microsoft.Billing/billingAccounts/billingAccountId/enrollmentAccounts/enrollmentAccountId’ for EnrollmentAccount scope, ‘/providers/Microsoft.Management/managementGroups/managementGroupId’ for Management Group scope, ‘/providers/Microsoft.Billing/billingAccounts/billingAccountId/billingProfiles/billingProfileId’ for billingProfile scope, ‘providers/Microsoft.Billing/billingAccounts/billingAccountId/invoiceSections/invoiceSectionId’ for invoiceSection scope. to the HTTP request.

Parameters:

  • scope (String) —

    The scope associated with budget operations. This

  • budget_name (String) —

    Budget Name.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
 
# File 'lib/2019-05-01-preview/generated/azure_mgmt_consumption/budgets.rb', line 550

def delete_async(scope, budget_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, 'budget_name is nil' if budget_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.Consumption/budgets/{budgetName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'budgetName' => budget_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, budget_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

The operation to delete a budget.

includes ‘/subscriptions/subscriptionId/’ for subscription scope, ‘/subscriptions/subscriptionId/resourceGroups/resourceGroupName’ for resourceGroup scope, ‘/providers/Microsoft.Billing/billingAccounts/billingAccountId’ for Billing Account scope, ‘/providers/Microsoft.Billing/billingAccounts/billingAccountId/departments/departmentId’ for Department scope, ‘/providers/Microsoft.Billing/billingAccounts/billingAccountId/enrollmentAccounts/enrollmentAccountId’ for EnrollmentAccount scope, ‘/providers/Microsoft.Management/managementGroups/managementGroupId’ for Management Group scope, ‘/providers/Microsoft.Billing/billingAccounts/billingAccountId/billingProfiles/billingProfileId’ for billingProfile scope, ‘providers/Microsoft.Billing/billingAccounts/billingAccountId/invoiceSections/invoiceSectionId’ for invoiceSection scope. will be added to the HTTP request.

Parameters:

  • scope (String) —

    The scope associated with budget operations. This

  • budget_name (String) —

    Budget Name.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



521
522
523
 
# File 'lib/2019-05-01-preview/generated/azure_mgmt_consumption/budgets.rb', line 521

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

#get(scope, budget_name, custom_headers: nil) ⇒ Budget

Gets the budget for the scope by budget name.

includes ‘/subscriptions/subscriptionId/’ for subscription scope, ‘/subscriptions/subscriptionId/resourceGroups/resourceGroupName’ for resourceGroup scope, ‘/providers/Microsoft.Billing/billingAccounts/billingAccountId’ for Billing Account scope, ‘/providers/Microsoft.Billing/billingAccounts/billingAccountId/departments/departmentId’ for Department scope, ‘/providers/Microsoft.Billing/billingAccounts/billingAccountId/enrollmentAccounts/enrollmentAccountId’ for EnrollmentAccount scope, ‘/providers/Microsoft.Management/managementGroups/managementGroupId’ for Management Group scope, ‘/providers/Microsoft.Billing/billingAccounts/billingAccountId/billingProfiles/billingProfileId’ for billingProfile scope, ‘providers/Microsoft.Billing/billingAccounts/billingAccountId/invoiceSections/invoiceSectionId’ for invoiceSection scope. will be added to the HTTP request.

Parameters:

  • scope (String) —

    The scope associated with budget operations. This

  • budget_name (String) —

    Budget Name.

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

    A hash of custom headers that

Returns:

  • (Budget) —

    operation results.



184
185
186
187
 
# File 'lib/2019-05-01-preview/generated/azure_mgmt_consumption/budgets.rb', line 184

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

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

Gets the budget for the scope by budget name.

includes ‘/subscriptions/subscriptionId/’ for subscription scope, ‘/subscriptions/subscriptionId/resourceGroups/resourceGroupName’ for resourceGroup scope, ‘/providers/Microsoft.Billing/billingAccounts/billingAccountId’ for Billing Account scope, ‘/providers/Microsoft.Billing/billingAccounts/billingAccountId/departments/departmentId’ for Department scope, ‘/providers/Microsoft.Billing/billingAccounts/billingAccountId/enrollmentAccounts/enrollmentAccountId’ for EnrollmentAccount scope, ‘/providers/Microsoft.Management/managementGroups/managementGroupId’ for Management Group scope, ‘/providers/Microsoft.Billing/billingAccounts/billingAccountId/billingProfiles/billingProfileId’ for billingProfile scope, ‘providers/Microsoft.Billing/billingAccounts/billingAccountId/invoiceSections/invoiceSectionId’ for invoiceSection scope. to the HTTP request.

Parameters:

  • scope (String) —

    The scope associated with budget operations. This

  • budget_name (String) —

    Budget Name.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/2019-05-01-preview/generated/azure_mgmt_consumption/budgets.rb', line 243

def get_async(scope, budget_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, 'budget_name is nil' if budget_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.Consumption/budgets/{budgetName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'budgetName' => budget_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::Consumption::Mgmt::V2019_05_01_preview::Models::Budget.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_with_http_info(scope, budget_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets the budget for the scope by budget name.

includes ‘/subscriptions/subscriptionId/’ for subscription scope, ‘/subscriptions/subscriptionId/resourceGroups/resourceGroupName’ for resourceGroup scope, ‘/providers/Microsoft.Billing/billingAccounts/billingAccountId’ for Billing Account scope, ‘/providers/Microsoft.Billing/billingAccounts/billingAccountId/departments/departmentId’ for Department scope, ‘/providers/Microsoft.Billing/billingAccounts/billingAccountId/enrollmentAccounts/enrollmentAccountId’ for EnrollmentAccount scope, ‘/providers/Microsoft.Management/managementGroups/managementGroupId’ for Management Group scope, ‘/providers/Microsoft.Billing/billingAccounts/billingAccountId/billingProfiles/billingProfileId’ for billingProfile scope, ‘providers/Microsoft.Billing/billingAccounts/billingAccountId/invoiceSections/invoiceSectionId’ for invoiceSection scope. will be added to the HTTP request.

Parameters:

  • scope (String) —

    The scope associated with budget operations. This

  • budget_name (String) —

    Budget Name.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



214
215
216
 
# File 'lib/2019-05-01-preview/generated/azure_mgmt_consumption/budgets.rb', line 214

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

#list(scope, custom_headers: nil) ⇒ Array<Budget>

Lists all budgets for the defined scope.

includes ‘/subscriptions/subscriptionId/’ for subscription scope, ‘/subscriptions/subscriptionId/resourceGroups/resourceGroupName’ for resourceGroup scope, ‘/providers/Microsoft.Billing/billingAccounts/billingAccountId’ for Billing Account scope, ‘/providers/Microsoft.Billing/billingAccounts/billingAccountId/departments/departmentId’ for Department scope, ‘/providers/Microsoft.Billing/billingAccounts/billingAccountId/enrollmentAccounts/enrollmentAccountId’ for EnrollmentAccount scope, ‘/providers/Microsoft.Management/managementGroups/managementGroupId’ for Management Group scope, ‘/providers/Microsoft.Billing/billingAccounts/billingAccountId/billingProfiles/billingProfileId’ for billingProfile scope, ‘providers/Microsoft.Billing/billingAccounts/billingAccountId/invoiceSections/invoiceSectionId’ for invoiceSection scope. will be added to the HTTP request.

Parameters:

  • scope (String) —

    The scope associated with budget operations. This

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

    A hash of custom headers that

Returns:

  • (Array<Budget>) —

    operation results.



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

def list(scope, custom_headers:nil)
  first_page = list_as_lazy(scope, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_as_lazy(scope, custom_headers: nil) ⇒ BudgetsListResult

Lists all budgets for the defined scope.

includes ‘/subscriptions/subscriptionId/’ for subscription scope, ‘/subscriptions/subscriptionId/resourceGroups/resourceGroupName’ for resourceGroup scope, ‘/providers/Microsoft.Billing/billingAccounts/billingAccountId’ for Billing Account scope, ‘/providers/Microsoft.Billing/billingAccounts/billingAccountId/departments/departmentId’ for Department scope, ‘/providers/Microsoft.Billing/billingAccounts/billingAccountId/enrollmentAccounts/enrollmentAccountId’ for EnrollmentAccount scope, ‘/providers/Microsoft.Management/managementGroups/managementGroupId’ for Management Group scope, ‘/providers/Microsoft.Billing/billingAccounts/billingAccountId/billingProfiles/billingProfileId’ for billingProfile scope, ‘providers/Microsoft.Billing/billingAccounts/billingAccountId/invoiceSections/invoiceSectionId’ for invoiceSection scope. will be added to the HTTP request.

response.

Parameters:

  • scope (String) —

    The scope associated with budget operations. This

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

    A hash of custom headers that

Returns:

  • (BudgetsListResult) —

    which provide lazy access to pages of the



710
711
712
713
714
715
716
717
718
719
 
# File 'lib/2019-05-01-preview/generated/azure_mgmt_consumption/budgets.rb', line 710

def list_as_lazy(scope, custom_headers:nil)
  response = list_async(scope, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

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

Lists all budgets for the defined scope.

includes ‘/subscriptions/subscriptionId/’ for subscription scope, ‘/subscriptions/subscriptionId/resourceGroups/resourceGroupName’ for resourceGroup scope, ‘/providers/Microsoft.Billing/billingAccounts/billingAccountId’ for Billing Account scope, ‘/providers/Microsoft.Billing/billingAccounts/billingAccountId/departments/departmentId’ for Department scope, ‘/providers/Microsoft.Billing/billingAccounts/billingAccountId/enrollmentAccounts/enrollmentAccountId’ for EnrollmentAccount scope, ‘/providers/Microsoft.Management/managementGroups/managementGroupId’ for Management Group scope, ‘/providers/Microsoft.Billing/billingAccounts/billingAccountId/billingProfiles/billingProfileId’ for billingProfile scope, ‘providers/Microsoft.Billing/billingAccounts/billingAccountId/invoiceSections/invoiceSectionId’ for invoiceSection scope. to the HTTP request.

Parameters:

  • scope (String) —

    The scope associated with budget operations. This

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
155
156
157
 
# File 'lib/2019-05-01-preview/generated/azure_mgmt_consumption/budgets.rb', line 106

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.Consumption/budgets'

  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::Consumption::Mgmt::V2019_05_01_preview::Models::BudgetsListResult.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_next(next_page_link, custom_headers: nil) ⇒ BudgetsListResult

Lists all budgets for the defined scope.

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (BudgetsListResult) —

    operation results.



605
606
607
608
 
# File 'lib/2019-05-01-preview/generated/azure_mgmt_consumption/budgets.rb', line 605

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

#list_next_async(next_page_link, custom_headers: nil) ⇒ Concurrent::Promise

Lists all budgets for the defined scope.

to List operation. to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
 
# File 'lib/2019-05-01-preview/generated/azure_mgmt_consumption/budgets.rb', line 634

def list_next_async(next_page_link, custom_headers:nil)
  fail ArgumentError, 'next_page_link is nil' if next_page_link.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 = '{nextLink}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      skip_encoding_path_params: {'nextLink' => next_page_link},
      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::BudgetsListResult.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_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists all budgets for the defined scope.

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



620
621
622
 
# File 'lib/2019-05-01-preview/generated/azure_mgmt_consumption/budgets.rb', line 620

def list_next_with_http_info(next_page_link, custom_headers:nil)
  list_next_async(next_page_link, custom_headers:custom_headers).value!
end

#list_with_http_info(scope, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists all budgets for the defined scope.

includes ‘/subscriptions/subscriptionId/’ for subscription scope, ‘/subscriptions/subscriptionId/resourceGroups/resourceGroupName’ for resourceGroup scope, ‘/providers/Microsoft.Billing/billingAccounts/billingAccountId’ for Billing Account scope, ‘/providers/Microsoft.Billing/billingAccounts/billingAccountId/departments/departmentId’ for Department scope, ‘/providers/Microsoft.Billing/billingAccounts/billingAccountId/enrollmentAccounts/enrollmentAccountId’ for EnrollmentAccount scope, ‘/providers/Microsoft.Management/managementGroups/managementGroupId’ for Management Group scope, ‘/providers/Microsoft.Billing/billingAccounts/billingAccountId/billingProfiles/billingProfileId’ for billingProfile scope, ‘providers/Microsoft.Billing/billingAccounts/billingAccountId/invoiceSections/invoiceSectionId’ for invoiceSection scope. will be added to the HTTP request.

Parameters:

  • scope (String) —

    The scope associated with budget operations. This

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



78
79
80
 
# File 'lib/2019-05-01-preview/generated/azure_mgmt_consumption/budgets.rb', line 78

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