@azure/arm-reservations package

Classes

AzureReservationAPI

Interfaces

AppliedReservationList	Paginated list of applied reservations
AppliedReservations	The response for applied reservations api
AppliedScopeProperties	Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup
AvailableScopeProperties	The response of available scope api containing scopes and their eligibilities.
AvailableScopeRequest	Available scope
AvailableScopeRequestProperties	Available scope request properties
AzureReservationAPIOptionalParams	Optional parameters.
BillingInformation	billing information
CalculateExchange	Interface representing a CalculateExchange.
CalculateExchangeOperationResultResponse	CalculateExchange operation result
CalculateExchangePostHeaders	Defines headers for CalculateExchange_post operation.
CalculateExchangePostOptionalParams	Optional parameters.
CalculateExchangeRequest	Calculate exchange request
CalculateExchangeRequestProperties	Calculate exchange request properties
CalculateExchangeResponseProperties	CalculateExchange response properties
CalculatePriceResponse	The response of calculate price for reservation.
CalculatePriceResponseProperties	Properties for calculate price response
CalculatePriceResponsePropertiesBillingCurrencyTotal	Currency and amount that customer will be charged in customer's local currency. Tax is not included.
CalculatePriceResponsePropertiesPricingCurrencyTotal	Amount that Microsoft uses for record. Used during refund for calculating refund limit. Tax is not included.
CalculateRefund	Interface representing a CalculateRefund.
CalculateRefundPostOptionalParams	Optional parameters.
CalculateRefundRequest	Request containing information needed for calculating refund.
CalculateRefundRequestProperties	Properties needed for calculate refund including the scope and the reservation to be returned.
CalculateRefundResponse	The response of calculate refund containing refund information of reservation
Catalog	Product details of a type of resource.
CatalogMsrp	Pricing information about the sku
CatalogsResult	The list of catalogs and pagination information.
ChangeDirectoryRequest	Request body for change directory of a reservation.
ChangeDirectoryResponse	Change directory response
ChangeDirectoryResult	Change directory result for reservation order or reservation
Commitment	Commitment towards the benefit.
CreateGenericQuotaRequestParameters	Quota change requests information.
CurrentQuotaLimit	Current quota limits.
CurrentQuotaLimitBase	Quota properties.
ErrorDetails	The details of the error.
ErrorModel	Error information
ErrorResponse	Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.
ExceptionResponse	The API error.
Exchange	Interface representing a Exchange.
ExchangeOperationResultResponse	Exchange operation result
ExchangePolicyError	error details
ExchangePolicyErrors	Exchange policy errors
ExchangePostHeaders	Defines headers for Exchange_post operation.
ExchangePostOptionalParams	Optional parameters.
ExchangeRequest	Exchange request
ExchangeRequestProperties	Exchange request properties
ExchangeResponseProperties	Exchange response properties
ExtendedErrorInfo	Extended error information including error code and error message
ExtendedStatusInfo
GetAppliedReservationListOptionalParams	Optional parameters.
GetCatalogNextOptionalParams	Optional parameters.
GetCatalogOptionalParams	Optional parameters.
MergeRequest	The request for reservation merge
Operation	Interface representing a Operation.
OperationDisplay	Information about an operation
OperationList	Paginated list of operations
OperationListNextOptionalParams	Optional parameters.
OperationListOptionalParams	Optional parameters.
OperationResponse	The response containing operation information
OperationResultError	Required if status == failed or status == canceled.
Patch	The request for reservation patch
PatchPropertiesRenewProperties
PaymentDetail	Information about payment related to a reservation order.
Price	Pricing information containing the amount and the currency code
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
PurchaseRequest	The request for reservation purchase
PurchaseRequestPropertiesReservedResourceProperties	Properties specific to each reserved resource type. Not required if not applicable.
Quota	Interface representing a Quota.
QuotaCreateOrUpdateOptionalParams	Optional parameters.
QuotaGetHeaders	Defines headers for Quota_get operation.
QuotaGetOptionalParams	Optional parameters.
QuotaLimits	Quota limits.
QuotaLimitsResponse	Quotas (service limits) in the request response.
QuotaListHeaders	Defines headers for Quota_list operation.
QuotaListNextHeaders	Defines headers for Quota_listNext operation.
QuotaListNextOptionalParams	Optional parameters.
QuotaListOptionalParams	Optional parameters.
QuotaProperties	Quota properties for the resource.
QuotaRequestDetails	Quota request details.
QuotaRequestDetailsList	Quota request details.
QuotaRequestOneResourceSubmitResponse	Response for the quota submission request.
QuotaRequestProperties	The details of quota request.
QuotaRequestStatus	Interface representing a QuotaRequestStatus.
QuotaRequestStatusGetOptionalParams	Optional parameters.
QuotaRequestStatusListNextOptionalParams	Optional parameters.
QuotaRequestStatusListOptionalParams	Optional parameters.
QuotaRequestSubmitResponse	Response for the quota submission request.
QuotaRequestSubmitResponse201	Response with request ID that the quota request was accepted.
QuotaUpdateOptionalParams	Optional parameters.
RefundBillingInformation	billing information
RefundPolicyError	error details
RefundPolicyResult	Refund policy result
RefundPolicyResultProperty	Refund policy result property
RefundRequest	Request containing information needed for returning reservation.
RefundRequestProperties	Properties needed for refund request including the session id from calculate refund, the scope, the reservation to be returned and the return reason.
RefundResponse	The response of refund request containing refund information of reservation
RefundResponseProperties	The refund properties of reservation
RenewPropertiesResponse	The renew properties for a reservation.
RenewPropertiesResponseBillingCurrencyTotal	Currency and amount that customer will be charged in customer's local currency for renewal purchase. Tax is not included.
RenewPropertiesResponsePricingCurrencyTotal	Amount that Microsoft uses for record. Used during refund for calculating refund limit. Tax is not included. This is locked price 30 days before expiry.
Reservation	Interface representing a Reservation.
ReservationArchiveOptionalParams	Optional parameters.
ReservationAvailableScopesOptionalParams	Optional parameters.
ReservationGetOptionalParams	Optional parameters.
ReservationList	List of Reservations
ReservationListAllNextOptionalParams	Optional parameters.
ReservationListAllOptionalParams	Optional parameters.
ReservationListNextOptionalParams	Optional parameters.
ReservationListOptionalParams	Optional parameters.
ReservationListRevisionsNextOptionalParams	Optional parameters.
ReservationListRevisionsOptionalParams	Optional parameters.
ReservationMergeHeaders	Defines headers for Reservation_merge operation.
ReservationMergeOptionalParams	Optional parameters.
ReservationMergeProperties	Properties of reservation merge
ReservationOrder	Interface representing a ReservationOrder.
ReservationOrderBillingPlanInformation	Information describing the type of billing plan for this reservation.
ReservationOrderCalculateOptionalParams	Optional parameters.
ReservationOrderChangeDirectoryOptionalParams	Optional parameters.
ReservationOrderGetOptionalParams	Optional parameters.
ReservationOrderList	List of ReservationOrders
ReservationOrderListNextOptionalParams	Optional parameters.
ReservationOrderListOptionalParams	Optional parameters.
ReservationOrderPurchaseHeaders	Defines headers for ReservationOrder_purchase operation.
ReservationOrderPurchaseOptionalParams	Optional parameters.
ReservationOrderResponse	Details of a reservation order being returned.
ReservationResponse	The definition of the reservation.
ReservationSplitHeaders	Defines headers for Reservation_split operation.
ReservationSplitOptionalParams	Optional parameters.
ReservationSplitProperties	Properties of reservation split
ReservationSummary	The roll up count summary of reservations in each state
ReservationSwapProperties	Properties of reservation swap
ReservationToExchange	Reservation refund details
ReservationToPurchaseCalculateExchange	Reservation purchase details
ReservationToPurchaseExchange	Reservation purchase details
ReservationToReturn	Reservation to return
ReservationToReturnForExchange	Reservation refund details
ReservationUnarchiveOptionalParams	Optional parameters.
ReservationUpdateHeaders	Defines headers for Reservation_update operation.
ReservationUpdateOptionalParams	Optional parameters.
ReservationUtilizationAggregates	The aggregate values of reservation utilization
ReservationsListResult	The list of reservations and summary of roll out count of reservations in each state.
ReservationsProperties	The properties of the reservations
ReservationsPropertiesUtilization	Reservation utilization
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
ResourceName	Resource name provided by the resource provider. Use this property for quotaRequest parameter.
Return	Interface representing a Return.
ReturnPostHeaders	Defines headers for Return_post operation.
ReturnPostOptionalParams	Optional parameters.
SavingsPlanPurchaseRequest	Request body for savings plan purchase
SavingsPlanToPurchaseCalculateExchange	Savings plan purchase details
SavingsPlanToPurchaseExchange	Savings plan purchase details
ScopeProperties	The scope and whether it is valid.
ServiceError	The API error details.
ServiceErrorDetail	The error details.
SkuCapability	Capability of a sku.
SkuName	The name of sku
SkuProperty	Property of a sku.
SkuRestriction	Restriction of a sku.
SplitRequest	The request for reservation split
SubRequest	The sub-request submitted with the quota request.
SubscriptionScopeProperties	The scopes checked by the available scope api.
SystemData	Metadata pertaining to creation and last modification of the resource.

Type Aliases

AppliedScopeType	Defines values for AppliedScopeType. KnownAppliedScopeType can be used interchangeably with AppliedScopeType, this enum contains the known values that the service supports. Known values supported by the service Single Shared ManagementGroup
BillingPlan	Defines values for BillingPlan. KnownBillingPlan can be used interchangeably with BillingPlan, this enum contains the known values that the service supports. Known values supported by the service P1M
CalculateExchangeOperationResultStatus	Defines values for CalculateExchangeOperationResultStatus. KnownCalculateExchangeOperationResultStatus can be used interchangeably with CalculateExchangeOperationResultStatus, this enum contains the known values that the service supports. Known values supported by the service Succeeded Failed Cancelled Pending
CalculateExchangePostResponse	Contains response data for the post operation.
CalculateRefundPostResponse	Contains response data for the post operation.
CommitmentGrain	Defines values for CommitmentGrain. KnownCommitmentGrain can be used interchangeably with CommitmentGrain, this enum contains the known values that the service supports. Known values supported by the service Hourly
CreatedByType	Defines values for CreatedByType. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User Application ManagedIdentity Key
DisplayProvisioningState	Defines values for DisplayProvisioningState. KnownDisplayProvisioningState can be used interchangeably with DisplayProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Succeeded Expiring Expired Pending Processing Cancelled Failed Warning NoBenefit
ErrorResponseCode	Defines values for ErrorResponseCode. KnownErrorResponseCode can be used interchangeably with ErrorResponseCode, this enum contains the known values that the service supports. Known values supported by the service NotSpecified InternalServerError ServerTimeout AuthorizationFailed BadRequest ClientCertificateThumbprintNotSet InvalidRequestContent OperationFailed HttpMethodNotSupported InvalidRequestUri MissingTenantId InvalidTenantId InvalidReservationOrderId InvalidReservationId ReservationIdNotInReservationOrder ReservationOrderNotFound InvalidSubscriptionId InvalidAccessToken InvalidLocationId UnauthenticatedRequestsThrottled InvalidHealthCheckType Forbidden BillingScopeIdCannotBeChanged AppliedScopesNotAssociatedWithCommerceAccount PatchValuesSameAsExisting RoleAssignmentCreationFailed ReservationOrderCreationFailed ReservationOrderNotEnabled CapacityUpdateScopesFailed UnsupportedReservationTerm ReservationOrderIdAlreadyExists RiskCheckFailed CreateQuoteFailed ActivateQuoteFailed NonsupportedAccountId PaymentInstrumentNotFound MissingAppliedScopesForSingle NoValidReservationsToReRate ReRateOnlyAllowedForEA OperationCannotBePerformedInCurrentState InvalidSingleAppliedScopesCount InvalidFulfillmentRequestParameters NotSupportedCountry InvalidRefundQuantity PurchaseError BillingCustomerInputError BillingPaymentInstrumentSoftError BillingPaymentInstrumentHardError BillingTransientError BillingError FulfillmentConfigurationError FulfillmentOutOfStockError FulfillmentTransientError FulfillmentError CalculatePriceFailed AppliedScopesSameAsExisting SelfServiceRefundNotSupported RefundLimitExceeded
ExchangeOperationResultStatus	Defines values for ExchangeOperationResultStatus. KnownExchangeOperationResultStatus can be used interchangeably with ExchangeOperationResultStatus, this enum contains the known values that the service supports. Known values supported by the service Succeeded Failed Cancelled PendingRefunds PendingPurchases
ExchangePostResponse	Contains response data for the post operation.
GetAppliedReservationListResponse	Contains response data for the getAppliedReservationList operation.
GetCatalogNextResponse	Contains response data for the getCatalogNext operation.
GetCatalogResponse	Contains response data for the getCatalog operation.
InstanceFlexibility	Defines values for InstanceFlexibility. KnownInstanceFlexibility can be used interchangeably with InstanceFlexibility, this enum contains the known values that the service supports. Known values supported by the service On Off
Location	Defines values for Location. KnownLocation can be used interchangeably with Location, this enum contains the known values that the service supports. Known values supported by the service westus eastus eastus2 northcentralus westus2 southcentralus centralus westeurope northeurope eastasia southeastasia japaneast japanwest brazilsouth australiaeast australiasoutheast southindia westindia centralindia canadacentral canadaeast uksouth westcentralus ukwest
OperationListNextResponse	Contains response data for the listNext operation.
OperationListResponse	Contains response data for the list operation.
OperationStatus	Defines values for OperationStatus. KnownOperationStatus can be used interchangeably with OperationStatus, this enum contains the known values that the service supports. Known values supported by the service Succeeded Failed Cancelled Pending
PaymentStatus	Defines values for PaymentStatus. KnownPaymentStatus can be used interchangeably with PaymentStatus, this enum contains the known values that the service supports. Known values supported by the service Succeeded Failed Scheduled Cancelled
ProvisioningState	Defines values for ProvisioningState. KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Creating PendingResourceHold ConfirmedResourceHold PendingBilling ConfirmedBilling Created Succeeded Cancelled Expired BillingFailed Failed Split Merged
QuotaCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
QuotaGetResponse	Contains response data for the get operation.
QuotaListNextResponse	Contains response data for the listNext operation.
QuotaListResponse	Contains response data for the list operation.
QuotaRequestState	Defines values for QuotaRequestState. KnownQuotaRequestState can be used interchangeably with QuotaRequestState, this enum contains the known values that the service supports. Known values supported by the service Accepted Invalid Succeeded Failed InProgress
QuotaRequestStatusGetResponse	Contains response data for the get operation.
QuotaRequestStatusListNextResponse	Contains response data for the listNext operation.
QuotaRequestStatusListResponse	Contains response data for the list operation.
QuotaUpdateResponse	Contains response data for the update operation.
ReservationAvailableScopesResponse	Contains response data for the availableScopes operation.
ReservationBillingPlan	Defines values for ReservationBillingPlan. KnownReservationBillingPlan can be used interchangeably with ReservationBillingPlan, this enum contains the known values that the service supports. Known values supported by the service Upfront Monthly
ReservationGetResponse	Contains response data for the get operation.
ReservationListAllNextResponse	Contains response data for the listAllNext operation.
ReservationListAllResponse	Contains response data for the listAll operation.
ReservationListNextResponse	Contains response data for the listNext operation.
ReservationListResponse	Contains response data for the list operation.
ReservationListRevisionsNextResponse	Contains response data for the listRevisionsNext operation.
ReservationListRevisionsResponse	Contains response data for the listRevisions operation.
ReservationMergeResponse	Contains response data for the merge operation.
ReservationOrderCalculateResponse	Contains response data for the calculate operation.
ReservationOrderChangeDirectoryResponse	Contains response data for the changeDirectory operation.
ReservationOrderGetResponse	Contains response data for the get operation.
ReservationOrderListNextResponse	Contains response data for the listNext operation.
ReservationOrderListResponse	Contains response data for the list operation.
ReservationOrderPurchaseResponse	Contains response data for the purchase operation.
ReservationSplitResponse	Contains response data for the split operation.
ReservationStatusCode	Defines values for ReservationStatusCode. KnownReservationStatusCode can be used interchangeably with ReservationStatusCode, this enum contains the known values that the service supports. Known values supported by the service None Pending Processing Active PurchaseError PaymentInstrumentError Split Merged Expired Succeeded
ReservationTerm	Defines values for ReservationTerm. KnownReservationTerm can be used interchangeably with ReservationTerm, this enum contains the known values that the service supports. Known values supported by the service P1Y P3Y P5Y
ReservationUpdateResponse	Contains response data for the update operation.
ReservedResourceType	Defines values for ReservedResourceType. KnownReservedResourceType can be used interchangeably with ReservedResourceType, this enum contains the known values that the service supports. Known values supported by the service VirtualMachines SqlDatabases SuseLinux CosmosDb RedHat SqlDataWarehouse VMwareCloudSimple RedHatOsa Databricks AppService ManagedDisk BlockBlob RedisCache AzureDataExplorer MySql MariaDb PostgreSql DedicatedHost SapHana SqlAzureHybridBenefit AVS DataFactory NetAppStorage AzureFiles SqlEdge VirtualMachineSoftware
ResourceType	Defines values for ResourceType. KnownResourceType can be used interchangeably with ResourceType, this enum contains the known values that the service supports. Known values supported by the service standard dedicated lowPriority shared serviceSpecific
ReturnPostResponse	Contains response data for the post operation.
SavingsPlanTerm	Defines values for SavingsPlanTerm. KnownSavingsPlanTerm can be used interchangeably with SavingsPlanTerm, this enum contains the known values that the service supports. Known values supported by the service P1Y P3Y
UserFriendlyAppliedScopeType	Defines values for UserFriendlyAppliedScopeType. KnownUserFriendlyAppliedScopeType can be used interchangeably with UserFriendlyAppliedScopeType, this enum contains the known values that the service supports. Known values supported by the service None Shared Single ResourceGroup ManagementGroup
UserFriendlyRenewState	Defines values for UserFriendlyRenewState. KnownUserFriendlyRenewState can be used interchangeably with UserFriendlyRenewState, this enum contains the known values that the service supports. Known values supported by the service On Off Renewed NotRenewed NotApplicable

Enums

KnownAppliedScopeType	Known values of AppliedScopeType that the service accepts.
KnownBillingPlan	Known values of BillingPlan that the service accepts.
KnownCalculateExchangeOperationResultStatus	Known values of CalculateExchangeOperationResultStatus that the service accepts.
KnownCommitmentGrain	Known values of CommitmentGrain that the service accepts.
KnownCreatedByType	Known values of CreatedByType that the service accepts.
KnownDisplayProvisioningState	Known values of DisplayProvisioningState that the service accepts.
KnownErrorResponseCode	Known values of ErrorResponseCode that the service accepts.
KnownExchangeOperationResultStatus	Known values of ExchangeOperationResultStatus that the service accepts.
KnownInstanceFlexibility	Known values of InstanceFlexibility that the service accepts.
KnownLocation	Known values of Location that the service accepts.
KnownOperationStatus	Known values of OperationStatus that the service accepts.
KnownPaymentStatus	Known values of PaymentStatus that the service accepts.
KnownProvisioningState	Known values of ProvisioningState that the service accepts.
KnownQuotaRequestState	Known values of QuotaRequestState that the service accepts.
KnownReservationBillingPlan	Known values of ReservationBillingPlan that the service accepts.
KnownReservationStatusCode	Known values of ReservationStatusCode that the service accepts.
KnownReservationTerm	Known values of ReservationTerm that the service accepts.
KnownReservedResourceType	Known values of ReservedResourceType that the service accepts.
KnownResourceType	Known values of ResourceType that the service accepts.
KnownSavingsPlanTerm	Known values of SavingsPlanTerm that the service accepts.
KnownUserFriendlyAppliedScopeType	Known values of UserFriendlyAppliedScopeType that the service accepts.
KnownUserFriendlyRenewState	Known values of UserFriendlyRenewState that the service accepts.

Functions

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

Function Details

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

An object from accessing value on the IteratorResult from a byPage iterator.

Returns

string | undefined

The continuation token that can be passed into byPage() during future calls.