Class: Azure::CostManagement::Mgmt::V2018_05_31::BillingAccountDimensions

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2018-05-31/generated/azure_mgmt_cost_management/billing_account_dimensions.rb

Overview

BillingAccountDimensions

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ BillingAccountDimensions

Creates and initializes a new instance of the BillingAccountDimensions class.

Parameters:

  • client —

    service class for accessing basic functionality.



17
18
19
 
# File 'lib/2018-05-31/generated/azure_mgmt_cost_management/billing_account_dimensions.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ CostManagementClient (readonly)

Returns reference to the CostManagementClient.

Returns:



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

def client
  @client
end

Instance Method Details

#list(billing_account_id, filter: nil, expand: nil, skiptoken: nil, top: nil, custom_headers: nil) ⇒ DimensionsListResult

Lists the dimensions by billingAccount Id.

properties/category, properties/usageStart, properties/usageEnd. Supported operators are 'eq','lt', 'gt', 'le', 'ge'. dimension category. By default, data is not included when listing dimensions. 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. recent N dimension data. will be added to the HTTP request.

Parameters:

  • billing_account_id (String) —

    BillingAccount ID

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

    May be used to filter dimensions by

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

    May be used to expand the properties/data within a

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

    Skiptoken is only used if a previous operation

  • top (Integer) (defaults to: nil) —

    May be used to limit the number of results to the most

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

    A hash of custom headers that

Returns:

  • (DimensionsListResult) —

    operation results.



44
45
46
47
 
# File 'lib/2018-05-31/generated/azure_mgmt_cost_management/billing_account_dimensions.rb', line 44

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

#list_async(billing_account_id, filter: nil, expand: nil, skiptoken: nil, top: nil, custom_headers: nil) ⇒ Concurrent::Promise

Lists the dimensions by billingAccount Id.

properties/category, properties/usageStart, properties/usageEnd. Supported operators are 'eq','lt', 'gt', 'le', 'ge'. dimension category. By default, data is not included when listing dimensions. 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. recent N dimension data. to the HTTP request.

Parameters:

  • billing_account_id (String) —

    BillingAccount ID

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

    May be used to filter dimensions by

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

    May be used to expand the properties/data within a

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

    Skiptoken is only used if a previous operation

  • top (Integer) (defaults to: nil) —

    May be used to limit the number of results to the most

  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/2018-05-31/generated/azure_mgmt_cost_management/billing_account_dimensions.rb', line 93

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, 'billing_account_id is nil' if .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 = 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/dimensions'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'billingAccountId' => },
      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

#list_with_http_info(billing_account_id, filter: nil, expand: nil, skiptoken: nil, top: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists the dimensions by billingAccount Id.

properties/category, properties/usageStart, properties/usageEnd. Supported operators are 'eq','lt', 'gt', 'le', 'ge'. dimension category. By default, data is not included when listing dimensions. 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. recent N dimension data. will be added to the HTTP request.

Parameters:

  • billing_account_id (String) —

    BillingAccount ID

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

    May be used to filter dimensions by

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

    May be used to expand the properties/data within a

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

    Skiptoken is only used if a previous operation

  • top (Integer) (defaults to: nil) —

    May be used to limit the number of results to the most

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



69
70
71
 
# File 'lib/2018-05-31/generated/azure_mgmt_cost_management/billing_account_dimensions.rb', line 69

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