Class: Azure::Consumption::Mgmt::V2017_04_24_preview::UsageDetails

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2017-04-24-preview/generated/azure_mgmt_consumption/usage_details.rb

Overview

Consumption management client provides access to consumption resources for Azure Web-Direct subscriptions. Other subscription types which were not purchased directly through the Azure web portal are not supported through this preview API.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ UsageDetails

Creates and initializes a new instance of the UsageDetails class.

Parameters:

  • client —

    service class for accessing basic functionality.



20
21
22
 
# File 'lib/2017-04-24-preview/generated/azure_mgmt_consumption/usage_details.rb', line 20

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ ConsumptionManagementClient (readonly)

Returns reference to the ConsumptionManagementClient.

Returns:



25
26
27
 
# File 'lib/2017-04-24-preview/generated/azure_mgmt_consumption/usage_details.rb', line 25

def client
  @client
end

Instance Method Details

#list(scope, expand: nil, filter: nil, skiptoken: nil, top: nil, custom_headers: nil) ⇒ Array<UsageDetail>

Lists the usage details for a scope in reverse chronological order by billing period. Usage details are available via this API only for January 1, 2017 or later.

'/subscriptions/subscriptionId' for a subscription, or '/subscriptions/subscriptionId/providers/Microsoft.Billing/invoices/invoiceName' for an invoice or '/subscriptions/subscriptionId/providers/Microsoft.Billing/billingPeriods/billingPeriodName' for a billing perdiod. meterDetails property within a list of usage details. By default, these fields are not included when listing usage details. time). The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. recent N usageDetails. will be added to the HTTP request.

Parameters:

  • scope (String) —

    The scope of the usage details. The scope can be

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

    May be used to expand the additionalProperties or

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

    May be used to filter usageDetails by usageEnd (Utc

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

    Skiptoken is only used if a previous operation

  • top (Integer) (defaults to: nil) —

    May be used to limit the number of results to the most

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

    A hash of custom headers that

Returns:

  • (Array<UsageDetail>) —

    operation results.



55
56
57
58
 
# File 'lib/2017-04-24-preview/generated/azure_mgmt_consumption/usage_details.rb', line 55

def list(scope, expand:nil, filter:nil, skiptoken:nil, top:nil, custom_headers:nil)
  first_page = list_as_lazy(scope, expand:expand, filter:filter, skiptoken:skiptoken, top:top, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_as_lazy(scope, expand: nil, filter: nil, skiptoken: nil, top: nil, custom_headers: nil) ⇒ UsageDetailsListResult

Lists the usage details for a scope in reverse chronological order by billing period. Usage details are available via this API only for January 1, 2017 or later.

'/subscriptions/subscriptionId' for a subscription, or '/subscriptions/subscriptionId/providers/Microsoft.Billing/invoices/invoiceName' for an invoice or '/subscriptions/subscriptionId/providers/Microsoft.Billing/billingPeriods/billingPeriodName' for a billing perdiod. meterDetails property within a list of usage details. By default, these fields are not included when listing usage details. time). The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. recent N usageDetails. will be added to the HTTP request.

response.

Parameters:

  • scope (String) —

    The scope of the usage details. The scope can be

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

    May be used to expand the additionalProperties or

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

    May be used to filter usageDetails by usageEnd (Utc

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

    Skiptoken is only used if a previous operation

  • top (Integer) (defaults to: nil) —

    May be used to limit the number of results to the most

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

    A hash of custom headers that

Returns:

  • (UsageDetailsListResult) —

    which provide lazy access to pages of the



300
301
302
303
304
305
306
307
308
309
 
# File 'lib/2017-04-24-preview/generated/azure_mgmt_consumption/usage_details.rb', line 300

def list_as_lazy(scope, expand:nil, filter:nil, skiptoken:nil, top:nil, custom_headers:nil)
  response = list_async(scope, expand:expand, filter:filter, skiptoken:skiptoken, top:top, 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, expand: nil, filter: nil, skiptoken: nil, top: nil, custom_headers: nil) ⇒ Concurrent::Promise

Lists the usage details for a scope in reverse chronological order by billing period. Usage details are available via this API only for January 1, 2017 or later.

'/subscriptions/subscriptionId' for a subscription, or '/subscriptions/subscriptionId/providers/Microsoft.Billing/invoices/invoiceName' for an invoice or '/subscriptions/subscriptionId/providers/Microsoft.Billing/billingPeriods/billingPeriodName' for a billing perdiod. meterDetails property within a list of usage details. By default, these fields are not included when listing usage details. time). The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. recent N usageDetails. to the HTTP request.

Parameters:

  • scope (String) —

    The scope of the usage details. The scope can be

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

    May be used to expand the additionalProperties or

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

    May be used to filter usageDetails by usageEnd (Utc

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

    Skiptoken is only used if a previous operation

  • top (Integer) (defaults to: nil) —

    May be used to limit the number of results to the most

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/2017-04-24-preview/generated/azure_mgmt_consumption/usage_details.rb', line 120

def list_async(scope, expand:nil, filter:nil, skiptoken:nil, top:nil, custom_headers:nil)
  fail ArgumentError, 'scope is nil' if scope.nil?
  fail ArgumentError, "'top' should satisfy the constraint - 'InclusiveMaximum': '1000'" if !top.nil? && top > 1000
  fail ArgumentError, "'top' should satisfy the constraint - 'InclusiveMinimum': '1'" if !top.nil? && top < 1
  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/usageDetails'

  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: {'$expand' => expand,'$filter' => filter,'$skiptoken' => skiptoken,'$top' => top,'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::V2017_04_24_preview::Models::UsageDetailsListResult.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) ⇒ UsageDetailsListResult

Lists the usage details for a scope in reverse chronological order by billing period. Usage details are available via this API only for January 1, 2017 or later.

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:

  • (UsageDetailsListResult) —

    operation results.



187
188
189
190
 
# File 'lib/2017-04-24-preview/generated/azure_mgmt_consumption/usage_details.rb', line 187

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 usage details for a scope in reverse chronological order by billing period. Usage details are available via this API only for January 1, 2017 or later.

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.



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
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/2017-04-24-preview/generated/azure_mgmt_consumption/usage_details.rb', line 220

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::V2017_04_24_preview::Models::UsageDetailsListResult.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 usage details for a scope in reverse chronological order by billing period. Usage details are available via this API only for January 1, 2017 or later.

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.



204
205
206
 
# File 'lib/2017-04-24-preview/generated/azure_mgmt_consumption/usage_details.rb', line 204

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, expand: nil, filter: nil, skiptoken: nil, top: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists the usage details for a scope in reverse chronological order by billing period. Usage details are available via this API only for January 1, 2017 or later.

'/subscriptions/subscriptionId' for a subscription, or '/subscriptions/subscriptionId/providers/Microsoft.Billing/invoices/invoiceName' for an invoice or '/subscriptions/subscriptionId/providers/Microsoft.Billing/billingPeriods/billingPeriodName' for a billing perdiod. meterDetails property within a list of usage details. By default, these fields are not included when listing usage details. time). The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. recent N usageDetails. will be added to the HTTP request.

Parameters:

  • scope (String) —

    The scope of the usage details. The scope can be

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

    May be used to expand the additionalProperties or

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

    May be used to filter usageDetails by usageEnd (Utc

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

    Skiptoken is only used if a previous operation

  • top (Integer) (defaults to: nil) —

    May be used to limit the number of results to the most

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



88
89
90
 
# File 'lib/2017-04-24-preview/generated/azure_mgmt_consumption/usage_details.rb', line 88

def list_with_http_info(scope, expand:nil, filter:nil, skiptoken:nil, top:nil, custom_headers:nil)
  list_async(scope, expand:expand, filter:filter, skiptoken:skiptoken, top:top, custom_headers:custom_headers).value!
end