Class: Azure::Consumption::Mgmt::V2018_05_31::ConsumptionManagementClient

Inherits:
MsRestAzure::AzureServiceClient
  • Object
show all
Includes:
MsRestAzure, MsRestAzure::Serialization
Defined in:
lib/2018-05-31/generated/azure_mgmt_consumption/consumption_management_client.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(credentials = nil, base_url = nil, options = nil) ⇒ ConsumptionManagementClient

Creates initializes a new instance of the ConsumptionManagementClient class.

Parameters:

  • credentials (MsRest::ServiceClientCredentials) (defaults to: nil) —

    credentials to authorize HTTP requests made by the service client.

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

    the base URI of the service.

  • options (Array) (defaults to: nil) —

    filters to be applied to the HTTP requests.



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/2018-05-31/generated/azure_mgmt_consumption/consumption_management_client.rb', line 57

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

  @price_sheet = PriceSheet.new(self)
  @usage_details = UsageDetails.new(self)
  @forecasts = Forecasts.new(self)
  @operations = Operations.new(self)
  @api_version = '2018-05-31'
  @accept_language = 'en-US'
  @long_running_operation_retry_timeout = 30
  @generate_client_request_id = true
  add_telemetry
end

Instance Attribute Details

#accept_language ⇒ String

Returns The preferred language for the response.

Returns:

  • (String) —

    The preferred language for the response.



28
29
30
 
# File 'lib/2018-05-31/generated/azure_mgmt_consumption/consumption_management_client.rb', line 28

def accept_language
  @accept_language
end

#api_version ⇒ String (readonly)

The current version is 2018-05-31.

Returns:

  • (String) —

    Version of the API to be used with the client request.



22
23
24
 
# File 'lib/2018-05-31/generated/azure_mgmt_consumption/consumption_management_client.rb', line 22

def api_version
  @api_version
end

#base_url ⇒ String

Returns the base URI of the service.

Returns:

  • (String) —

    the base URI of the service.



15
16
17
 
# File 'lib/2018-05-31/generated/azure_mgmt_consumption/consumption_management_client.rb', line 15

def base_url
  @base_url
end

#credentials ⇒ Object (readonly)

Returns Credentials needed for the client to connect to Azure.

Returns:

  • Credentials needed for the client to connect to Azure.



18
19
20
 
# File 'lib/2018-05-31/generated/azure_mgmt_consumption/consumption_management_client.rb', line 18

def credentials
  @credentials
end

#forecasts ⇒ Forecasts (readonly)

Returns forecasts.

Returns:



46
47
48
 
# File 'lib/2018-05-31/generated/azure_mgmt_consumption/consumption_management_client.rb', line 46

def forecasts
  @forecasts
end

#generate_client_request_id ⇒ Boolean

generated. When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Returns:

  • (Boolean) —

    Whether a unique x-ms-client-request-id should be



37
38
39
 
# File 'lib/2018-05-31/generated/azure_mgmt_consumption/consumption_management_client.rb', line 37

def generate_client_request_id
  @generate_client_request_id
end

#long_running_operation_retry_timeout ⇒ Integer

Operations. Default value is 30.

Returns:

  • (Integer) —

    The retry timeout in seconds for Long Running



32
33
34
 
# File 'lib/2018-05-31/generated/azure_mgmt_consumption/consumption_management_client.rb', line 32

def long_running_operation_retry_timeout
  @long_running_operation_retry_timeout
end

#operations ⇒ Operations (readonly)

Returns operations.

Returns:



49
50
51
 
# File 'lib/2018-05-31/generated/azure_mgmt_consumption/consumption_management_client.rb', line 49

def operations
  @operations
end

#price_sheet ⇒ PriceSheet (readonly)

Returns price_sheet.

Returns:



40
41
42
 
# File 'lib/2018-05-31/generated/azure_mgmt_consumption/consumption_management_client.rb', line 40

def price_sheet
  @price_sheet
end

#subscription_id ⇒ String

Returns Azure Subscription ID.

Returns:

  • (String) —

    Azure Subscription ID.



25
26
27
 
# File 'lib/2018-05-31/generated/azure_mgmt_consumption/consumption_management_client.rb', line 25

def subscription_id
  @subscription_id
end

#usage_details ⇒ UsageDetails (readonly)

Returns usage_details.

Returns:



43
44
45
 
# File 'lib/2018-05-31/generated/azure_mgmt_consumption/consumption_management_client.rb', line 43

def usage_details
  @usage_details
end

Instance Method Details

#make_request(method, path, options = {}) ⇒ Hash{String=>String}

Makes a request and returns 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)

Parameters:

  • method (Symbol) —

    with any of the following values :get, :put, :post, :patch, :delete.

  • path (String) —

    the path, relative to #base_url.

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

    specifying any request options like :body.

Returns:

  • (Hash{String=>String}) —

    containing the body of the response.



91
92
93
94
 
# File 'lib/2018-05-31/generated/azure_mgmt_consumption/consumption_management_client.rb', line 91

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 = {}) ⇒ Concurrent::Promise

Makes a request asynchronously.

Parameters:

  • method (Symbol) —

    with any of the following values :get, :put, :post, :patch, :delete.

  • path (String) —

    the path, relative to #base_url.

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

    specifying any request options like :body.

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/2018-05-31/generated/azure_mgmt_consumption/consumption_management_client.rb', line 116

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 = {}) ⇒ MsRestAzure::AzureOperationResponse

Makes a request and returns the operation response.

Parameters:

  • method (Symbol) —

    with any of the following values :get, :put, :post, :patch, :delete.

  • path (String) —

    the path, relative to #base_url.

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

    specifying any request options like :body.

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    Operation response containing the request, response and status.



103
104
105
106
107
 
# File 'lib/2018-05-31/generated/azure_mgmt_consumption/consumption_management_client.rb', line 103

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