Class: Azure::Billing::Mgmt::V2018_03_01_preview::BillingPeriods
- Inherits:
-
Object
- Object
- Azure::Billing::Mgmt::V2018_03_01_preview::BillingPeriods
- Includes:
- MsRestAzure
- Defined in:
- lib/2018-03-01-preview/generated/azure_mgmt_billing/billing_periods.rb
Overview
Billing client provides access to billing resources for Azure subscriptions.
Instance Attribute Summary collapse
-
#client ⇒ BillingManagementClient
readonly
Reference to the BillingManagementClient.
Instance Method Summary collapse
-
#get(billing_period_name, custom_headers: nil) ⇒ BillingPeriod
Gets a named billing period.
-
#get_async(billing_period_name, custom_headers: nil) ⇒ Concurrent::Promise
Gets a named billing period.
-
#get_with_http_info(billing_period_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Gets a named billing period.
-
#initialize(client) ⇒ BillingPeriods
constructor
Creates and initializes a new instance of the BillingPeriods class.
-
#list(filter: nil, skiptoken: nil, top: nil, custom_headers: nil) ⇒ Array<BillingPeriod>
Lists the available billing periods for a subscription in reverse chronological order.
-
#list_as_lazy(filter: nil, skiptoken: nil, top: nil, custom_headers: nil) ⇒ BillingPeriodsListResult
Lists the available billing periods for a subscription in reverse chronological order.
-
#list_async(filter: nil, skiptoken: nil, top: nil, custom_headers: nil) ⇒ Concurrent::Promise
Lists the available billing periods for a subscription in reverse chronological order.
-
#list_next(next_page_link, custom_headers: nil) ⇒ BillingPeriodsListResult
Lists the available billing periods for a subscription in reverse chronological order.
-
#list_next_async(next_page_link, custom_headers: nil) ⇒ Concurrent::Promise
Lists the available billing periods for a subscription in reverse chronological order.
-
#list_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Lists the available billing periods for a subscription in reverse chronological order.
-
#list_with_http_info(filter: nil, skiptoken: nil, top: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Lists the available billing periods for a subscription in reverse chronological order.
Constructor Details
#initialize(client) ⇒ BillingPeriods
Creates and initializes a new instance of the BillingPeriods class.
18 19 20 |
# File 'lib/2018-03-01-preview/generated/azure_mgmt_billing/billing_periods.rb', line 18 def initialize(client) @client = client end |
Instance Attribute Details
#client ⇒ BillingManagementClient (readonly)
23 24 25 |
# File 'lib/2018-03-01-preview/generated/azure_mgmt_billing/billing_periods.rb', line 23 def client @client end |
Instance Method Details
#get(billing_period_name, custom_headers: nil) ⇒ BillingPeriod
Gets a named billing period. This is only supported for Azure Web-Direct subscriptions. Other subscription types which were not purchased directly through the Azure web portal are not supported through this preview API.
will be added to the HTTP request.
158 159 160 161 |
# File 'lib/2018-03-01-preview/generated/azure_mgmt_billing/billing_periods.rb', line 158 def get(billing_period_name, custom_headers:nil) response = get_async(billing_period_name, custom_headers:custom_headers).value! response.body unless response.nil? end |
#get_async(billing_period_name, custom_headers: nil) ⇒ Concurrent::Promise
Gets a named billing period. This is only supported for Azure Web-Direct subscriptions. Other subscription types which were not purchased directly through the Azure web portal are not supported through this preview API.
to the HTTP request.
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 227 228 229 230 231 232 233 234 235 236 237 238 239 |
# File 'lib/2018-03-01-preview/generated/azure_mgmt_billing/billing_periods.rb', line 189 def get_async(billing_period_name, custom_headers:nil) fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil? fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil? fail ArgumentError, 'billing_period_name is nil' if billing_period_name.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 = 'subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}' request_url = @base_url || @client.base_url = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], path_params: {'subscriptionId' => @client.subscription_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, ) 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? # Deserialize Response if status_code == 200 begin parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content) result_mapper = Azure::Billing::Mgmt::V2018_03_01_preview::Models::BillingPeriod.mapper() result.body = @client.deserialize(result_mapper, parsed_response) rescue Exception => e fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e., e.backtrace, result) end end result end promise.execute end |
#get_with_http_info(billing_period_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Gets a named billing period. This is only supported for Azure Web-Direct subscriptions. Other subscription types which were not purchased directly through the Azure web portal are not supported through this preview API.
will be added to the HTTP request.
174 175 176 |
# File 'lib/2018-03-01-preview/generated/azure_mgmt_billing/billing_periods.rb', line 174 def get_with_http_info(billing_period_name, custom_headers:nil) get_async(billing_period_name, custom_headers:custom_headers).value! end |
#list(filter: nil, skiptoken: nil, top: nil, custom_headers: nil) ⇒ Array<BillingPeriod>
Lists the available billing periods for a subscription in reverse chronological order. This is only supported for Azure Web-Direct subscriptions. Other subscription types which were not purchased directly through the Azure web portal are not supported through this preview API.
billingPeriodEndDate. The filter supports ‘eq’, ‘lt’, ‘gt’, ‘le’, ‘ge’, and ‘and’. It does not currently support ‘ne’, ‘or’, or ‘not’. 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 billing periods. will be added to the HTTP request.
45 46 47 48 |
# File 'lib/2018-03-01-preview/generated/azure_mgmt_billing/billing_periods.rb', line 45 def list(filter:nil, skiptoken:nil, top:nil, custom_headers:nil) first_page = list_as_lazy(filter:filter, skiptoken:skiptoken, top:top, custom_headers:custom_headers) first_page.get_all_items end |
#list_as_lazy(filter: nil, skiptoken: nil, top: nil, custom_headers: nil) ⇒ BillingPeriodsListResult
Lists the available billing periods for a subscription in reverse chronological order. This is only supported for Azure Web-Direct subscriptions. Other subscription types which were not purchased directly through the Azure web portal are not supported through this preview API.
billingPeriodEndDate. The filter supports ‘eq’, ‘lt’, ‘gt’, ‘le’, ‘ge’, and ‘and’. It does not currently support ‘ne’, ‘or’, or ‘not’. 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 billing periods. will be added to the HTTP request.
response.
359 360 361 362 363 364 365 366 367 368 |
# File 'lib/2018-03-01-preview/generated/azure_mgmt_billing/billing_periods.rb', line 359 def list_as_lazy(filter:nil, skiptoken:nil, top:nil, custom_headers:nil) response = list_async(filter:filter, skiptoken:skiptoken, top:top, custom_headers:custom_headers).value! unless response.nil? page = response.body page.next_method = Proc.new do |next_page_link| list_next_async(next_page_link, custom_headers:custom_headers) end page end end |
#list_async(filter: nil, skiptoken: nil, top: nil, custom_headers: nil) ⇒ Concurrent::Promise
Lists the available billing periods for a subscription in reverse chronological order. This is only supported for Azure Web-Direct subscriptions. Other subscription types which were not purchased directly through the Azure web portal are not supported through this preview API.
billingPeriodEndDate. The filter supports ‘eq’, ‘lt’, ‘gt’, ‘le’, ‘ge’, and ‘and’. It does not currently support ‘ne’, ‘or’, or ‘not’. 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 billing periods. to the HTTP request.
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 |
# File 'lib/2018-03-01-preview/generated/azure_mgmt_billing/billing_periods.rb', line 94 def list_async(filter:nil, skiptoken:nil, top:nil, custom_headers:nil) fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil? fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil? fail ArgumentError, "'top' should satisfy the constraint - 'InclusiveMaximum': '100'" if !top.nil? && top > 100 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.Billing/billingPeriods' request_url = @base_url || @client.base_url = { 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,'$skiptoken' => skiptoken,'$top' => top}, headers: request_headers.merge(custom_headers || {}), base_url: request_url } promise = @client.make_request_async(:get, path_template, ) 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? # Deserialize Response if status_code == 200 begin parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content) result_mapper = Azure::Billing::Mgmt::V2018_03_01_preview::Models::BillingPeriodsListResult.mapper() result.body = @client.deserialize(result_mapper, parsed_response) rescue Exception => e fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e., e.backtrace, result) end end result end promise.execute end |
#list_next(next_page_link, custom_headers: nil) ⇒ BillingPeriodsListResult
Lists the available billing periods for a subscription in reverse chronological order. This is only supported for Azure Web-Direct subscriptions. Other subscription types which were not purchased directly through the Azure web portal are not supported through this preview API.
to List operation. will be added to the HTTP request.
254 255 256 257 |
# File 'lib/2018-03-01-preview/generated/azure_mgmt_billing/billing_periods.rb', line 254 def list_next(next_page_link, custom_headers:nil) response = list_next_async(next_page_link, custom_headers:custom_headers).value! response.body unless response.nil? end |
#list_next_async(next_page_link, custom_headers: nil) ⇒ Concurrent::Promise
Lists the available billing periods for a subscription in reverse chronological order. This is only supported for Azure Web-Direct subscriptions. Other subscription types which were not purchased directly through the Azure web portal are not supported through this preview API.
to List operation. to the HTTP request.
289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 |
# File 'lib/2018-03-01-preview/generated/azure_mgmt_billing/billing_periods.rb', line 289 def list_next_async(next_page_link, custom_headers:nil) fail ArgumentError, 'next_page_link is nil' if next_page_link.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 = '{nextLink}' request_url = @base_url || @client.base_url = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], skip_encoding_path_params: {'nextLink' => next_page_link}, headers: request_headers.merge(custom_headers || {}), base_url: request_url } promise = @client.make_request_async(:get, path_template, ) 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? # Deserialize Response if status_code == 200 begin parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content) result_mapper = Azure::Billing::Mgmt::V2018_03_01_preview::Models::BillingPeriodsListResult.mapper() result.body = @client.deserialize(result_mapper, parsed_response) rescue Exception => e fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e., e.backtrace, result) end end result end promise.execute end |
#list_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Lists the available billing periods for a subscription in reverse chronological order. This is only supported for Azure Web-Direct subscriptions. Other subscription types which were not purchased directly through the Azure web portal are not supported through this preview API.
to List operation. will be added to the HTTP request.
272 273 274 |
# File 'lib/2018-03-01-preview/generated/azure_mgmt_billing/billing_periods.rb', line 272 def list_next_with_http_info(next_page_link, custom_headers:nil) list_next_async(next_page_link, custom_headers:custom_headers).value! end |
#list_with_http_info(filter: nil, skiptoken: nil, top: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Lists the available billing periods for a subscription in reverse chronological order. This is only supported for Azure Web-Direct subscriptions. Other subscription types which were not purchased directly through the Azure web portal are not supported through this preview API.
billingPeriodEndDate. The filter supports ‘eq’, ‘lt’, ‘gt’, ‘le’, ‘ge’, and ‘and’. It does not currently support ‘ne’, ‘or’, or ‘not’. 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 billing periods. will be added to the HTTP request.
70 71 72 |
# File 'lib/2018-03-01-preview/generated/azure_mgmt_billing/billing_periods.rb', line 70 def list_with_http_info(filter:nil, skiptoken:nil, top:nil, custom_headers:nil) list_async(filter:filter, skiptoken:skiptoken, top:top, custom_headers:custom_headers).value! end |