ReservationOrder interface

Package:

@azure/arm-reservations

Interface representing a ReservationOrder.

Methods

beginPurchase(string, PurchaseRequest, ReservationOrderPurchaseOptionalParams)	Purchase ReservationOrder and create resource under the specified URI.
beginPurchaseAndWait(string, PurchaseRequest, ReservationOrderPurchaseOptionalParams)	Purchase ReservationOrder and create resource under the specified URI.
calculate(PurchaseRequest, ReservationOrderCalculateOptionalParams)	Calculate price for placing a ReservationOrder.
changeDirectory(string, ChangeDirectoryRequest, ReservationOrderChangeDirectoryOptionalParams)	Change directory (tenant) of ReservationOrder and all Reservation under it to specified tenant id
get(string, ReservationOrderGetOptionalParams)	Get the details of the ReservationOrder.
list(ReservationOrderListOptionalParams)	List of all the ReservationOrders that the user has access to in the current tenant.

Method Details

beginPurchase(string, PurchaseRequest, ReservationOrderPurchaseOptionalParams)

Purchase ReservationOrder and create resource under the specified URI.

function beginPurchase(reservationOrderId: string, body: PurchaseRequest, options?: ReservationOrderPurchaseOptionalParams): Promise<SimplePollerLike<OperationState<ReservationOrderResponse>, ReservationOrderResponse>>

Parameters

reservationOrderId

string

Order Id of the reservation

body

PurchaseRequest

Information needed for calculate or purchase reservation

options

ReservationOrderPurchaseOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<ReservationOrderResponse>, ReservationOrderResponse>>

beginPurchaseAndWait(string, PurchaseRequest, ReservationOrderPurchaseOptionalParams)

Purchase ReservationOrder and create resource under the specified URI.

function beginPurchaseAndWait(reservationOrderId: string, body: PurchaseRequest, options?: ReservationOrderPurchaseOptionalParams): Promise<ReservationOrderResponse>

Parameters

reservationOrderId

string

Order Id of the reservation

body

PurchaseRequest

Information needed for calculate or purchase reservation

options

ReservationOrderPurchaseOptionalParams

The options parameters.

Returns

Promise<ReservationOrderResponse>

calculate(PurchaseRequest, ReservationOrderCalculateOptionalParams)

Calculate price for placing a ReservationOrder.

function calculate(body: PurchaseRequest, options?: ReservationOrderCalculateOptionalParams): Promise<CalculatePriceResponse>

Parameters

body

PurchaseRequest

Information needed for calculate or purchase reservation

options

ReservationOrderCalculateOptionalParams

The options parameters.

Returns

Promise<CalculatePriceResponse>

changeDirectory(string, ChangeDirectoryRequest, ReservationOrderChangeDirectoryOptionalParams)

Change directory (tenant) of ReservationOrder and all Reservation under it to specified tenant id

function changeDirectory(reservationOrderId: string, body: ChangeDirectoryRequest, options?: ReservationOrderChangeDirectoryOptionalParams): Promise<ChangeDirectoryResponse>

Parameters

reservationOrderId

string

Order Id of the reservation

body

ChangeDirectoryRequest

Information needed to change directory of reservation order

options

ReservationOrderChangeDirectoryOptionalParams

The options parameters.

Returns

Promise<ChangeDirectoryResponse>

get(string, ReservationOrderGetOptionalParams)

Get the details of the ReservationOrder.

function get(reservationOrderId: string, options?: ReservationOrderGetOptionalParams): Promise<ReservationOrderResponse>

Parameters

reservationOrderId

string

Order Id of the reservation

options

ReservationOrderGetOptionalParams

The options parameters.

Returns

Promise<ReservationOrderResponse>

list(ReservationOrderListOptionalParams)

List of all the ReservationOrders that the user has access to in the current tenant.

function list(options?: ReservationOrderListOptionalParams): PagedAsyncIterableIterator<ReservationOrderResponse, ReservationOrderResponse[], PageSettings>

Parameters

options

ReservationOrderListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ReservationOrderResponse, ReservationOrderResponse[], PageSettings>