class Azure::Reservations::Mgmt::V2019_04_01_preview::ReservationOrder
This API describe Azure
Reservation
Attributes
@return [ReservationsManagementClient] reference to the ReservationsManagementClient
Private Class Methods
Creates and initializes a new instance of the ReservationOrder
class. @param client service class for accessing basic functionality.
# File lib/2019-04-01-preview/generated/azure_mgmt_reservations/reservation_order.rb, line 17 def initialize(client) @client = client end
Private Instance Methods
Purchase `ReservationOrder`
Purchase `ReservationOrder` and create resource under the specified URI.
@param reservation_order_id [String] Order Id of the reservation @param body [PurchaseRequest] Information needed for calculate or purchase reservation @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [ReservationOrderResponse] operation results.
# File lib/2019-04-01-preview/generated/azure_mgmt_reservations/reservation_order.rb, line 378 def begin_purchase(reservation_order_id, body, custom_headers:nil) response = begin_purchase_async(reservation_order_id, body, custom_headers:custom_headers).value! response.body unless response.nil? end
Purchase `ReservationOrder`
Purchase `ReservationOrder` and create resource under the specified URI.
@param reservation_order_id [String] Order Id of the reservation @param body [PurchaseRequest] Information needed for calculate or purchase reservation @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [Concurrent::Promise] Promise object which holds the HTTP response.
# File lib/2019-04-01-preview/generated/azure_mgmt_reservations/reservation_order.rb, line 413 def begin_purchase_async(reservation_order_id, body, custom_headers:nil) fail ArgumentError, 'reservation_order_id is nil' if reservation_order_id.nil? fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil? fail ArgumentError, 'body is nil' if body.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? # Serialize Request request_mapper = Azure::Reservations::Mgmt::V2019_04_01_preview::Models::PurchaseRequest.mapper() request_content = @client.serialize(request_mapper, body) request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil path_template = 'providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}' request_url = @base_url || @client.base_url options = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], path_params: {'reservationOrderId' => reservation_order_id}, query_params: {'api-version' => @client.api_version}, body: request_content, headers: request_headers.merge(custom_headers || {}), base_url: request_url } promise = @client.make_request_async(:put, 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::Reservations::Mgmt::V2019_04_01_preview::Models::ReservationOrderResponse.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 # Deserialize Response if status_code == 202 begin parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content) result_mapper = Azure::Reservations::Mgmt::V2019_04_01_preview::Models::ReservationOrderResponse.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
Purchase `ReservationOrder`
Purchase `ReservationOrder` and create resource under the specified URI.
@param reservation_order_id [String] Order Id of the reservation @param body [PurchaseRequest] Information needed for calculate or purchase reservation @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [MsRestAzure::AzureOperationResponse] HTTP response information.
# File lib/2019-04-01-preview/generated/azure_mgmt_reservations/reservation_order.rb, line 396 def begin_purchase_with_http_info(reservation_order_id, body, custom_headers:nil) begin_purchase_async(reservation_order_id, body, custom_headers:custom_headers).value! end
Calculate price for a `ReservationOrder`.
Calculate price for placing a `ReservationOrder`.
@param body [PurchaseRequest] Information needed for calculate or purchase reservation @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [CalculatePriceResponse] operation results.
# File lib/2019-04-01-preview/generated/azure_mgmt_reservations/reservation_order.rb, line 36 def calculate(body, custom_headers:nil) response = calculate_async(body, custom_headers:custom_headers).value! response.body unless response.nil? end
Calculate price for a `ReservationOrder`.
Calculate price for placing a `ReservationOrder`.
@param body [PurchaseRequest] Information needed for calculate or purchase reservation @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [Concurrent::Promise] Promise object which holds the HTTP response.
# File lib/2019-04-01-preview/generated/azure_mgmt_reservations/reservation_order.rb, line 69 def calculate_async(body, custom_headers:nil) fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil? fail ArgumentError, 'body is nil' if body.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? # Serialize Request request_mapper = Azure::Reservations::Mgmt::V2019_04_01_preview::Models::PurchaseRequest.mapper() request_content = @client.serialize(request_mapper, body) request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil path_template = 'providers/Microsoft.Capacity/calculatePrice' request_url = @base_url || @client.base_url options = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], query_params: {'api-version' => @client.api_version}, body: request_content, 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 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::Reservations::Mgmt::V2019_04_01_preview::Models::CalculatePriceResponse.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
Calculate price for a `ReservationOrder`.
Calculate price for placing a `ReservationOrder`.
@param body [PurchaseRequest] Information needed for calculate or purchase reservation @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [MsRestAzure::AzureOperationResponse] HTTP response information.
# File lib/2019-04-01-preview/generated/azure_mgmt_reservations/reservation_order.rb, line 53 def calculate_with_http_info(body, custom_headers:nil) calculate_async(body, custom_headers:custom_headers).value! end
Get a specific `ReservationOrder`.
Get the details of the `ReservationOrder`.
@param reservation_order_id [String] Order Id of the reservation @param expand [String] May be used to expand the planInformation. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [ReservationOrderResponse] operation results.
# File lib/2019-04-01-preview/generated/azure_mgmt_reservations/reservation_order.rb, line 279 def get(reservation_order_id, expand:nil, custom_headers:nil) response = get_async(reservation_order_id, expand:expand, custom_headers:custom_headers).value! response.body unless response.nil? end
Get a specific `ReservationOrder`.
Get the details of the `ReservationOrder`.
@param reservation_order_id [String] Order Id of the reservation @param expand [String] May be used to expand the planInformation. @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [Concurrent::Promise] Promise object which holds the HTTP response.
# File lib/2019-04-01-preview/generated/azure_mgmt_reservations/reservation_order.rb, line 312 def get_async(reservation_order_id, expand:nil, custom_headers:nil) fail ArgumentError, 'reservation_order_id is nil' if reservation_order_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.Capacity/reservationOrders/{reservationOrderId}' request_url = @base_url || @client.base_url options = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], path_params: {'reservationOrderId' => reservation_order_id}, query_params: {'api-version' => @client.api_version,'$expand' => expand}, 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::Reservations::Mgmt::V2019_04_01_preview::Models::ReservationOrderResponse.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 a specific `ReservationOrder`.
Get the details of the `ReservationOrder`.
@param reservation_order_id [String] Order Id of the reservation @param expand [String] May be used to expand the planInformation. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [MsRestAzure::AzureOperationResponse] HTTP response information.
# File lib/2019-04-01-preview/generated/azure_mgmt_reservations/reservation_order.rb, line 296 def get_with_http_info(reservation_order_id, expand:nil, custom_headers:nil) get_async(reservation_order_id, expand:expand, custom_headers:custom_headers).value! end
Get all `ReservationOrder`s.
List of all the `ReservationOrder`s that the user has access to in the current tenant.
@param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [Array<ReservationOrderResponse>] operation results.
# File lib/2019-04-01-preview/generated/azure_mgmt_reservations/reservation_order.rb, line 139 def list(custom_headers:nil) first_page = list_as_lazy(custom_headers:custom_headers) first_page.get_all_items end
Get all `ReservationOrder`s.
List of all the `ReservationOrder`s that the user has access to in the current tenant.
@param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [ReservationOrderList] which provide lazy access to pages of the response.
# File lib/2019-04-01-preview/generated/azure_mgmt_reservations/reservation_order.rb, line 595 def list_as_lazy(custom_headers:nil) response = list_async(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
Get all `ReservationOrder`s.
List of all the `ReservationOrder`s that the user has access to in the current tenant.
@param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [Concurrent::Promise] Promise object which holds the HTTP response.
# File lib/2019-04-01-preview/generated/azure_mgmt_reservations/reservation_order.rb, line 170 def list_async(custom_headers: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.Capacity/reservationOrders' request_url = @base_url || @client.base_url options = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], 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::Reservations::Mgmt::V2019_04_01_preview::Models::ReservationOrderList.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 all `ReservationOrder`s.
List of all the `ReservationOrder`s that the user has access to in the current tenant.
@param next_page_link [String] The NextLink from the previous successful call to List operation. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [ReservationOrderList] operation results.
# File lib/2019-04-01-preview/generated/azure_mgmt_reservations/reservation_order.rb, line 497 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
Get all `ReservationOrder`s.
List of all the `ReservationOrder`s that the user has access to in the current tenant.
@param next_page_link [String] The NextLink from the previous successful call to List operation. @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [Concurrent::Promise] Promise object which holds the HTTP response.
# File lib/2019-04-01-preview/generated/azure_mgmt_reservations/reservation_order.rb, line 532 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 options = { 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, 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::Reservations::Mgmt::V2019_04_01_preview::Models::ReservationOrderList.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 all `ReservationOrder`s.
List of all the `ReservationOrder`s that the user has access to in the current tenant.
@param next_page_link [String] The NextLink from the previous successful call to List operation. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [MsRestAzure::AzureOperationResponse] HTTP response information.
# File lib/2019-04-01-preview/generated/azure_mgmt_reservations/reservation_order.rb, line 515 def list_next_with_http_info(next_page_link, custom_headers:nil) list_next_async(next_page_link, custom_headers:custom_headers).value! end
Get all `ReservationOrder`s.
List of all the `ReservationOrder`s that the user has access to in the current tenant.
@param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [MsRestAzure::AzureOperationResponse] HTTP response information.
# File lib/2019-04-01-preview/generated/azure_mgmt_reservations/reservation_order.rb, line 155 def list_with_http_info(custom_headers:nil) list_async(custom_headers:custom_headers).value! end
Purchase `ReservationOrder`
Purchase `ReservationOrder` and create resource under the specified URI.
@param reservation_order_id [String] Order Id of the reservation @param body [PurchaseRequest] Information needed for calculate or purchase reservation @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [ReservationOrderResponse] operation results.
# File lib/2019-04-01-preview/generated/azure_mgmt_reservations/reservation_order.rb, line 234 def purchase(reservation_order_id, body, custom_headers:nil) response = purchase_async(reservation_order_id, body, custom_headers:custom_headers).value! response.body unless response.nil? end
@param reservation_order_id [String] Order Id of the reservation @param body [PurchaseRequest] Information needed for calculate or purchase reservation @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [Concurrent::Promise] promise which provides async access to http response.
# File lib/2019-04-01-preview/generated/azure_mgmt_reservations/reservation_order.rb, line 249 def purchase_async(reservation_order_id, body, custom_headers:nil) # Send request promise = begin_purchase_async(reservation_order_id, body, custom_headers:custom_headers) promise = promise.then do |response| # Defining deserialization method. deserialize_method = lambda do |parsed_response| result_mapper = Azure::Reservations::Mgmt::V2019_04_01_preview::Models::ReservationOrderResponse.mapper() parsed_response = @client.deserialize(result_mapper, parsed_response) end # Waiting for response. @client.get_long_running_operation_result(response, deserialize_method) end promise end