@azure/arm-reservations package

Paginated list of applied reservations

The response for applied reservations api

Properties for applied reservations returned

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 for the client.

billing information

CalculateExchange operation result

Interface representing a CalculateExchange operations.

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 operations.

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

Request body for change directory of a reservation.

Change directory response

Change directory result for reservation order or reservation

Commitment towards the benefit.

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.

Exchange operation result

Interface representing a Exchange operations.

error details

Exchange policy errors

Optional parameters.

Exchange request

Exchange request properties

Exchange response properties

Extended error information including error code and error message

model interface ExtendedStatusInfo

Optional parameters.

Optional parameters.

Properties for reservation merge

The request for reservation merge

Information about an operation

Optional parameters.

Interface representing a Operation operations.

The response containing operation information

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

Options for the byPage method

An interface that allows async iterable iteration both to completion and by page.

The request for reservation patch

Properties for reservation patch

model interface PatchPropertiesRenewProperties

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 of reservation purchase request

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

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a Quota operations.

Quota properties for the resource.

Quota request details.

The details of quota request.

Optional parameters.

Optional parameters.

Interface representing a QuotaRequestStatus operations.

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 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.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Properties of reservation merge

Interface representing a Reservation operations.

Information describing the type of billing plan for this reservation.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a ReservationOrder operations.

Properties of a reservation order.

Optional parameters.

Details of a reservation order being returned.

The definition of the reservation.

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.

Optional parameters.

The aggregate values of reservation utilization

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 operations.

Optional parameters.

Request body for savings plan purchase

Properties of a 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.

A simple poller that can be used to poll a long running operation.

Capability of a sku.

The name of sku

Property of a sku.

Restriction of a sku.

Properties for reservation split

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.

Type of the Applied Scope.
KnownAppliedScopeType can be used interchangeably with AppliedScopeType, this enum contains the known values that the service supports.

Known values supported by the service

Single: Single
Shared: Shared
ManagementGroup: ManagementGroup

The supported values for cloud setting as a string literal type

Represents the billing plan in ISO 8601 format. Required only for monthly billing plans.
KnownBillingPlan can be used interchangeably with BillingPlan, this enum contains the known values that the service supports.

Known values supported by the service

P1M: P1M

Status of the operation.
KnownCalculateExchangeOperationResultStatus can be used interchangeably with CalculateExchangeOperationResultStatus, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded: Succeeded
Failed: Failed
Cancelled: Cancelled
Pending: Pending

Commitment grain.
KnownCommitmentGrain can be used interchangeably with CommitmentGrain, this enum contains the known values that the service supports.

Known values supported by the service

Hourly: Hourly

An interface that describes a page of results.

The kind of entity that created the resource.
KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports.

Known values supported by the service

User: The entity was created by a user.
Application: The entity was created by an application.
ManagedIdentity: The entity was created by a managed identity.
Key: The entity was created by a key.

Error code describing the reason that service is not able to process the incoming request
KnownErrorResponseCode can be used interchangeably with ErrorResponseCode, this enum contains the known values that the service supports.

Known values supported by the service

NotSpecified: NotSpecified
InternalServerError: InternalServerError
ServerTimeout: ServerTimeout
AuthorizationFailed: AuthorizationFailed
BadRequest: BadRequest
ClientCertificateThumbprintNotSet: ClientCertificateThumbprintNotSet
InvalidRequestContent: InvalidRequestContent
OperationFailed: OperationFailed
HttpMethodNotSupported: HttpMethodNotSupported
InvalidRequestUri: InvalidRequestUri
MissingTenantId: MissingTenantId
InvalidTenantId: InvalidTenantId
InvalidReservationOrderId: InvalidReservationOrderId
InvalidReservationId: InvalidReservationId
ReservationIdNotInReservationOrder: ReservationIdNotInReservationOrder
ReservationOrderNotFound: ReservationOrderNotFound
InvalidSubscriptionId: InvalidSubscriptionId
InvalidAccessToken: InvalidAccessToken
InvalidLocationId: InvalidLocationId
UnauthenticatedRequestsThrottled: UnauthenticatedRequestsThrottled
InvalidHealthCheckType: InvalidHealthCheckType
Forbidden: Forbidden
BillingScopeIdCannotBeChanged: BillingScopeIdCannotBeChanged
AppliedScopesNotAssociatedWithCommerceAccount: AppliedScopesNotAssociatedWithCommerceAccount
PatchValuesSameAsExisting: PatchValuesSameAsExisting
RoleAssignmentCreationFailed: RoleAssignmentCreationFailed
ReservationOrderCreationFailed: ReservationOrderCreationFailed
ReservationOrderNotEnabled: ReservationOrderNotEnabled
CapacityUpdateScopesFailed: CapacityUpdateScopesFailed
UnsupportedReservationTerm: UnsupportedReservationTerm
ReservationOrderIdAlreadyExists: ReservationOrderIdAlreadyExists
RiskCheckFailed: RiskCheckFailed
CreateQuoteFailed: CreateQuoteFailed
ActivateQuoteFailed: ActivateQuoteFailed
NonsupportedAccountId: NonsupportedAccountId
PaymentInstrumentNotFound: PaymentInstrumentNotFound
MissingAppliedScopesForSingle: MissingAppliedScopesForSingle
NoValidReservationsToReRate: NoValidReservationsToReRate
ReRateOnlyAllowedForEA: ReRateOnlyAllowedForEA
OperationCannotBePerformedInCurrentState: OperationCannotBePerformedInCurrentState
InvalidSingleAppliedScopesCount: InvalidSingleAppliedScopesCount
InvalidFulfillmentRequestParameters: InvalidFulfillmentRequestParameters
NotSupportedCountry: NotSupportedCountry
InvalidRefundQuantity: InvalidRefundQuantity
PurchaseError: PurchaseError
BillingCustomerInputError: BillingCustomerInputError
BillingPaymentInstrumentSoftError: BillingPaymentInstrumentSoftError
BillingPaymentInstrumentHardError: BillingPaymentInstrumentHardError
BillingTransientError: BillingTransientError
BillingError: BillingError
FulfillmentConfigurationError: FulfillmentConfigurationError
FulfillmentOutOfStockError: FulfillmentOutOfStockError
FulfillmentTransientError: FulfillmentTransientError
FulfillmentError: FulfillmentError
CalculatePriceFailed: CalculatePriceFailed
AppliedScopesSameAsExisting: AppliedScopesSameAsExisting
SelfServiceRefundNotSupported: SelfServiceRefundNotSupported
RefundLimitExceeded: RefundLimitExceeded

Status of the operation.
KnownExchangeOperationResultStatus can be used interchangeably with ExchangeOperationResultStatus, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded: Succeeded
Failed: Failed
Cancelled: Cancelled
PendingRefunds: PendingRefunds
PendingPurchases: PendingPurchases

Turning this on will apply the reservation discount to other VMs in the same VM size group. Only specify for VirtualMachines reserved resource type.
KnownInstanceFlexibility can be used interchangeably with InstanceFlexibility, this enum contains the known values that the service supports.

Known values supported by the service

On: On
Off: Off

Status of the individual operation.
KnownOperationStatus can be used interchangeably with OperationStatus, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded: Succeeded
Failed: Failed
Cancelled: Cancelled
Pending: Pending

Describes whether the payment is completed, failed, cancelled or scheduled in the future.
KnownPaymentStatus can be used interchangeably with PaymentStatus, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded: Succeeded
Failed: Failed
Scheduled: Scheduled
Cancelled: Cancelled

Represent the current state of the Reservation.
KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Creating: Creating
PendingResourceHold: PendingResourceHold
ConfirmedResourceHold: ConfirmedResourceHold
PendingBilling: PendingBilling
ConfirmedBilling: ConfirmedBilling
Created: Created
Succeeded: Succeeded
Cancelled: Cancelled
Expired: Expired
BillingFailed: BillingFailed
Failed: Failed
Split: Split
Merged: Merged

The quota request status.
KnownQuotaRequestState can be used interchangeably with QuotaRequestState, this enum contains the known values that the service supports.

Known values supported by the service

Accepted: Accepted
Invalid: Invalid
Succeeded: Succeeded
Failed: Failed
InProgress: InProgress

Represent the billing plans.
KnownReservationBillingPlan can be used interchangeably with ReservationBillingPlan, this enum contains the known values that the service supports.

Known values supported by the service

Upfront: Upfront
Monthly: Monthly

Type of ReservationStatusCode

Represent the term of reservation.
KnownReservationTerm can be used interchangeably with ReservationTerm, this enum contains the known values that the service supports.

Known values supported by the service

P1Y: P1Y
P3Y: P3Y
P5Y: P5Y

The type of the resource that is being reserved. In addition to below types we have also added the following: OpenAIPTU, MDC, Sentinel.
KnownReservedResourceType can be used interchangeably with ReservedResourceType, this enum contains the known values that the service supports.

Known values supported by the service

VirtualMachines: VirtualMachines
SqlDatabases: SqlDatabases
SuseLinux: SuseLinux
CosmosDb: CosmosDb
RedHat: RedHat
SqlDataWarehouse: SqlDataWarehouse
VMwareCloudSimple: VMwareCloudSimple
RedHatOsa: RedHatOsa
Databricks: Databricks
AppService: AppService
ManagedDisk: ManagedDisk
BlockBlob: BlockBlob
RedisCache: RedisCache
AzureDataExplorer: AzureDataExplorer
MySql: MySql
MariaDb: MariaDb
PostgreSql: PostgreSql
DedicatedHost: DedicatedHost
SapHana: SapHana
SqlAzureHybridBenefit: SqlAzureHybridBenefit
AVS: AVS
DataFactory: DataFactory
NetAppStorage: NetAppStorage
AzureFiles: AzureFiles
SqlEdge: SqlEdge
VirtualMachineSoftware: VirtualMachineSoftware

The resource types.
KnownResourceType can be used interchangeably with ResourceType, this enum contains the known values that the service supports.

Known values supported by the service

standard: standard
dedicated: dedicated
lowPriority: lowPriority
shared: shared
serviceSpecific: serviceSpecific

Represent savings plan term in ISO 8601 format.
KnownSavingsPlanTerm can be used interchangeably with SavingsPlanTerm, this enum contains the known values that the service supports.

Known values supported by the service

P1Y: P1Y
P3Y: P3Y

An enum to describe Azure Cloud environments.

Type of the Applied Scope.

Represents the billing plan in ISO 8601 format. Required only for monthly billing plans.

Status of the operation.

Commitment grain.

The kind of entity that created the resource.

Error code describing the reason that service is not able to process the incoming request

Status of the operation.

Turning this on will apply the reservation discount to other VMs in the same VM size group. Only specify for VirtualMachines reserved resource type.

Status of the individual operation.

Describes whether the payment is completed, failed, cancelled or scheduled in the future.

Represent the current state of the Reservation.

The quota request status.

Represent the billing plans.

Known values of ReservationStatusCode that the service accepts.

Represent the term of reservation.

The type of the resource that is being reserved. In addition to below types we have also added the following: OpenAIPTU, MDC, Sentinel.

The resource types.

Represent savings plan term in ISO 8601 format.

Typeguard for RestError

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

A custom error type for failed pipeline requests.