class Azure::CostManagement::Mgmt::V2018_05_31::CostManagementClient
A service client - single point of access to the REST API.
Attributes
@return [String] The preferred language for the response.
@return [String] Version of the API to be used with the client request. The current version is 2018-05-31.
@return [String] the base URI of the service.
@return [BillingAccountDimensions] billing_account_dimensions
@return Credentials needed for the client to connect to Azure
.
@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.
@return [Integer] The retry timeout in seconds for Long Running Operations
. Default value is 30.
@return [Operations] operations
@return [ReportConfigOperations] report_config_operations
@return [ResourceGroupDimensions] resource_group_dimensions
@return [SubscriptionDimensions] subscription_dimensions
@return [String] Azure
Subscription ID.
Public Class Methods
Creates initializes a new instance of the CostManagementClient
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.
# File lib/2018-05-31/generated/azure_mgmt_cost_management/cost_management_client.rb, line 60 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 @report_config_operations = ReportConfigOperations.new(self) @billing_account_dimensions = BillingAccountDimensions.new(self) @subscription_dimensions = SubscriptionDimensions.new(self) @resource_group_dimensions = ResourceGroupDimensions.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
Public Instance Methods
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-05-31/generated/azure_mgmt_cost_management/cost_management_client.rb, line 95 def make_request(method, path, options = {}) result = make_request_with_http_info(method, path, options) result.body unless result.nil? end
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.
# File lib/2018-05-31/generated/azure_mgmt_cost_management/cost_management_client.rb, line 120 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
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-05-31/generated/azure_mgmt_cost_management/cost_management_client.rb, line 107 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
Lists the usage data for billing account.
@param billing_account_id [String] BillingAccount ID @param parameters [ReportConfigDefinition] Parameters supplied to the CreateOrUpdate Report Config operation. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [QueryResult] operation results.
# File lib/2018-05-31/generated/azure_mgmt_cost_management/cost_management_client.rb, line 352 def query_billing_account(billing_account_id, parameters, custom_headers:nil) response = query_billing_account_async(billing_account_id, parameters, custom_headers:custom_headers).value! response.body unless response.nil? end
Lists the usage data for billing account.
@param billing_account_id [String] BillingAccount ID @param parameters [ReportConfigDefinition] Parameters supplied to the CreateOrUpdate Report Config operation. @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-05-31/generated/azure_mgmt_cost_management/cost_management_client.rb, line 383 def query_billing_account_async(billing_account_id, parameters, 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? fail ArgumentError, 'parameters is nil' if parameters.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? # Serialize Request request_mapper = Azure::CostManagement::Mgmt::V2018_05_31::Models::ReportConfigDefinition.mapper() request_content = self.serialize(request_mapper, parameters) request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil path_template = 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/Query' 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}, body: request_content, headers: request_headers.merge(custom_headers || {}), base_url: request_url } promise = self.make_request_async(:post, 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::CostManagement::Mgmt::V2018_05_31::Models::QueryResult.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
Lists the usage data for billing account.
@param billing_account_id [String] BillingAccount ID @param parameters [ReportConfigDefinition] Parameters supplied to the CreateOrUpdate Report Config operation. @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-05-31/generated/azure_mgmt_cost_management/cost_management_client.rb, line 368 def query_billing_account_with_http_info(billing_account_id, parameters, custom_headers:nil) query_billing_account_async(billing_account_id, parameters, custom_headers:custom_headers).value! end
Lists the usage data for subscriptionId and resource group.
@param resource_group_name [String] Azure
Resource Group Name. @param parameters [ReportConfigDefinition] Parameters supplied to the CreateOrUpdate Report Config operation. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [QueryResult] operation results.
# File lib/2018-05-31/generated/azure_mgmt_cost_management/cost_management_client.rb, line 248 def query_resource_group(resource_group_name, parameters, custom_headers:nil) response = query_resource_group_async(resource_group_name, parameters, custom_headers:custom_headers).value! response.body unless response.nil? end
Lists the usage data for subscriptionId and resource group.
@param resource_group_name [String] Azure
Resource Group Name. @param parameters [ReportConfigDefinition] Parameters supplied to the CreateOrUpdate Report Config operation. @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-05-31/generated/azure_mgmt_cost_management/cost_management_client.rb, line 279 def query_resource_group_async(resource_group_name, parameters, custom_headers:nil) fail ArgumentError, 'api_version is nil' if api_version.nil? fail ArgumentError, 'subscription_id is nil' if subscription_id.nil? fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil? fail ArgumentError, 'parameters is nil' if parameters.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? # Serialize Request request_mapper = Azure::CostManagement::Mgmt::V2018_05_31::Models::ReportConfigDefinition.mapper() request_content = self.serialize(request_mapper, parameters) request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil path_template = 'subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.CostManagement/Query' request_url = @base_url || self.base_url options = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], path_params: {'subscriptionId' => subscription_id,'resourceGroupName' => resource_group_name}, query_params: {'api-version' => api_version}, body: request_content, headers: request_headers.merge(custom_headers || {}), base_url: request_url } promise = self.make_request_async(:post, 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::CostManagement::Mgmt::V2018_05_31::Models::QueryResult.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
Lists the usage data for subscriptionId and resource group.
@param resource_group_name [String] Azure
Resource Group Name. @param parameters [ReportConfigDefinition] Parameters supplied to the CreateOrUpdate Report Config operation. @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-05-31/generated/azure_mgmt_cost_management/cost_management_client.rb, line 264 def query_resource_group_with_http_info(resource_group_name, parameters, custom_headers:nil) query_resource_group_async(resource_group_name, parameters, custom_headers:custom_headers).value! end
Lists the usage data for subscriptionId.
@param parameters [ReportConfigDefinition] Parameters supplied to the CreateOrUpdate Report Config operation. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [QueryResult] operation results.
# File lib/2018-05-31/generated/azure_mgmt_cost_management/cost_management_client.rb, line 147 def query_subscription(parameters, custom_headers:nil) response = query_subscription_async(parameters, custom_headers:custom_headers).value! response.body unless response.nil? end
Lists the usage data for subscriptionId.
@param parameters [ReportConfigDefinition] Parameters supplied to the CreateOrUpdate Report Config operation. @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-05-31/generated/azure_mgmt_cost_management/cost_management_client.rb, line 176 def query_subscription_async(parameters, custom_headers:nil) fail ArgumentError, 'api_version is nil' if api_version.nil? fail ArgumentError, 'subscription_id is nil' if subscription_id.nil? fail ArgumentError, 'parameters is nil' if parameters.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? # Serialize Request request_mapper = Azure::CostManagement::Mgmt::V2018_05_31::Models::ReportConfigDefinition.mapper() request_content = self.serialize(request_mapper, parameters) request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil path_template = 'subscriptions/{subscriptionId}/providers/Microsoft.CostManagement/Query' request_url = @base_url || self.base_url options = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], path_params: {'subscriptionId' => subscription_id}, query_params: {'api-version' => api_version}, body: request_content, headers: request_headers.merge(custom_headers || {}), base_url: request_url } promise = self.make_request_async(:post, 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::CostManagement::Mgmt::V2018_05_31::Models::QueryResult.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
Lists the usage data for subscriptionId.
@param parameters [ReportConfigDefinition] Parameters supplied to the CreateOrUpdate Report Config operation. @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-05-31/generated/azure_mgmt_cost_management/cost_management_client.rb, line 162 def query_subscription_with_http_info(parameters, custom_headers:nil) query_subscription_async(parameters, custom_headers:custom_headers).value! end
Private Instance Methods
Adds telemetry information.
# File lib/2018-05-31/generated/azure_mgmt_cost_management/cost_management_client.rb, line 449 def add_telemetry sdk_information = 'azure_mgmt_cost_management' sdk_information = "#{sdk_information}/0.17.1" add_user_agent_information(sdk_information) end