Class: Azure::Consumption::Mgmt::V2019_04_01_preview::AggregatedCost

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-04-01-preview/generated/azure_mgmt_consumption/aggregated_cost.rb

Overview

Consumption management client provides access to consumption resources for Azure Enterprise Subscriptions.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ AggregatedCost

Creates and initializes a new instance of the AggregatedCost class.

Parameters:

  • client —

    service class for accessing basic functionality.



18
19
20
 
# File 'lib/2019-04-01-preview/generated/azure_mgmt_consumption/aggregated_cost.rb', line 18

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ ConsumptionManagementClient (readonly)

Returns reference to the ConsumptionManagementClient.

Returns:



23
24
25
 
# File 'lib/2019-04-01-preview/generated/azure_mgmt_consumption/aggregated_cost.rb', line 23

def client
  @client
end

Instance Method Details

#get_by_management_group(management_group_id, filter: nil, custom_headers: nil) ⇒ ManagementGroupAggregatedCostResult

Provides the aggregate cost of a management group and all child management groups by current billing period.

properties/usageStart (Utc time), properties/usageEnd (Utc time). The filter supports ‘eq’, ‘lt’, ‘gt’, ‘le’, ‘ge’, and ‘and’. It does not currently support ‘ne’, ‘or’, or ‘not’. Tag filter is a key value pair string where key and value is separated by a colon (:). will be added to the HTTP request.

Parameters:

  • management_group_id (String) —

    Azure Management Group ID.

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

    May be used to filter aggregated cost by

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

    A hash of custom headers that

Returns:

  • (ManagementGroupAggregatedCostResult) —

    operation results.



40
41
42
43
 
# File 'lib/2019-04-01-preview/generated/azure_mgmt_consumption/aggregated_cost.rb', line 40

def get_by_management_group(management_group_id, filter:nil, custom_headers:nil)
  response = get_by_management_group_async(management_group_id, filter:filter, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_by_management_group_async(management_group_id, filter: nil, custom_headers: nil) ⇒ Concurrent::Promise

Provides the aggregate cost of a management group and all child management groups by current billing period.

properties/usageStart (Utc time), properties/usageEnd (Utc time). The filter supports ‘eq’, ‘lt’, ‘gt’, ‘le’, ‘ge’, and ‘and’. It does not currently support ‘ne’, ‘or’, or ‘not’. Tag filter is a key value pair string where key and value is separated by a colon (:). to the HTTP request.

Parameters:

  • management_group_id (String) —

    Azure Management Group ID.

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

    May be used to filter aggregated cost by

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



79
80
81
82
83
84
85
86
87
88
89
90
91
92
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
 
# File 'lib/2019-04-01-preview/generated/azure_mgmt_consumption/aggregated_cost.rb', line 79

def get_by_management_group_async(management_group_id, filter:nil, custom_headers:nil)
  fail ArgumentError, 'management_group_id is nil' if management_group_id.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.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'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Consumption/aggregatedcost'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'managementGroupId' => management_group_id},
      query_params: {'api-version' => @client.api_version,'$filter' => filter},
      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::Consumption::Mgmt::V2019_04_01_preview::Models::ManagementGroupAggregatedCostResult.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

#get_by_management_group_with_http_info(management_group_id, filter: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Provides the aggregate cost of a management group and all child management groups by current billing period.

properties/usageStart (Utc time), properties/usageEnd (Utc time). The filter supports ‘eq’, ‘lt’, ‘gt’, ‘le’, ‘ge’, and ‘and’. It does not currently support ‘ne’, ‘or’, or ‘not’. Tag filter is a key value pair string where key and value is separated by a colon (:). will be added to the HTTP request.

Parameters:

  • management_group_id (String) —

    Azure Management Group ID.

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

    May be used to filter aggregated cost by

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



60
61
62
 
# File 'lib/2019-04-01-preview/generated/azure_mgmt_consumption/aggregated_cost.rb', line 60

def get_by_management_group_with_http_info(management_group_id, filter:nil, custom_headers:nil)
  get_by_management_group_async(management_group_id, filter:filter, custom_headers:custom_headers).value!
end

#get_for_billing_period_by_management_group(management_group_id, billing_period_name, custom_headers: nil) ⇒ ManagementGroupAggregatedCostResult

Provides the aggregate cost of a management group and all child management groups by specified billing period

will be added to the HTTP request.

Parameters:

  • management_group_id (String) —

    Azure Management Group ID.

  • billing_period_name (String) —

    Billing Period Name.

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

    A hash of custom headers that

Returns:

  • (ManagementGroupAggregatedCostResult) —

    operation results.



143
144
145
146
 
# File 'lib/2019-04-01-preview/generated/azure_mgmt_consumption/aggregated_cost.rb', line 143

def get_for_billing_period_by_management_group(management_group_id, billing_period_name, custom_headers:nil)
  response = get_for_billing_period_by_management_group_async(management_group_id, billing_period_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_for_billing_period_by_management_group_async(management_group_id, billing_period_name, custom_headers: nil) ⇒ Concurrent::Promise

Provides the aggregate cost of a management group and all child management groups by specified billing period

to the HTTP request.

Parameters:

  • management_group_id (String) —

    Azure Management Group ID.

  • billing_period_name (String) —

    Billing Period Name.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/2019-04-01-preview/generated/azure_mgmt_consumption/aggregated_cost.rb', line 174

def get_for_billing_period_by_management_group_async(management_group_id, billing_period_name, custom_headers:nil)
  fail ArgumentError, 'management_group_id is nil' if management_group_id.nil?
  fail ArgumentError, 'billing_period_name is nil' if billing_period_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.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'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/Microsoft.Consumption/aggregatedcost'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'managementGroupId' => management_group_id,'billingPeriodName' => billing_period_name},
      query_params: {'api-version' => @client.api_version},
      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::Consumption::Mgmt::V2019_04_01_preview::Models::ManagementGroupAggregatedCostResult.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

#get_for_billing_period_by_management_group_with_http_info(management_group_id, billing_period_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Provides the aggregate cost of a management group and all child management groups by specified billing period

will be added to the HTTP request.

Parameters:

  • management_group_id (String) —

    Azure Management Group ID.

  • billing_period_name (String) —

    Billing Period Name.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



159
160
161
 
# File 'lib/2019-04-01-preview/generated/azure_mgmt_consumption/aggregated_cost.rb', line 159

def get_for_billing_period_by_management_group_with_http_info(management_group_id, billing_period_name, custom_headers:nil)
  get_for_billing_period_by_management_group_async(management_group_id, billing_period_name, custom_headers:custom_headers).value!
end