Class: Azure::Consumption::Mgmt::V2019_06_01::ReservationTransactions

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

Creates and initializes a new instance of the ReservationTransactions class.

Parameters:

  • client —

    service class for accessing basic functionality.



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

def client
  @client
end

Instance Method Details

#list_by_billing_account_id(billing_account_id, filter: nil, custom_headers: nil) ⇒ Array<ReservationTransaction>

List of transactions for reserved instances on billing account scope

properties/UsageDate for start date and end date. The filter supports 'le' and 'ge' will be added to the HTTP request.

Parameters:

  • billing_account_id (String) —

    BillingAccount ID

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

    Filter reservation transactions by date range. The

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

    A hash of custom headers that

Returns:

  • (Array<ReservationTransaction>) —

    operation results.



37
38
39
40
 
# File 'lib/2019-06-01/generated/azure_mgmt_consumption/reservation_transactions.rb', line 37

def (, filter:nil, custom_headers:nil)
  first_page = (, filter:filter, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_by_billing_account_id_as_lazy(billing_account_id, filter: nil, custom_headers: nil) ⇒ ReservationTransactionsListResult

List of transactions for reserved instances on billing account scope

properties/UsageDate for start date and end date. The filter supports 'le' and 'ge' will be added to the HTTP request.

pages of the response.

Parameters:

  • billing_account_id (String) —

    BillingAccount ID

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

    Filter reservation transactions by date range. The

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

    A hash of custom headers that

Returns:

  • (ReservationTransactionsListResult) —

    which provide lazy access to



226
227
228
229
230
231
232
233
234
235
 
# File 'lib/2019-06-01/generated/azure_mgmt_consumption/reservation_transactions.rb', line 226

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

#list_by_billing_account_id_async(billing_account_id, filter: nil, custom_headers: nil) ⇒ Concurrent::Promise

List of transactions for reserved instances on billing account scope

properties/UsageDate for start date and end date. The filter supports 'le' and 'ge' to the HTTP request.

Parameters:

  • billing_account_id (String) —

    BillingAccount ID

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

    Filter reservation transactions by date range. The

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



70
71
72
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
 
# File 'lib/2019-06-01/generated/azure_mgmt_consumption/reservation_transactions.rb', line 70

def (, filter:nil, custom_headers:nil)
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'billing_account_id is nil' if .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}/providers/Microsoft.Consumption/reservationTransactions'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'billingAccountId' => },
      query_params: {'$filter' => filter,'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_06_01::Models::ReservationTransactionsListResult.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_by_billing_account_id_next(next_page_link, custom_headers: nil) ⇒ ReservationTransactionsListResult

List of transactions for reserved instances on billing account 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:

  • (ReservationTransactionsListResult) —

    operation results.



133
134
135
136
 
# File 'lib/2019-06-01/generated/azure_mgmt_consumption/reservation_transactions.rb', line 133

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

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

List of transactions for reserved instances on billing account 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.



162
163
164
165
166
167
168
169
170
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
 
# File 'lib/2019-06-01/generated/azure_mgmt_consumption/reservation_transactions.rb', line 162

def (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_06_01::Models::ReservationTransactionsListResult.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_by_billing_account_id_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

List of transactions for reserved instances on billing account 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.



148
149
150
 
# File 'lib/2019-06-01/generated/azure_mgmt_consumption/reservation_transactions.rb', line 148

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

#list_by_billing_account_id_with_http_info(billing_account_id, filter: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

List of transactions for reserved instances on billing account scope

properties/UsageDate for start date and end date. The filter supports 'le' and 'ge' will be added to the HTTP request.

Parameters:

  • billing_account_id (String) —

    BillingAccount ID

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

    Filter reservation transactions by date range. The

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



54
55
56
 
# File 'lib/2019-06-01/generated/azure_mgmt_consumption/reservation_transactions.rb', line 54

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