Share via

Reservations interface

  • Reference
Package:
@azure/arm-billing

Interface representing a Reservations.

Methods

beginUpdateByBillingAccount(string, string, string, Patch, ReservationsUpdateByBillingAccountOptionalParams)

Update reservation by billing account.
beginUpdateByBillingAccountAndWait(string, string, string, Patch, ReservationsUpdateByBillingAccountOptionalParams)

Update reservation by billing account.
getByReservationOrder(string, string, string, ReservationsGetByReservationOrderOptionalParams)

Get specific Reservation details in the billing account.
listByBillingAccount(string, ReservationsListByBillingAccountOptionalParams)

Lists the reservations in the billing account and the roll up counts of reservations group by provisioning states.
listByBillingProfile(string, string, ReservationsListByBillingProfileOptionalParams)

Lists the reservations for a billing profile and the roll up counts of reservations group by provisioning state.
listByReservationOrder(string, string, ReservationsListByReservationOrderOptionalParams)

List Reservations within a single ReservationOrder in the billing account.

Method Details

beginUpdateByBillingAccount(string, string, string, Patch, ReservationsUpdateByBillingAccountOptionalParams)

Update reservation by billing account.

function beginUpdateByBillingAccount(billingAccountName: string, reservationOrderId: string, reservationId: string, body: Patch, options?: ReservationsUpdateByBillingAccountOptionalParams): Promise<SimplePollerLike<OperationState<Reservation>, Reservation>>

Parameters

billingAccountName

string

The ID that uniquely identifies a billing account.

reservationOrderId

string

Order Id of the reservation

reservationId

string

Id of the reservation item

body
Patch

Request body for patching a reservation

options
ReservationsUpdateByBillingAccountOptionalParams

The options parameters.

Returns

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

beginUpdateByBillingAccountAndWait(string, string, string, Patch, ReservationsUpdateByBillingAccountOptionalParams)

Update reservation by billing account.

function beginUpdateByBillingAccountAndWait(billingAccountName: string, reservationOrderId: string, reservationId: string, body: Patch, options?: ReservationsUpdateByBillingAccountOptionalParams): Promise<Reservation>

Parameters

billingAccountName

string

The ID that uniquely identifies a billing account.

reservationOrderId

string

Order Id of the reservation

reservationId

string

Id of the reservation item

body
Patch

Request body for patching a reservation

options
ReservationsUpdateByBillingAccountOptionalParams

The options parameters.

Returns

Promise<Reservation>

getByReservationOrder(string, string, string, ReservationsGetByReservationOrderOptionalParams)

Get specific Reservation details in the billing account.

function getByReservationOrder(billingAccountName: string, reservationOrderId: string, reservationId: string, options?: ReservationsGetByReservationOrderOptionalParams): Promise<Reservation>

Parameters

billingAccountName

string

The ID that uniquely identifies a billing account.

reservationOrderId

string

Order Id of the reservation

reservationId

string

Id of the reservation item

options
ReservationsGetByReservationOrderOptionalParams

The options parameters.

Returns

Promise<Reservation>

listByBillingAccount(string, ReservationsListByBillingAccountOptionalParams)

Lists the reservations in the billing account and the roll up counts of reservations group by provisioning states.

function listByBillingAccount(billingAccountName: string, options?: ReservationsListByBillingAccountOptionalParams): PagedAsyncIterableIterator<Reservation, Reservation[], PageSettings>

Parameters

billingAccountName

string

The ID that uniquely identifies a billing account.

options
ReservationsListByBillingAccountOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Reservation, Reservation[], PageSettings>

listByBillingProfile(string, string, ReservationsListByBillingProfileOptionalParams)

Lists the reservations for a billing profile and the roll up counts of reservations group by provisioning state.

function listByBillingProfile(billingAccountName: string, billingProfileName: string, options?: ReservationsListByBillingProfileOptionalParams): PagedAsyncIterableIterator<Reservation, Reservation[], PageSettings>

Parameters

billingAccountName

string

The ID that uniquely identifies a billing account.

billingProfileName

string

The ID that uniquely identifies a billing profile.

options
ReservationsListByBillingProfileOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Reservation, Reservation[], PageSettings>

listByReservationOrder(string, string, ReservationsListByReservationOrderOptionalParams)

List Reservations within a single ReservationOrder in the billing account.

function listByReservationOrder(billingAccountName: string, reservationOrderId: string, options?: ReservationsListByReservationOrderOptionalParams): PagedAsyncIterableIterator<Reservation, Reservation[], PageSettings>

Parameters

billingAccountName

string

The ID that uniquely identifies a billing account.

reservationOrderId

string

Order Id of the reservation

options
ReservationsListByReservationOrderOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Reservation, Reservation[], PageSettings>