class Azure::Consumption::Mgmt::V2018_03_31::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-03-31.

base_url[RW]

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

budgets[R]

@return [Budgets] budgets

cost_tags_operations[R]

@return [CostTagsOperations] cost_tags_operations

credentials[R]

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

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.

get_balances_by_billing_account[R]

@return [GetBalancesByBillingAccount] get_balances_by_billing_account

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

marketplaces_by_billing_account[R]

@return [MarketplacesByBillingAccount] marketplaces_by_billing_account

marketplaces_by_department[R]

@return [MarketplacesByDepartment] marketplaces_by_department

marketplaces_by_enrollment_accounts[R]

@return [MarketplacesByEnrollmentAccounts] marketplaces_by_enrollment_accounts

operations[R]

@return [Operations] operations

price_sheet[R]

@return [PriceSheet] price_sheet

reservation_recommendations_operations[R]

@return [ReservationRecommendationsOperations] reservation_recommendations_operations

reservations_details[R]

@return [ReservationsDetails] reservations_details

reservations_summaries[R]

@return [ReservationsSummaries] reservations_summaries

subscription_id[RW]

@return [String] Azure Subscription ID.

tags_operations[R]

@return [TagsOperations] tags_operations

usage_details[R]

@return [UsageDetails] usage_details

usage_details_by_billing_account[R]

@return [UsageDetailsByBillingAccount] usage_details_by_billing_account

usage_details_by_department[R]

@return [UsageDetailsByDepartment] usage_details_by_department

usage_details_by_enrollment_account[R]

@return [UsageDetailsByEnrollmentAccount] usage_details_by_enrollment_account

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-03-31/generated/azure_mgmt_consumption/consumption_management_client.rb, line 99
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)
  @usage_details_by_billing_account = UsageDetailsByBillingAccount.new(self)
  @usage_details_by_department = UsageDetailsByDepartment.new(self)
  @usage_details_by_enrollment_account = UsageDetailsByEnrollmentAccount.new(self)
  @marketplaces = Marketplaces.new(self)
  @marketplaces_by_billing_account = MarketplacesByBillingAccount.new(self)
  @marketplaces_by_department = MarketplacesByDepartment.new(self)
  @marketplaces_by_enrollment_accounts = MarketplacesByEnrollmentAccounts.new(self)
  @get_balances_by_billing_account = GetBalancesByBillingAccount.new(self)
  @reservations_summaries = ReservationsSummaries.new(self)
  @reservations_details = ReservationsDetails.new(self)
  @reservation_recommendations_operations = ReservationRecommendationsOperations.new(self)
  @budgets = Budgets.new(self)
  @operations = Operations.new(self)
  @price_sheet = PriceSheet.new(self)
  @cost_tags_operations = CostTagsOperations.new(self)
  @tags_operations = TagsOperations.new(self)
  @api_version = '2018-03-31'
  @accept_language = 'en-US'
  @long_running_operation_retry_timeout = 30
  @generate_client_request_id = true
  add_telemetry
end

Public Instance Methods

get_balances_by_billing_account_async(billing_account_id, custom_headers:nil) click to toggle source

Gets the balances for a scope by billingAccountId. Balances are available via this API only for May 1, 2014 or later.

@param billing_account_id [String] BillingAccount ID @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Concurrent::Promise] Promise object which holds the HTTP response.

# File lib/2018-03-31/generated/azure_mgmt_consumption/consumption_management_client.rb, line 227
def get_balances_by_billing_account_async(billing_account_id, custom_headers:nil)
  fail ArgumentError, 'api_version is nil' if api_version.nil?
  fail ArgumentError, 'billing_account_id is nil' if billing_account_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'] = accept_language unless accept_language.nil?
  path_template = 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Consumption/balances'

  request_url = @base_url || self.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'billingAccountId' => billing_account_id},
      query_params: {'api-version' => api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::V2018_03_31::Models::Balance.mapper()
        result.body = self.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
get_balances_by_billing_account_with_http_info(billing_account_id, custom_headers:nil) click to toggle source

Gets the balances for a scope by billingAccountId. Balances are available via this API only for May 1, 2014 or later.

@param billing_account_id [String] BillingAccount ID @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [MsRestAzure::AzureOperationResponse] HTTP response information.

# File lib/2018-03-31/generated/azure_mgmt_consumption/consumption_management_client.rb, line 213
def get_balances_by_billing_account_with_http_info(billing_account_id, custom_headers:nil)
  get_balances_by_billing_account_async(billing_account_id, custom_headers:custom_headers).value!
end
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-03-31/generated/azure_mgmt_consumption/consumption_management_client.rb, line 146
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-03-31/generated/azure_mgmt_consumption/consumption_management_client.rb, line 171
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-03-31/generated/azure_mgmt_consumption/consumption_management_client.rb, line 158
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-03-31/generated/azure_mgmt_consumption/consumption_management_client.rb, line 285
def add_telemetry
    sdk_information = 'azure_mgmt_consumption'
    sdk_information = "#{sdk_information}/0.18.1"
    add_user_agent_information(sdk_information)
end