Class: Azure::CostManagement::Mgmt::V2019_04_01_preview::Budgets

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

Overview

Budgets

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.



17
18
19
 
# File 'lib/2019-04-01-preview/generated/azure_mgmt_cost_management/budgets.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-04-01-preview/generated/azure_mgmt_cost_management/budgets.rb', line 22

def client
  @client
end

Instance Method Details

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

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<BudgetModel>) —

    operation results.



48
49
50
51
 
# File 'lib/2019-04-01-preview/generated/azure_mgmt_cost_management/budgets.rb', line 48

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



273
274
275
276
277
278
279
280
281
282
 
# File 'lib/2019-04-01-preview/generated/azure_mgmt_cost_management/budgets.rb', line 273

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.



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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/2019-04-01-preview/generated/azure_mgmt_cost_management/budgets.rb', line 105

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/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::CostManagement::Mgmt::V2019_04_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.



168
169
170
171
 
# File 'lib/2019-04-01-preview/generated/azure_mgmt_cost_management/budgets.rb', line 168

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.



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
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/2019-04-01-preview/generated/azure_mgmt_cost_management/budgets.rb', line 197

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::CostManagement::Mgmt::V2019_04_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.



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

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.



77
78
79
 
# File 'lib/2019-04-01-preview/generated/azure_mgmt_cost_management/budgets.rb', line 77

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