ReservationOperations interface

Package:
@azure/arm-reservations

Interface representing a Reservation operations.

Properties

archive

Archiving a Reservation moves it to Archived state.
availableScopes

Check whether the scopes from request is valid for Reservation.
beginAvailableScopes
beginAvailableScopesAndWait
beginMerge
beginMergeAndWait
beginSplit
beginSplitAndWait
beginUpdate
beginUpdateAndWait
get

Get specific Reservation details.
list

List Reservations within a single ReservationOrder.
listAll

List the reservations and the roll up counts of reservations group by provisioning states that the user has access to in the current tenant.
listRevisions

List of all the revisions for the Reservation.
merge

Merge the specified Reservations into a new Reservation. The two Reservations being merged must have same properties.
split

Split a Reservation into two Reservations with specified quantity distribution.
unarchive

Restores a Reservation to the state it was before archiving.
update

Updates the applied scopes of the Reservation.

Property Details

archive

Archiving a Reservation moves it to Archived state.

archive: (reservationOrderId: string, reservationId: string, options?: ReservationArchiveOptionalParams) => Promise<void>

Property Value

(reservationOrderId: string, reservationId: string, options?: ReservationArchiveOptionalParams) => Promise<void>

availableScopes

Check whether the scopes from request is valid for Reservation.

availableScopes: (reservationOrderId: string, reservationId: string, body: AvailableScopeRequest, options?: ReservationAvailableScopesOptionalParams) => PollerLike<OperationState<AvailableScopeProperties>, AvailableScopeProperties>

Property Value

(reservationOrderId: string, reservationId: string, body: AvailableScopeRequest, options?: ReservationAvailableScopesOptionalParams) => PollerLike<OperationState<AvailableScopeProperties>, AvailableScopeProperties>

beginAvailableScopes

Warning

This API is now deprecated.

use availableScopes instead

beginAvailableScopes: (reservationOrderId: string, reservationId: string, body: AvailableScopeRequest, options?: ReservationAvailableScopesOptionalParams) => Promise<SimplePollerLike<OperationState<AvailableScopeProperties>, AvailableScopeProperties>>

Property Value

(reservationOrderId: string, reservationId: string, body: AvailableScopeRequest, options?: ReservationAvailableScopesOptionalParams) => Promise<SimplePollerLike<OperationState<AvailableScopeProperties>, AvailableScopeProperties>>

beginAvailableScopesAndWait

Warning

This API is now deprecated.

use availableScopes instead

beginAvailableScopesAndWait: (reservationOrderId: string, reservationId: string, body: AvailableScopeRequest, options?: ReservationAvailableScopesOptionalParams) => Promise<AvailableScopeProperties>

Property Value

(reservationOrderId: string, reservationId: string, body: AvailableScopeRequest, options?: ReservationAvailableScopesOptionalParams) => Promise<AvailableScopeProperties>

beginMerge

Warning

This API is now deprecated.

use merge instead

beginMerge: (reservationOrderId: string, body: MergeRequest, options?: ReservationMergeOptionalParams) => Promise<SimplePollerLike<OperationState<ReservationResponse[]>, ReservationResponse[]>>

Property Value

(reservationOrderId: string, body: MergeRequest, options?: ReservationMergeOptionalParams) => Promise<SimplePollerLike<OperationState<ReservationResponse[]>, ReservationResponse[]>>

beginMergeAndWait

Warning

This API is now deprecated.

use merge instead

beginMergeAndWait: (reservationOrderId: string, body: MergeRequest, options?: ReservationMergeOptionalParams) => Promise<ReservationResponse[]>

Property Value

(reservationOrderId: string, body: MergeRequest, options?: ReservationMergeOptionalParams) => Promise<ReservationResponse[]>

beginSplit

Warning

This API is now deprecated.

use split instead

beginSplit: (reservationOrderId: string, body: SplitRequest, options?: ReservationSplitOptionalParams) => Promise<SimplePollerLike<OperationState<ReservationResponse[]>, ReservationResponse[]>>

Property Value

(reservationOrderId: string, body: SplitRequest, options?: ReservationSplitOptionalParams) => Promise<SimplePollerLike<OperationState<ReservationResponse[]>, ReservationResponse[]>>

beginSplitAndWait

Warning

This API is now deprecated.

use split instead

beginSplitAndWait: (reservationOrderId: string, body: SplitRequest, options?: ReservationSplitOptionalParams) => Promise<ReservationResponse[]>

Property Value

(reservationOrderId: string, body: SplitRequest, options?: ReservationSplitOptionalParams) => Promise<ReservationResponse[]>

beginUpdate

Warning

This API is now deprecated.

use update instead

beginUpdate: (reservationOrderId: string, reservationId: string, parameters: Patch, options?: ReservationUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<ReservationResponse>, ReservationResponse>>

Property Value

(reservationOrderId: string, reservationId: string, parameters: Patch, options?: ReservationUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<ReservationResponse>, ReservationResponse>>

beginUpdateAndWait

Warning

This API is now deprecated.

use update instead

beginUpdateAndWait: (reservationOrderId: string, reservationId: string, parameters: Patch, options?: ReservationUpdateOptionalParams) => Promise<ReservationResponse>

Property Value

(reservationOrderId: string, reservationId: string, parameters: Patch, options?: ReservationUpdateOptionalParams) => Promise<ReservationResponse>

get

Get specific Reservation details.

get: (reservationOrderId: string, reservationId: string, options?: ReservationGetOptionalParams) => Promise<ReservationResponse>

Property Value

(reservationOrderId: string, reservationId: string, options?: ReservationGetOptionalParams) => Promise<ReservationResponse>

list

List Reservations within a single ReservationOrder.

list: (reservationOrderId: string, options?: ReservationListOptionalParams) => PagedAsyncIterableIterator<ReservationResponse, ReservationResponse[], PageSettings>

Property Value

(reservationOrderId: string, options?: ReservationListOptionalParams) => PagedAsyncIterableIterator<ReservationResponse, ReservationResponse[], PageSettings>

listAll

List the reservations and the roll up counts of reservations group by provisioning states that the user has access to in the current tenant.

listAll: (options?: ReservationListAllOptionalParams) => PagedAsyncIterableIterator<ReservationResponse, ReservationResponse[], PageSettings>

Property Value

(options?: ReservationListAllOptionalParams) => PagedAsyncIterableIterator<ReservationResponse, ReservationResponse[], PageSettings>

listRevisions

List of all the revisions for the Reservation.

listRevisions: (reservationOrderId: string, reservationId: string, options?: ReservationListRevisionsOptionalParams) => PagedAsyncIterableIterator<ReservationResponse, ReservationResponse[], PageSettings>

Property Value

(reservationOrderId: string, reservationId: string, options?: ReservationListRevisionsOptionalParams) => PagedAsyncIterableIterator<ReservationResponse, ReservationResponse[], PageSettings>

merge

Merge the specified Reservations into a new Reservation. The two Reservations being merged must have same properties.

merge: (reservationOrderId: string, body: MergeRequest, options?: ReservationMergeOptionalParams) => PollerLike<OperationState<ReservationResponse[]>, ReservationResponse[]>

Property Value

(reservationOrderId: string, body: MergeRequest, options?: ReservationMergeOptionalParams) => PollerLike<OperationState<ReservationResponse[]>, ReservationResponse[]>

split

Split a Reservation into two Reservations with specified quantity distribution.

split: (reservationOrderId: string, body: SplitRequest, options?: ReservationSplitOptionalParams) => PollerLike<OperationState<ReservationResponse[]>, ReservationResponse[]>

Property Value

(reservationOrderId: string, body: SplitRequest, options?: ReservationSplitOptionalParams) => PollerLike<OperationState<ReservationResponse[]>, ReservationResponse[]>

unarchive

Restores a Reservation to the state it was before archiving.

unarchive: (reservationOrderId: string, reservationId: string, options?: ReservationUnarchiveOptionalParams) => Promise<void>

Property Value

(reservationOrderId: string, reservationId: string, options?: ReservationUnarchiveOptionalParams) => Promise<void>

update

Updates the applied scopes of the Reservation.

update: (reservationOrderId: string, reservationId: string, parameters: Patch, options?: ReservationUpdateOptionalParams) => PollerLike<OperationState<ReservationResponse>, ReservationResponse>

Property Value

(reservationOrderId: string, reservationId: string, parameters: Patch, options?: ReservationUpdateOptionalParams) => PollerLike<OperationState<ReservationResponse>, ReservationResponse>