Class: Azure::CostManagement::Mgmt::V2019_01_01::Dimensions

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-01-01/generated/azure_mgmt_cost_management/dimensions.rb

Overview

Dimensions

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Dimensions

Creates and initializes a new instance of the Dimensions class.

Parameters:

  • client —

    service class for accessing basic functionality.



17
18
19
 
# File 'lib/2019-01-01/generated/azure_mgmt_cost_management/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/2019-01-01/generated/azure_mgmt_cost_management/dimensions.rb', line 22

def client
  @client
end

Instance Method Details

#list_by_subscription(scope, filter: nil, expand: nil, skiptoken: nil, top: nil, custom_headers: nil) ⇒ DimensionsListResult

Lists the dimensions by the defined scope.

includes '/subscriptions/subscriptionId/' for subscription scope, '/subscriptions/subscriptionId/resourceGroups/resourceGroupName' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/billingAccountId' for Billing Account scope, '/providers/Microsoft.Billing/billingAccounts/billingAccountId/departments/departmentId' for Department scope, '/providers/Microsoft.Billing/billingAccounts/billingAccountId/enrollmentAccounts/enrollmentAccountId' for EnrollmentAccount scope and '/providers/Microsoft.Management/managementGroups/managementGroupId' for Management Group scope.. 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:

  • scope (String) —

    The scope associated with dimension operations. This

  • 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.



55
56
57
58
 
# File 'lib/2019-01-01/generated/azure_mgmt_cost_management/dimensions.rb', line 55

def list_by_subscription(scope, filter:nil, expand:nil, skiptoken:nil, top:nil, custom_headers:nil)
  response = list_by_subscription_async(scope, filter:filter, expand:expand, skiptoken:skiptoken, top:top, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#list_by_subscription_async(scope, filter: nil, expand: nil, skiptoken: nil, top: nil, custom_headers: nil) ⇒ Concurrent::Promise

Lists the dimensions by the defined scope.

includes '/subscriptions/subscriptionId/' for subscription scope, '/subscriptions/subscriptionId/resourceGroups/resourceGroupName' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/billingAccountId' for Billing Account scope, '/providers/Microsoft.Billing/billingAccounts/billingAccountId/departments/departmentId' for Department scope, '/providers/Microsoft.Billing/billingAccounts/billingAccountId/enrollmentAccounts/enrollmentAccountId' for EnrollmentAccount scope and '/providers/Microsoft.Management/managementGroups/managementGroupId' for Management Group scope.. 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:

  • scope (String) —

    The scope associated with dimension operations. This

  • 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.



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/2019-01-01/generated/azure_mgmt_cost_management/dimensions.rb', line 126

def list_by_subscription_async(scope, filter:nil, expand:nil, skiptoken:nil, top:nil, custom_headers:nil)
  fail ArgumentError, 'scope is nil' if scope.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.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 = '{scope}/providers/Microsoft.CostManagement/dimensions'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      skip_encoding_path_params: {'scope' => scope},
      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::V2019_01_01::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_by_subscription_with_http_info(scope, filter: nil, expand: nil, skiptoken: nil, top: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists the dimensions by the defined scope.

includes '/subscriptions/subscriptionId/' for subscription scope, '/subscriptions/subscriptionId/resourceGroups/resourceGroupName' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/billingAccountId' for Billing Account scope, '/providers/Microsoft.Billing/billingAccounts/billingAccountId/departments/departmentId' for Department scope, '/providers/Microsoft.Billing/billingAccounts/billingAccountId/enrollmentAccounts/enrollmentAccountId' for EnrollmentAccount scope and '/providers/Microsoft.Management/managementGroups/managementGroupId' for Management Group scope.. 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:

  • scope (String) —

    The scope associated with dimension operations. This

  • 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.



91
92
93
 
# File 'lib/2019-01-01/generated/azure_mgmt_cost_management/dimensions.rb', line 91

def list_by_subscription_with_http_info(scope, filter:nil, expand:nil, skiptoken:nil, top:nil, custom_headers:nil)
  list_by_subscription_async(scope, filter:filter, expand:expand, skiptoken:skiptoken, top:top, custom_headers:custom_headers).value!
end