Class: Azure::Consumption::Mgmt::V2019_05_01::Forecasts

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

Creates and initializes a new instance of the Forecasts class.

Parameters:

  • client —

    service class for accessing basic functionality.



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

def client
  @client
end

Instance Method Details

#list(filter: nil, custom_headers: nil) ⇒ ForecastsListResult

Lists the forecast charges by subscriptionId.

properties/usageDate (Utc time), properties/chargeType or properties/grain. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. will be added to the HTTP request.

Parameters:

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

    May be used to filter forecasts by

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

    A hash of custom headers that

Returns:

  • (ForecastsListResult) —

    operation results.



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

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

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

Lists the forecast charges by subscriptionId.

properties/usageDate (Utc time), properties/chargeType or properties/grain. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. to the HTTP request.

Parameters:

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

    May be used to filter forecasts by

  • 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-05-01/generated/azure_mgmt_consumption/forecasts.rb', line 70

def list_async(filter:nil, custom_headers:nil)
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.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 = 'subscriptions/{subscriptionId}/providers/Microsoft.Consumption/forecasts'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id},
      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_05_01::Models::ForecastsListResult.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_with_http_info(filter: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists the forecast charges by subscriptionId.

properties/usageDate (Utc time), properties/chargeType or properties/grain. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. will be added to the HTTP request.

Parameters:

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

    May be used to filter forecasts by

  • 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-05-01/generated/azure_mgmt_consumption/forecasts.rb', line 54

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