Reservation interface
Interface representing a Reservation.
Methods
archive(string, string, Reservation |
Archiving a |
begin |
Check whether the scopes from request is valid for |
begin |
Check whether the scopes from request is valid for |
begin |
Merge the specified |
begin |
Merge the specified |
begin |
Split a |
begin |
Split a |
begin |
Updates the applied scopes of the |
begin |
Updates the applied scopes of the |
get(string, string, Reservation |
Get specific |
list(string, Reservation |
List |
list |
List the reservations and the roll up counts of reservations group by provisioning states that the user has access to in the current tenant. |
list |
List of all the revisions for the |
unarchive(string, string, Reservation |
Restores a |
Method Details
archive(string, string, ReservationArchiveOptionalParams)
Archiving a Reservation
moves it to Archived
state.
function archive(reservationOrderId: string, reservationId: string, options?: ReservationArchiveOptionalParams): Promise<void>
Parameters
- reservationOrderId
-
string
Order Id of the reservation
- reservationId
-
string
Id of the reservation item
- options
- ReservationArchiveOptionalParams
The options parameters.
Returns
Promise<void>
beginAvailableScopes(string, string, AvailableScopeRequest, ReservationAvailableScopesOptionalParams)
Check whether the scopes from request is valid for Reservation
.
function beginAvailableScopes(reservationOrderId: string, reservationId: string, body: AvailableScopeRequest, options?: ReservationAvailableScopesOptionalParams): Promise<SimplePollerLike<OperationState<AvailableScopeProperties>, AvailableScopeProperties>>
Parameters
- reservationOrderId
-
string
Order Id of the reservation
- reservationId
-
string
Id of the reservation item
Scopes to be checked for eligibility.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<AvailableScopeProperties>, AvailableScopeProperties>>
beginAvailableScopesAndWait(string, string, AvailableScopeRequest, ReservationAvailableScopesOptionalParams)
Check whether the scopes from request is valid for Reservation
.
function beginAvailableScopesAndWait(reservationOrderId: string, reservationId: string, body: AvailableScopeRequest, options?: ReservationAvailableScopesOptionalParams): Promise<AvailableScopeProperties>
Parameters
- reservationOrderId
-
string
Order Id of the reservation
- reservationId
-
string
Id of the reservation item
Scopes to be checked for eligibility.
The options parameters.
Returns
Promise<AvailableScopeProperties>
beginMerge(string, MergeRequest, ReservationMergeOptionalParams)
Merge the specified Reservation
s into a new Reservation
. The two Reservation
s being merged
must have same properties.
function beginMerge(reservationOrderId: string, body: MergeRequest, options?: ReservationMergeOptionalParams): Promise<SimplePollerLike<OperationState<ReservationMergeResponse>, ReservationMergeResponse>>
Parameters
- reservationOrderId
-
string
Order Id of the reservation
- body
- MergeRequest
Information needed for commercial request for a reservation
- options
- ReservationMergeOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<ReservationMergeResponse>, ReservationMergeResponse>>
beginMergeAndWait(string, MergeRequest, ReservationMergeOptionalParams)
Merge the specified Reservation
s into a new Reservation
. The two Reservation
s being merged
must have same properties.
function beginMergeAndWait(reservationOrderId: string, body: MergeRequest, options?: ReservationMergeOptionalParams): Promise<ReservationMergeResponse>
Parameters
- reservationOrderId
-
string
Order Id of the reservation
- body
- MergeRequest
Information needed for commercial request for a reservation
- options
- ReservationMergeOptionalParams
The options parameters.
Returns
Promise<ReservationMergeResponse>
beginSplit(string, SplitRequest, ReservationSplitOptionalParams)
Split a Reservation
into two Reservation
s with specified quantity distribution.
function beginSplit(reservationOrderId: string, body: SplitRequest, options?: ReservationSplitOptionalParams): Promise<SimplePollerLike<OperationState<ReservationSplitResponse>, ReservationSplitResponse>>
Parameters
- reservationOrderId
-
string
Order Id of the reservation
- body
- SplitRequest
Information needed to Split a reservation item
- options
- ReservationSplitOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<ReservationSplitResponse>, ReservationSplitResponse>>
beginSplitAndWait(string, SplitRequest, ReservationSplitOptionalParams)
Split a Reservation
into two Reservation
s with specified quantity distribution.
function beginSplitAndWait(reservationOrderId: string, body: SplitRequest, options?: ReservationSplitOptionalParams): Promise<ReservationSplitResponse>
Parameters
- reservationOrderId
-
string
Order Id of the reservation
- body
- SplitRequest
Information needed to Split a reservation item
- options
- ReservationSplitOptionalParams
The options parameters.
Returns
Promise<ReservationSplitResponse>
beginUpdate(string, string, Patch, ReservationUpdateOptionalParams)
Updates the applied scopes of the Reservation
.
function beginUpdate(reservationOrderId: string, reservationId: string, parameters: Patch, options?: ReservationUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ReservationResponse>, ReservationResponse>>
Parameters
- reservationOrderId
-
string
Order Id of the reservation
- reservationId
-
string
Id of the reservation item
- parameters
- Patch
Information needed to patch a reservation item
- options
- ReservationUpdateOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<ReservationResponse>, ReservationResponse>>
beginUpdateAndWait(string, string, Patch, ReservationUpdateOptionalParams)
Updates the applied scopes of the Reservation
.
function beginUpdateAndWait(reservationOrderId: string, reservationId: string, parameters: Patch, options?: ReservationUpdateOptionalParams): Promise<ReservationResponse>
Parameters
- reservationOrderId
-
string
Order Id of the reservation
- reservationId
-
string
Id of the reservation item
- parameters
- Patch
Information needed to patch a reservation item
- options
- ReservationUpdateOptionalParams
The options parameters.
Returns
Promise<ReservationResponse>
get(string, string, ReservationGetOptionalParams)
Get specific Reservation
details.
function get(reservationOrderId: string, reservationId: string, options?: ReservationGetOptionalParams): Promise<ReservationResponse>
Parameters
- reservationOrderId
-
string
Order Id of the reservation
- reservationId
-
string
Id of the reservation item
- options
- ReservationGetOptionalParams
The options parameters.
Returns
Promise<ReservationResponse>
list(string, ReservationListOptionalParams)
List Reservation
s within a single ReservationOrder
.
function list(reservationOrderId: string, options?: ReservationListOptionalParams): PagedAsyncIterableIterator<ReservationResponse, ReservationResponse[], PageSettings>
Parameters
- reservationOrderId
-
string
Order Id of the reservation
- options
- ReservationListOptionalParams
The options parameters.
Returns
listAll(ReservationListAllOptionalParams)
List the reservations and the roll up counts of reservations group by provisioning states that the user has access to in the current tenant.
function listAll(options?: ReservationListAllOptionalParams): PagedAsyncIterableIterator<ReservationResponse, ReservationResponse[], PageSettings>
Parameters
- options
- ReservationListAllOptionalParams
The options parameters.
Returns
listRevisions(string, string, ReservationListRevisionsOptionalParams)
List of all the revisions for the Reservation
.
function listRevisions(reservationOrderId: string, reservationId: string, options?: ReservationListRevisionsOptionalParams): PagedAsyncIterableIterator<ReservationResponse, ReservationResponse[], PageSettings>
Parameters
- reservationOrderId
-
string
Order Id of the reservation
- reservationId
-
string
Id of the reservation item
The options parameters.
Returns
unarchive(string, string, ReservationUnarchiveOptionalParams)
Restores a Reservation
to the state it was before archiving.
function unarchive(reservationOrderId: string, reservationId: string, options?: ReservationUnarchiveOptionalParams): Promise<void>
Parameters
- reservationOrderId
-
string
Order Id of the reservation
- reservationId
-
string
Id of the reservation item
The options parameters.
Returns
Promise<void>