@azure/arm-reservations package

Paginated list of applied reservations

The response for applied reservations api

Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup

The response of available scope api containing scopes and their eligibilities.

Available scope

Available scope request properties

Optional parameters.

billing information

Interface representing a CalculateExchange.

CalculateExchange operation result

Defines headers for CalculateExchange_post operation.

Optional parameters.

Calculate exchange request

Calculate exchange request properties

CalculateExchange response properties

The response of calculate price for reservation.

Properties for calculate price response

Currency and amount that customer will be charged in customer's local currency. Tax is not included.

Amount that Microsoft uses for record. Used during refund for calculating refund limit. Tax is not included.

Interface representing a CalculateRefund.

Optional parameters.

Request containing information needed for calculating refund.

Properties needed for calculate refund including the scope and the reservation to be returned.

The response of calculate refund containing refund information of reservation

Product details of a type of resource.

Pricing information about the sku

The list of catalogs and pagination information.

Request body for change directory of a reservation.

Change directory response

Change directory result for reservation order or reservation

Commitment towards the benefit.

Quota change requests information.

Current quota limits.

Quota properties.

The details of the error.

Error information

Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.

The API error.

Interface representing a Exchange.

Exchange operation result

error details

Exchange policy errors

Defines headers for Exchange_post operation.

Optional parameters.

Exchange request

Exchange request properties

Exchange response properties

Extended error information including error code and error message

Optional parameters.

Optional parameters.

Optional parameters.

The request for reservation merge

Interface representing a Operation.

Information about an operation

Paginated list of operations

Optional parameters.

Optional parameters.

The response containing operation information

Required if status == failed or status == canceled.

The request for reservation patch

Information about payment related to a reservation order.

Pricing information containing the amount and the currency code

The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location

The request for reservation purchase

Properties specific to each reserved resource type. Not required if not applicable.

Interface representing a Quota.

Optional parameters.

Defines headers for Quota_get operation.

Optional parameters.

Quota limits.

Quotas (service limits) in the request response.

Defines headers for Quota_list operation.

Defines headers for Quota_listNext operation.

Optional parameters.

Optional parameters.

Quota properties for the resource.

Quota request details.

Quota request details.

Response for the quota submission request.

The details of quota request.

Interface representing a QuotaRequestStatus.

Optional parameters.

Optional parameters.

Optional parameters.

Response for the quota submission request.

Response with request ID that the quota request was accepted.

Optional parameters.

billing information

error details

Refund policy result

Refund policy result property

Request containing information needed for returning reservation.

Properties needed for refund request including the session id from calculate refund, the scope, the reservation to be returned and the return reason.

The response of refund request containing refund information of reservation

The refund properties of reservation

The renew properties for a reservation.

Currency and amount that customer will be charged in customer's local currency for renewal purchase. Tax is not included.

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.

Interface representing a Reservation.

Optional parameters.

Optional parameters.

Optional parameters.

List of Reservations

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Defines headers for Reservation_merge operation.

Optional parameters.

Properties of reservation merge

Interface representing a ReservationOrder.

Information describing the type of billing plan for this reservation.

Optional parameters.

Optional parameters.

Optional parameters.

List of ReservationOrders

Optional parameters.

Optional parameters.

Defines headers for ReservationOrder_purchase operation.

Optional parameters.

Details of a reservation order being returned.

The definition of the reservation.

Defines headers for Reservation_split operation.

Optional parameters.

Properties of reservation split

The roll up count summary of reservations in each state

Properties of reservation swap

Reservation refund details

Reservation purchase details

Reservation purchase details

Reservation to return

Reservation refund details

Optional parameters.

Defines headers for Reservation_update operation.

Optional parameters.

The aggregate values of reservation utilization

The list of reservations and summary of roll out count of reservations in each state.

The properties of the reservations

Reservation utilization

Common fields that are returned in the response for all Azure Resource Manager resources

Resource name provided by the resource provider. Use this property for quotaRequest parameter.

Interface representing a Return.

Defines headers for Return_post operation.

Optional parameters.

Request body for savings plan purchase

Savings plan purchase details

Savings plan purchase details

The scope and whether it is valid.

The API error details.

The error details.

Capability of a sku.

The name of sku

Property of a sku.

Restriction of a sku.

The request for reservation split

The sub-request submitted with the quota request.

The scopes checked by the available scope api.

Metadata pertaining to creation and last modification of the resource.

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

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

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

Contains response data for the post operation.

Contains response data for the post operation.

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

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

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

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

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

Contains response data for the post operation.

Contains response data for the getAppliedReservationList operation.

Contains response data for the getCatalogNext operation.

Contains response data for the getCatalog operation.

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

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

Contains response data for the listNext operation.

Contains response data for the list operation.

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

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

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

Contains response data for the createOrUpdate operation.

Contains response data for the get operation.

Contains response data for the listNext operation.

Contains response data for the list operation.

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

Contains response data for the get operation.

Contains response data for the listNext operation.

Contains response data for the list operation.

Contains response data for the update operation.

Contains response data for the availableScopes operation.

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

Contains response data for the get operation.

Contains response data for the listAllNext operation.

Contains response data for the listAll operation.

Contains response data for the listNext operation.

Contains response data for the list operation.

Contains response data for the listRevisionsNext operation.

Contains response data for the listRevisions operation.

Contains response data for the merge operation.

Contains response data for the calculate operation.

Contains response data for the changeDirectory operation.

Contains response data for the get operation.

Contains response data for the listNext operation.

Contains response data for the list operation.

Contains response data for the purchase operation.

Contains response data for the split operation.

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

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

Contains response data for the update operation.

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

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

Contains response data for the post operation.

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

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

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

Known values of AppliedScopeType that the service accepts.

Known values of BillingPlan that the service accepts.

Known values of CalculateExchangeOperationResultStatus that the service accepts.

Known values of CommitmentGrain that the service accepts.

Known values of CreatedByType that the service accepts.

Known values of DisplayProvisioningState that the service accepts.

Known values of ErrorResponseCode that the service accepts.

Known values of ExchangeOperationResultStatus that the service accepts.

Known values of InstanceFlexibility that the service accepts.

Known values of Location that the service accepts.

Known values of OperationStatus that the service accepts.

Known values of PaymentStatus that the service accepts.

Known values of ProvisioningState that the service accepts.

Known values of QuotaRequestState that the service accepts.

Known values of ReservationBillingPlan that the service accepts.

Known values of ReservationStatusCode that the service accepts.

Known values of ReservationTerm that the service accepts.

Known values of ReservedResourceType that the service accepts.

Known values of ResourceType that the service accepts.

Known values of SavingsPlanTerm that the service accepts.

Known values of UserFriendlyAppliedScopeType that the service accepts.

Known values of UserFriendlyRenewState that the service accepts.

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