class Azure::CostManagement::Mgmt::V2018_05_31::SubscriptionDimensions
Attributes
@return [CostManagementClient] reference to the CostManagementClient
Public Class Methods
Creates and initializes a new instance of the SubscriptionDimensions
class. @param client service class for accessing basic functionality.
# File lib/2018-05-31/generated/azure_mgmt_cost_management/subscription_dimensions.rb, line 17 def initialize(client) @client = client end
Public Instance Methods
Lists the dimensions by subscription Id.
@param filter [String] May be used to filter dimensions by properties/category, properties/usageStart, properties/usageEnd. Supported operators are 'eq','lt', 'gt', 'le', 'ge'. @param expand [String] May be used to expand the properties/data within a dimension category. By default, data is not included when listing dimensions. @param skiptoken [String] Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. @param top [Integer] May be used to limit the number of results to the most recent N dimension data. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [DimensionsListResult] operation results.
# File lib/2018-05-31/generated/azure_mgmt_cost_management/subscription_dimensions.rb, line 43 def list(filter:nil, expand:nil, skiptoken:nil, top:nil, custom_headers:nil) response = list_async(filter:filter, expand:expand, skiptoken:skiptoken, top:top, custom_headers:custom_headers).value! response.body unless response.nil? end
Lists the dimensions by subscription Id.
@param filter [String] May be used to filter dimensions by properties/category, properties/usageStart, properties/usageEnd. Supported operators are 'eq','lt', 'gt', 'le', 'ge'. @param expand [String] May be used to expand the properties/data within a dimension category. By default, data is not included when listing dimensions. @param skiptoken [String] Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. @param top [Integer] May be used to limit the number of results to the most recent N dimension data. @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/subscription_dimensions.rb, line 90 def list_async(filter:nil, expand:nil, skiptoken:nil, top: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? fail ArgumentError, "'top' should satisfy the constraint - 'InclusiveMaximum': '1000'" if !top.nil? && top > 1000 fail ArgumentError, "'top' should satisfy the constraint - 'InclusiveMinimum': '1'" if !top.nil? && top < 1 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.CostManagement/dimensions' 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: {'api-version' => @client.api_version,'$filter' => filter,'$expand' => expand,'$skiptoken' => skiptoken,'$top' => top}, 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::CostManagement::Mgmt::V2018_05_31::Models::DimensionsListResult.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
Lists the dimensions by subscription Id.
@param filter [String] May be used to filter dimensions by properties/category, properties/usageStart, properties/usageEnd. Supported operators are 'eq','lt', 'gt', 'le', 'ge'. @param expand [String] May be used to expand the properties/data within a dimension category. By default, data is not included when listing dimensions. @param skiptoken [String] Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. @param top [Integer] May be used to limit the number of results to the most recent N dimension data. @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/subscription_dimensions.rb, line 67 def list_with_http_info(filter:nil, expand:nil, skiptoken:nil, top:nil, custom_headers:nil) list_async(filter:filter, expand:expand, skiptoken:skiptoken, top:top, custom_headers:custom_headers).value! end