class Azure::Consumption::Mgmt::V2018_06_30::ConsumptionManagementClient

A service client - single point of access to the REST API.

Attributes

accept_language[RW]

@return [String] The preferred language for the response.

api_version[R]

@return [String] Version of the API to be used with the client request. The current version is 2018-06-30.

balances[R]

@return [Balances] balances

base_url[RW]

@return [String] the base URI of the service.

budgets[R]

@return [Budgets] budgets

cost_tags[R]

@return [CostTags] cost_tags

credentials[R]

@return Credentials needed for the client to connect to Azure.

forecasts[R]

@return [Forecasts] forecasts

generate_client_request_id[RW]

@return [Boolean] Whether a unique x-ms-client-request-id should be generated. When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

long_running_operation_retry_timeout[RW]

@return [Integer] The retry timeout in seconds for Long Running Operations. Default value is 30.

marketplaces[R]

@return [Marketplaces] marketplaces

operations[R]

@return [Operations] operations

price_sheet[R]

@return [PriceSheet] price_sheet

reservation_recommendations[R]

@return [ReservationRecommendations] reservation_recommendations

reservations_details[R]

@return [ReservationsDetails] reservations_details

reservations_summaries[R]

@return [ReservationsSummaries] reservations_summaries

subscription_id[RW]

@return [String] Azure Subscription ID.

tags[R]

@return [Tags] tags

usage_details[R]

@return [UsageDetails] usage_details

Public Class Methods

new(credentials = nil, base_url = nil, options = nil) click to toggle source

Creates initializes a new instance of the ConsumptionManagementClient class. @param credentials [MsRest::ServiceClientCredentials] credentials to authorize HTTP requests made by the service client. @param base_url [String] the base URI of the service. @param options [Array] filters to be applied to the HTTP requests.

Calls superclass method
# File lib/2018-06-30/generated/azure_mgmt_consumption/consumption_management_client.rb, line 81
def initialize(credentials = nil, base_url = nil, options = nil)
  super(credentials, options)
  @base_url = base_url || 'https://management.azure.com'

  fail ArgumentError, 'invalid type of credentials input parameter' unless credentials.is_a?(MsRest::ServiceClientCredentials) unless credentials.nil?
  @credentials = credentials

  @usage_details = UsageDetails.new(self)
  @marketplaces = Marketplaces.new(self)
  @balances = Balances.new(self)
  @reservations_summaries = ReservationsSummaries.new(self)
  @reservations_details = ReservationsDetails.new(self)
  @reservation_recommendations = ReservationRecommendations.new(self)
  @budgets = Budgets.new(self)
  @price_sheet = PriceSheet.new(self)
  @cost_tags = CostTags.new(self)
  @tags = Tags.new(self)
  @forecasts = Forecasts.new(self)
  @operations = Operations.new(self)
  @api_version = '2018-06-30'
  @accept_language = 'en-US'
  @long_running_operation_retry_timeout = 30
  @generate_client_request_id = true
  add_telemetry
end

Public Instance Methods

make_request(method, path, options = {}) click to toggle source

Makes a request and returns the body of the response. @param method [Symbol] with any of the following values :get, :put, :post, :patch, :delete. @param path [String] the path, relative to {base_url}. @param options [Hash{String=>String}] specifying any request options like :body. @return [Hash{String=>String}] containing the body of the response. Example:

request_content = "{'location':'westus','tags':{'tag1':'val1','tag2':'val2'}}"
path = "/path"
options = {
  body: request_content,
  query_params: {'api-version' => '2016-02-01'}
}
result = @client.make_request(:put, path, options)
# File lib/2018-06-30/generated/azure_mgmt_consumption/consumption_management_client.rb, line 123
def make_request(method, path, options = {})
  result = make_request_with_http_info(method, path, options)
  result.body unless result.nil?
end
make_request_async(method, path, options = {}) click to toggle source

Makes a request asynchronously. @param method [Symbol] with any of the following values :get, :put, :post, :patch, :delete. @param path [String] the path, relative to {base_url}. @param options [Hash{String=>String}] specifying any request options like :body. @return [Concurrent::Promise] Promise object which holds the HTTP response.

Calls superclass method
# File lib/2018-06-30/generated/azure_mgmt_consumption/consumption_management_client.rb, line 148
def make_request_async(method, path, options = {})
  fail ArgumentError, 'method is nil' if method.nil?
  fail ArgumentError, 'path is nil' if path.nil?

  request_url = options[:base_url] || @base_url
  if(!options[:headers].nil? && !options[:headers]['Content-Type'].nil?)
    @request_headers['Content-Type'] = options[:headers]['Content-Type']
  end

  request_headers = @request_headers
  request_headers.merge!({'accept-language' => @accept_language}) unless @accept_language.nil?
  options.merge!({headers: request_headers.merge(options[:headers] || {})})
  options.merge!({credentials: @credentials}) unless @credentials.nil?

  super(request_url, method, path, options)
end
make_request_with_http_info(method, path, options = {}) click to toggle source

Makes a request and returns the operation response. @param method [Symbol] with any of the following values :get, :put, :post, :patch, :delete. @param path [String] the path, relative to {base_url}. @param options [Hash{String=>String}] specifying any request options like :body. @return [MsRestAzure::AzureOperationResponse] Operation response containing the request, response and status.

# File lib/2018-06-30/generated/azure_mgmt_consumption/consumption_management_client.rb, line 135
def make_request_with_http_info(method, path, options = {})
  result = make_request_async(method, path, options).value!
  result.body = result.response.body.to_s.empty? ? nil : JSON.load(result.response.body)
  result
end

Private Instance Methods

add_telemetry() click to toggle source

Adds telemetry information.

# File lib/2018-06-30/generated/azure_mgmt_consumption/consumption_management_client.rb, line 170
def add_telemetry
    sdk_information = 'azure_mgmt_consumption'
    sdk_information = "#{sdk_information}/0.18.1"
    add_user_agent_information(sdk_information)
end