Class: Azure::Consumption::Mgmt::V2019_10_01::EventsOperations

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

Creates and initializes a new instance of the EventsOperations class.

Parameters:

  • client —

    service class for accessing basic functionality.



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

def client
  @client
end

Instance Method Details

#list(billing_account_id, billing_profile_id, start_date, end_date, custom_headers: nil) ⇒ Array<EventSummary>

Lists the events by billingAccountId and billingProfileId for given start and end date.

will be added to the HTTP request.

Parameters:

  • billing_account_id (String) —

    BillingAccount ID

  • billing_profile_id (String) —

    Azure Billing Profile ID.

  • start_date (String) —

    Start date

  • end_date (String) —

    End date

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

    A hash of custom headers that

Returns:

  • (Array<EventSummary>) —

    operation results.



38
39
40
41
 
# File 'lib/2019-10-01/generated/azure_mgmt_consumption/events_operations.rb', line 38

def list(, billing_profile_id, start_date, end_date, custom_headers:nil)
  first_page = list_as_lazy(, billing_profile_id, start_date, end_date, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_as_lazy(billing_account_id, billing_profile_id, start_date, end_date, custom_headers: nil) ⇒ Events

Lists the events by billingAccountId and billingProfileId for given start and end date.

will be added to the HTTP request.

Parameters:

  • billing_account_id (String) —

    BillingAccount ID

  • billing_profile_id (String) —

    Azure Billing Profile ID.

  • start_date (String) —

    Start date

  • end_date (String) —

    End date

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

    A hash of custom headers that

Returns:

  • (Events) —

    which provide lazy access to pages of the response.



235
236
237
238
239
240
241
242
243
244
 
# File 'lib/2019-10-01/generated/azure_mgmt_consumption/events_operations.rb', line 235

def list_as_lazy(, billing_profile_id, start_date, end_date, custom_headers:nil)
  response = list_async(, billing_profile_id, start_date, end_date, 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(billing_account_id, billing_profile_id, start_date, end_date, custom_headers: nil) ⇒ Concurrent::Promise

Lists the events by billingAccountId and billingProfileId for given start and end date.

to the HTTP request.

Parameters:

  • billing_account_id (String) —

    BillingAccount ID

  • billing_profile_id (String) —

    Azure Billing Profile ID.

  • start_date (String) —

    Start date

  • end_date (String) —

    End date

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/2019-10-01/generated/azure_mgmt_consumption/events_operations.rb', line 73

def list_async(, billing_profile_id, start_date, end_date, custom_headers:nil)
  fail ArgumentError, 'billing_account_id is nil' if .nil?
  fail ArgumentError, 'billing_profile_id is nil' if billing_profile_id.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'start_date is nil' if start_date.nil?
  fail ArgumentError, 'end_date is nil' if end_date.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/providers/Microsoft.Consumption/events'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'billingAccountId' => ,'billingProfileId' => billing_profile_id},
      query_params: {'api-version' => @client.api_version,'startDate' => start_date,'endDate' => end_date},
      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_10_01::Models::Events.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) ⇒ Events

Lists the events by billingAccountId and billingProfileId for given start and end date.

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:

  • (Events) —

    operation results.



140
141
142
143
 
# File 'lib/2019-10-01/generated/azure_mgmt_consumption/events_operations.rb', line 140

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 the events by billingAccountId and billingProfileId for given start and end date.

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.



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/2019-10-01/generated/azure_mgmt_consumption/events_operations.rb', line 171

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_10_01::Models::Events.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 the events by billingAccountId and billingProfileId for given start and end date.

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.



156
157
158
 
# File 'lib/2019-10-01/generated/azure_mgmt_consumption/events_operations.rb', line 156

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(billing_account_id, billing_profile_id, start_date, end_date, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists the events by billingAccountId and billingProfileId for given start and end date.

will be added to the HTTP request.

Parameters:

  • billing_account_id (String) —

    BillingAccount ID

  • billing_profile_id (String) —

    Azure Billing Profile ID.

  • start_date (String) —

    Start date

  • end_date (String) —

    End date

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



56
57
58
 
# File 'lib/2019-10-01/generated/azure_mgmt_consumption/events_operations.rb', line 56

def list_with_http_info(, billing_profile_id, start_date, end_date, custom_headers:nil)
  list_async(, billing_profile_id, start_date, end_date, custom_headers:custom_headers).value!
end