Class: Azure::Consumption::Mgmt::V2018_11_01_preview::BillingProfilePricesheet

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2018-11-01-preview/generated/azure_mgmt_consumption/billing_profile_pricesheet.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) ⇒ BillingProfilePricesheet

Creates and initializes a new instance of the BillingProfilePricesheet class.

Parameters:

  • client —

    service class for accessing basic functionality.



18
19
20
 
# File 'lib/2018-11-01-preview/generated/azure_mgmt_consumption/billing_profile_pricesheet.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/2018-11-01-preview/generated/azure_mgmt_consumption/billing_profile_pricesheet.rb', line 23

def client
  @client
end

Instance Method Details

#begin_download(billing_account_id, billing_profile_id, custom_headers: nil) ⇒ PricesheetDownloadResponse

Get pricesheet data for invoice id (invoiceName).

will be added to the HTTP request.

Parameters:

  • billing_account_id (String) —

    Azure Billing Account Id.

  • billing_profile_id (String) —

    Azure Billing Profile Id.

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

    A hash of custom headers that

Returns:

  • (PricesheetDownloadResponse) —

    operation results.



77
78
79
80
 
# File 'lib/2018-11-01-preview/generated/azure_mgmt_consumption/billing_profile_pricesheet.rb', line 77

def begin_download(, billing_profile_id, custom_headers:nil)
  response = begin_download_async(, billing_profile_id, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#begin_download_async(billing_account_id, billing_profile_id, custom_headers: nil) ⇒ Concurrent::Promise

Get pricesheet data for invoice id (invoiceName).

to the HTTP request.

Parameters:

  • billing_account_id (String) —

    Azure Billing Account Id.

  • billing_profile_id (String) —

    Azure Billing Profile Id.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/2018-11-01-preview/generated/azure_mgmt_consumption/billing_profile_pricesheet.rb', line 106

def begin_download_async(, billing_profile_id, 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, 'billing_profile_id is nil' if billing_profile_id.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.Consumption/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/pricesheet/default/download'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'billingAccountId' => ,'billingProfileId' => billing_profile_id},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.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 || status_code == 202
      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::V2018_11_01_preview::Models::PricesheetDownloadResponse.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

#begin_download_with_http_info(billing_account_id, billing_profile_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Get pricesheet data for invoice id (invoiceName).

will be added to the HTTP request.

Parameters:

  • billing_account_id (String) —

    Azure Billing Account Id.

  • billing_profile_id (String) —

    Azure Billing Profile Id.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



92
93
94
 
# File 'lib/2018-11-01-preview/generated/azure_mgmt_consumption/billing_profile_pricesheet.rb', line 92

def begin_download_with_http_info(, billing_profile_id, custom_headers:nil)
  begin_download_async(, billing_profile_id, custom_headers:custom_headers).value!
end

#download(billing_account_id, billing_profile_id, custom_headers: nil) ⇒ PricesheetDownloadResponse

Get pricesheet data for invoice id (invoiceName).

will be added to the HTTP request.

Parameters:

  • billing_account_id (String) —

    Azure Billing Account Id.

  • billing_profile_id (String) —

    Azure Billing Profile Id.

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

    A hash of custom headers that

Returns:

  • (PricesheetDownloadResponse) —

    operation results.



35
36
37
38
 
# File 'lib/2018-11-01-preview/generated/azure_mgmt_consumption/billing_profile_pricesheet.rb', line 35

def download(, billing_profile_id, custom_headers:nil)
  response = download_async(, billing_profile_id, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#download_async(billing_account_id, billing_profile_id, custom_headers: nil) ⇒ Concurrent::Promise

will be added to the HTTP request.

response.

Parameters:

  • billing_account_id (String) —

    Azure Billing Account Id.

  • billing_profile_id (String) —

    Azure Billing Profile Id.

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/2018-11-01-preview/generated/azure_mgmt_consumption/billing_profile_pricesheet.rb', line 49

def download_async(, billing_profile_id, custom_headers:nil)
  # Send request
  promise = begin_download_async(, billing_profile_id, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = Azure::Consumption::Mgmt::V2018_11_01_preview::Models::PricesheetDownloadResponse.mapper()
      parsed_response = @client.deserialize(result_mapper, parsed_response)
    end

    # Waiting for response.
    @client.get_long_running_operation_result(response, deserialize_method, FinalStateVia::LOCATION)
  end

  promise
end