Microsoft.Capacity (stable:2022-11-01)

2025/04/30 • 14 updated methods

ReservationOrder_Calculate (updated)
Description :  Calculate price for placing a `ReservationOrder`.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ReservationOrder_Calculate",
  "$parameters": {
    "body": {
      "$properties": {
        "properties": [
          {
            "#name": "reservedResourceType",
            "Description": {
              "new": "The type of the resource that is being reserved. In addition to below types we have also added the following: OpenAIPTU, MDC, Sentinel.",
              "old": "The type of the resource that is being reserved."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /providers/Microsoft.Capacity/calculatePrice
{
api-version:
{
Description: Supported version. ,
Required: True ,
}
string ,
body:
{
Description: Information needed for calculate or purchase reservation ,
Required: True ,
}
{
sku:
{
Description: The name of sku ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
}
,
location:
{
Description: The Azure region where the reserved resource lives. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of reservation purchase request ,
Required: False ,
}
{
reservedResourceType:
{
Description: The type of the resource that is being reserved. In addition to below types we have also added the following: OpenAIPTU, MDC, Sentinel. ,
Enum:
{
VirtualMachines: No description available. ,
SqlDatabases: No description available. ,
SuseLinux: No description available. ,
CosmosDb: No description available. ,
RedHat: No description available. ,
SqlDataWarehouse: No description available. ,
VMwareCloudSimple: No description available. ,
RedHatOsa: No description available. ,
Databricks: No description available. ,
AppService: No description available. ,
ManagedDisk: No description available. ,
BlockBlob: No description available. ,
RedisCache: No description available. ,
AzureDataExplorer: No description available. ,
MySql: No description available. ,
MariaDb: No description available. ,
PostgreSql: No description available. ,
DedicatedHost: No description available. ,
SapHana: No description available. ,
SqlAzureHybridBenefit: No description available. ,
AVS: No description available. ,
DataFactory: No description available. ,
NetAppStorage: No description available. ,
AzureFiles: No description available. ,
SqlEdge: No description available. ,
VirtualMachineSoftware: No description available. ,
}
,
Required: False ,
}
enum ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing reservation or savings plan ,
Required: False ,
}
string ,
term:
{
Description: Represent the term of reservation. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
billingPlan:
{
Description: Represent the billing plans. ,
Enum:
{
Upfront: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
quantity:
{
Description: Quantity of the skus that are part of the reservation. ,
Format: int32 ,
Required: False ,
}
integer ,
displayName:
{
Description: Friendly name of the reservation ,
Required: False ,
}
string ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopes:
{
Description: List of the subscriptions that the benefit will be applied. Do not specify if AppliedScopeType is Shared. This property will be deprecated and replaced by appliedScopeProperties instead for Single AppliedScopeType. ,
Required: False ,
}
[
string ,
]
,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the savings plan should apply benefit. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
renew:
{
Description: Setting this to true will automatically purchase a new reservation on the expiration date time. ,
Required: False ,
}
boolean ,
reservedResourceProperties:
{
Description: Properties specific to each reserved resource type. Not required if not applicable. ,
Required: False ,
}
{
instanceFlexibility:
{
Description: Turning this on will apply the reservation discount to other VMs in the same VM size group. Only specify for VirtualMachines reserved resource type. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
reviewDateTime:
{
Description: This is the date-time when the Azure hybrid benefit needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties for calculate price response ,
Required: False ,
}
{
billingCurrencyTotal:
{
Description: Currency and amount that customer will be charged in customer's local currency. Tax is not included. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Description: Amount in pricing currency. Tax is not included. ,
Format: double ,
Required: False ,
}
number ,
}
,
netTotal:
{
Description: Net total amount in pricing currency. ,
Format: double ,
Required: False ,
}
number ,
taxTotal:
{
Description: Tax amount in pricing currency. ,
Format: double ,
Required: False ,
}
number ,
grandTotal:
{
Description: Total amount in pricing currency. ,
Format: double ,
Required: False ,
}
number ,
isTaxIncluded:
{
Description: Whether or not tax is included in grand total ,
Required: False ,
}
boolean ,
isBillingPartnerManaged:
{
Description: True if billing is managed by Microsoft Partner. Used only for CSP accounts. ,
Required: False ,
}
boolean ,
reservationOrderId:
{
Description: GUID that represents reservation order that can be placed after calculating price. ,
Required: False ,
}
string ,
skuTitle:
{
Description: Title of sku that is being purchased. ,
Required: False ,
}
string ,
skuDescription:
{
Description: Description of sku that is being purchased. ,
Required: False ,
}
string ,
pricingCurrencyTotal:
{
Description: Amount that Microsoft uses for record. Used during refund for calculating refund limit. Tax is not included. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Required: False ,
}
number ,
}
,
paymentSchedule:
{
Required: False ,
}
[
{
dueDate:
{
Description: Date when the payment needs to be done. ,
Format: date ,
Required: False ,
}
string ,
paymentDate:
{
Description: Date when the transaction is completed. Is null when it is scheduled. ,
Format: date ,
Required: False ,
}
string ,
pricingCurrencyTotal:
{
Description: Amount in pricing currency. Tax not included. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
billingCurrencyTotal:
{
Description: Amount charged in Billing currency. Tax not included. Is null for future payments ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
billingAccount:
{
Description: Shows the Account that is charged for this payment. ,
Required: False ,
}
string ,
status:
{
Description: Describes whether the payment is completed, failed, cancelled or scheduled in the future. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Scheduled: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
extendedStatusInfo:
{
Required: False ,
}
{
statusCode:
{
Enum:
{
None: No description available. ,
Pending: No description available. ,
Processing: No description available. ,
Active: No description available. ,
PurchaseError: No description available. ,
PaymentInstrumentError: No description available. ,
Split: No description available. ,
Merged: No description available. ,
Expired: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Extended error information including error code and error message ,
Required: False ,
}
{
code:
{
Description: Error code describing the reason that service is not able to process the incoming request ,
Enum:
{
NotSpecified: No description available. ,
InternalServerError: No description available. ,
ServerTimeout: No description available. ,
AuthorizationFailed: No description available. ,
BadRequest: No description available. ,
ClientCertificateThumbprintNotSet: No description available. ,
InvalidRequestContent: No description available. ,
OperationFailed: No description available. ,
HttpMethodNotSupported: No description available. ,
InvalidRequestUri: No description available. ,
MissingTenantId: No description available. ,
InvalidTenantId: No description available. ,
InvalidReservationOrderId: No description available. ,
InvalidReservationId: No description available. ,
ReservationIdNotInReservationOrder: No description available. ,
ReservationOrderNotFound: No description available. ,
InvalidSubscriptionId: No description available. ,
InvalidAccessToken: No description available. ,
InvalidLocationId: No description available. ,
UnauthenticatedRequestsThrottled: No description available. ,
InvalidHealthCheckType: No description available. ,
Forbidden: No description available. ,
BillingScopeIdCannotBeChanged: No description available. ,
AppliedScopesNotAssociatedWithCommerceAccount: No description available. ,
PatchValuesSameAsExisting: No description available. ,
RoleAssignmentCreationFailed: No description available. ,
ReservationOrderCreationFailed: No description available. ,
ReservationOrderNotEnabled: No description available. ,
CapacityUpdateScopesFailed: No description available. ,
UnsupportedReservationTerm: No description available. ,
ReservationOrderIdAlreadyExists: No description available. ,
RiskCheckFailed: No description available. ,
CreateQuoteFailed: No description available. ,
ActivateQuoteFailed: No description available. ,
NonsupportedAccountId: No description available. ,
PaymentInstrumentNotFound: No description available. ,
MissingAppliedScopesForSingle: No description available. ,
NoValidReservationsToReRate: No description available. ,
ReRateOnlyAllowedForEA: No description available. ,
OperationCannotBePerformedInCurrentState: No description available. ,
InvalidSingleAppliedScopesCount: No description available. ,
InvalidFulfillmentRequestParameters: No description available. ,
NotSupportedCountry: No description available. ,
InvalidRefundQuantity: No description available. ,
PurchaseError: No description available. ,
BillingCustomerInputError: No description available. ,
BillingPaymentInstrumentSoftError: No description available. ,
BillingPaymentInstrumentHardError: No description available. ,
BillingTransientError: No description available. ,
BillingError: No description available. ,
FulfillmentConfigurationError: No description available. ,
FulfillmentOutOfStockError: No description available. ,
FulfillmentTransientError: No description available. ,
FulfillmentError: No description available. ,
CalculatePriceFailed: No description available. ,
AppliedScopesSameAsExisting: No description available. ,
SelfServiceRefundNotSupported: No description available. ,
RefundLimitExceeded: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Required: False ,
}
string ,
}
,
}
ReservationOrder_List (updated)
Description :  List of all the `ReservationOrder`s that the user has access to in the current tenant.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ReservationOrder_List",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "reservations": {
                  "$properties": {
                    "properties": [
                      {
                        "renewProperties": [
                          {
                            "purchaseProperties": [
                              {
                                "properties": [
                                  {
                                    "#name": "reservedResourceType",
                                    "Description": {
                                      "new": "The type of the resource that is being reserved. In addition to below types we have also added the following: OpenAIPTU, MDC, Sentinel.",
                                      "old": "The type of the resource that is being reserved."
                                    }
                                  }
                                ]
                              }
                            ]
                          }
                        ]
                      }
                    ]
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /providers/Microsoft.Capacity/reservationOrders
{
api-version:
{
Description: Supported version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
etag:
{
Format: int32 ,
Required: False ,
}
integer ,
id:
{
Description: Identifier of the reservation ,
Required: False ,
}
string ,
name:
{
Description: Name of the reservation ,
Required: False ,
}
string ,
properties:
{
Description: Properties of a reservation order. ,
Required: False ,
}
{
displayName:
{
Description: Friendly name for user to easily identified the reservation. ,
Required: False ,
}
string ,
requestDateTime:
{
Description: This is the DateTime when the reservation was initially requested for purchase. ,
Format: date-time ,
Required: False ,
}
string ,
createdDateTime:
{
Description: This is the DateTime when the reservation was created. ,
Format: date-time ,
Required: False ,
}
string ,
expiryDate:
{
Description: This is the date when the reservation will expire. ,
Format: date ,
Required: False ,
}
string ,
expiryDateTime:
{
Description: This is the date-time when the reservation will expire. ,
Format: date-time ,
Required: False ,
}
string ,
benefitStartTime:
{
Description: This is the DateTime when the reservation benefit started. ,
Format: date-time ,
Required: False ,
}
string ,
originalQuantity:
{
Description: Total Quantity of the skus purchased in the reservation. ,
Format: int32 ,
Required: False ,
}
integer ,
term:
{
Description: Represent the term of reservation. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Current state of the reservation. ,
Enum:
{
Creating: No description available. ,
PendingResourceHold: No description available. ,
ConfirmedResourceHold: No description available. ,
PendingBilling: No description available. ,
ConfirmedBilling: No description available. ,
Created: No description available. ,
Succeeded: No description available. ,
Cancelled: No description available. ,
Expired: No description available. ,
BillingFailed: No description available. ,
Failed: No description available. ,
Split: No description available. ,
Merged: No description available. ,
}
,
Required: False ,
}
enum ,
billingPlan:
{
Description: Represent the billing plans. ,
Enum:
{
Upfront: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
planInformation:
{
Description: Information describing the type of billing plan for this reservation. ,
Required: False ,
}
{
pricingCurrencyTotal:
{
Description: Amount of money to be paid for the Order. Tax is not included. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
startDate:
{
Description: Date when the billing plan has started. ,
Format: date ,
Required: False ,
}
string ,
nextPaymentDueDate:
{
Description: For recurring billing plans, indicates the date when next payment will be processed. Null when total is paid off. ,
Format: date ,
Required: False ,
}
string ,
transactions:
{
Required: False ,
}
[
{
dueDate:
{
Description: Date when the payment needs to be done. ,
Format: date ,
Required: False ,
}
string ,
paymentDate:
{
Description: Date when the transaction is completed. Is null when it is scheduled. ,
Format: date ,
Required: False ,
}
string ,
pricingCurrencyTotal:
{
Description: Amount in pricing currency. Tax not included. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
billingCurrencyTotal:
{
Description: Amount charged in Billing currency. Tax not included. Is null for future payments ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
billingAccount:
{
Description: Shows the Account that is charged for this payment. ,
Required: False ,
}
string ,
status:
{
Description: Describes whether the payment is completed, failed, cancelled or scheduled in the future. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Scheduled: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
extendedStatusInfo:
{
Required: False ,
}
{
statusCode:
{
Enum:
{
None: No description available. ,
Pending: No description available. ,
Processing: No description available. ,
Active: No description available. ,
PurchaseError: No description available. ,
PaymentInstrumentError: No description available. ,
Split: No description available. ,
Merged: No description available. ,
Expired: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
reservations:
{
Required: False ,
}
[
{
location:
{
Description: The Azure region where the reserved resource lives. ,
Required: False ,
}
string ,
etag:
{
Format: int32 ,
Required: False ,
}
integer ,
sku:
{
Description: The sku information associated to this reservation ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties associated to this reservation ,
Required: False ,
}
{
reservedResourceType:
{
Description: The type of the resource that is being reserved. ,
Enum:
{
VirtualMachines: No description available. ,
SqlDatabases: No description available. ,
SuseLinux: No description available. ,
CosmosDb: No description available. ,
RedHat: No description available. ,
SqlDataWarehouse: No description available. ,
VMwareCloudSimple: No description available. ,
RedHatOsa: No description available. ,
Databricks: No description available. ,
AppService: No description available. ,
ManagedDisk: No description available. ,
BlockBlob: No description available. ,
RedisCache: No description available. ,
AzureDataExplorer: No description available. ,
MySql: No description available. ,
MariaDb: No description available. ,
PostgreSql: No description available. ,
DedicatedHost: No description available. ,
SapHana: No description available. ,
SqlAzureHybridBenefit: No description available. ,
AVS: No description available. ,
DataFactory: No description available. ,
NetAppStorage: No description available. ,
AzureFiles: No description available. ,
SqlEdge: No description available. ,
VirtualMachineSoftware: No description available. ,
}
,
Required: False ,
}
enum ,
instanceFlexibility:
{
Description: Allows reservation discount to be applied across skus within the same auto fit group. Not all skus support instance size flexibility. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Friendly name for user to easily identify the reservation ,
Required: False ,
}
string ,
appliedScopes:
{
Description: The list of applied scopes ,
Required: False ,
}
[
string ,
]
,
appliedScopeType:
{
Description: The applied scope type ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
archived:
{
Description: Indicates if the reservation is archived ,
Required: False ,
}
boolean ,
capabilities:
{
Description: Capabilities of the reservation ,
Required: False ,
}
string ,
quantity:
{
Description: Quantity of the skus that are part of the reservation. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: Current state of the reservation. ,
Enum:
{
Creating: No description available. ,
PendingResourceHold: No description available. ,
ConfirmedResourceHold: No description available. ,
PendingBilling: No description available. ,
ConfirmedBilling: No description available. ,
Created: No description available. ,
Succeeded: No description available. ,
Cancelled: No description available. ,
Expired: No description available. ,
BillingFailed: No description available. ,
Failed: No description available. ,
Split: No description available. ,
Merged: No description available. ,
}
,
Required: False ,
}
enum ,
effectiveDateTime:
{
Description: DateTime of the reservation starting when this version is effective from. ,
Format: date-time ,
Required: False ,
}
string ,
benefitStartTime:
{
Description: This is the DateTime when the reservation benefit started. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedDateTime:
{
Description: DateTime of the last time the reservation was updated. ,
Format: date-time ,
Required: False ,
}
string ,
expiryDate:
{
Description: This is the date when the reservation will expire. ,
Format: date ,
Required: False ,
}
string ,
expiryDateTime:
{
Description: This is the date-time when the reservation will expire. ,
Format: date-time ,
Required: False ,
}
string ,
reviewDateTime:
{
Description: This is the date-time when the Azure Hybrid Benefit needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
skuDescription:
{
Description: Description of the sku in english. ,
Required: False ,
}
string ,
extendedStatusInfo:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
{
statusCode:
{
Enum:
{
None: No description available. ,
Pending: No description available. ,
Processing: No description available. ,
Active: No description available. ,
PurchaseError: No description available. ,
PaymentInstrumentError: No description available. ,
Split: No description available. ,
Merged: No description available. ,
Expired: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
string ,
}
,
billingPlan:
{
Description: The billing plan options available for this sku. ,
Enum:
{
Upfront: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
displayProvisioningState:
{
Description: The provisioning state of the reservation for display, e.g. Succeeded ,
Required: False ,
}
string ,
provisioningSubState:
{
Description: The provisioning sub-state of the reservation, e.g. Succeeded ,
Required: False ,
}
string ,
purchaseDate:
{
Description: This is the date when the reservation was purchased. ,
Format: date ,
Required: False ,
}
string ,
purchaseDateTime:
{
Description: This is the date-time when the reservation was purchased. ,
Format: date-time ,
Required: False ,
}
string ,
splitProperties:
{
Description: Properties of reservation split ,
Required: False ,
}
{
splitDestinations:
{
Description: List of destination resource id that are created due to split. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
[
string ,
]
,
splitSource:
{
Description: Resource id of the reservation from which this is split. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
}
,
mergeProperties:
{
Description: Properties of reservation merge ,
Required: False ,
}
{
mergeDestination:
{
Description: Reservation resource id Created due to the merge. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
mergeSources:
{
Description: Resource ids of the source reservation's merged to form this reservation. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
[
string ,
]
,
}
,
swapProperties:
{
Description: Properties of reservation swap ,
Required: False ,
}
{
swapSource:
{
Description: Resource id of the source reservation that gets swapped. Format of the resource id is /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
swapDestination:
{
Description: Reservation resource id that the original resource gets swapped to. Format of the resource id is /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
}
,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the savings plan should apply benefit. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
billingScopeId:
{
Description: Subscription that will be charged for purchasing reservation or savings plan ,
Required: False ,
}
string ,
renew:
{
Description: Setting this to true will automatically purchase a new reservation on the expiration date time. ,
Required: False ,
}
boolean ,
renewSource:
{
Description: Reservation Id of the reservation from which this reservation is renewed. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}. ,
Required: False ,
}
string ,
renewDestination:
{
Description: Reservation Id of the reservation which is purchased because of renew. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}. ,
Required: False ,
}
string ,
renewProperties:
{
Description: The renew properties for a reservation. ,
Required: False ,
}
{
purchaseProperties:
{
Description: The request for reservation purchase ,
Required: False ,
}
{
sku:
{
Description: The name of sku ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
}
,
location:
{
Description: The Azure region where the reserved resource lives. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of reservation purchase request ,
Required: False ,
}
{
reservedResourceType:
{
Description: The type of the resource that is being reserved. In addition to below types we have also added the following: OpenAIPTU, MDC, Sentinel. ,
Enum:
{
VirtualMachines: No description available. ,
SqlDatabases: No description available. ,
SuseLinux: No description available. ,
CosmosDb: No description available. ,
RedHat: No description available. ,
SqlDataWarehouse: No description available. ,
VMwareCloudSimple: No description available. ,
RedHatOsa: No description available. ,
Databricks: No description available. ,
AppService: No description available. ,
ManagedDisk: No description available. ,
BlockBlob: No description available. ,
RedisCache: No description available. ,
AzureDataExplorer: No description available. ,
MySql: No description available. ,
MariaDb: No description available. ,
PostgreSql: No description available. ,
DedicatedHost: No description available. ,
SapHana: No description available. ,
SqlAzureHybridBenefit: No description available. ,
AVS: No description available. ,
DataFactory: No description available. ,
NetAppStorage: No description available. ,
AzureFiles: No description available. ,
SqlEdge: No description available. ,
VirtualMachineSoftware: No description available. ,
}
,
Required: False ,
}
enum ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing reservation or savings plan ,
Required: False ,
}
string ,
term:
{
Description: Represent the term of reservation. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
billingPlan:
{
Description: Represent the billing plans. ,
Enum:
{
Upfront: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
quantity:
{
Description: Quantity of the skus that are part of the reservation. ,
Format: int32 ,
Required: False ,
}
integer ,
displayName:
{
Description: Friendly name of the reservation ,
Required: False ,
}
string ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopes:
{
Description: List of the subscriptions that the benefit will be applied. Do not specify if AppliedScopeType is Shared. This property will be deprecated and replaced by appliedScopeProperties instead for Single AppliedScopeType. ,
Required: False ,
}
[
string ,
]
,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the savings plan should apply benefit. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
renew:
{
Description: Setting this to true will automatically purchase a new reservation on the expiration date time. ,
Required: False ,
}
boolean ,
reservedResourceProperties:
{
Description: Properties specific to each reserved resource type. Not required if not applicable. ,
Required: False ,
}
{
instanceFlexibility:
{
Description: Turning this on will apply the reservation discount to other VMs in the same VM size group. Only specify for VirtualMachines reserved resource type. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
reviewDateTime:
{
Description: This is the date-time when the Azure hybrid benefit needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
pricingCurrencyTotal:
{
Description: 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. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Required: False ,
}
number ,
}
,
billingCurrencyTotal:
{
Description: Currency and amount that customer will be charged in customer's local currency for renewal purchase. Tax is not included. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Required: False ,
}
number ,
}
,
}
,
term:
{
Description: Represent the term of reservation. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
userFriendlyAppliedScopeType:
{
Description: The applied scope type of the reservation for display, e.g. Shared ,
Required: False ,
}
string ,
userFriendlyRenewState:
{
Description: The renew state of the reservation for display, e.g. On ,
Required: False ,
}
string ,
utilization:
{
Description: Reservation utilization ,
Required: False ,
}
{
trend:
{
Description: last 7 day utilization trend for a reservation ,
Required: False ,
}
string ,
aggregates:
{
Description: The array of aggregates of a reservation's utilization ,
Required: False ,
}
[
{
grain:
{
Description: The grain of the aggregate ,
Required: False ,
}
number ,
grainUnit:
{
Description: The grain unit of the aggregate ,
Required: False ,
}
string ,
value:
{
Description: The aggregate value ,
Required: False ,
}
number ,
valueUnit:
{
Description: The aggregate value unit ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
kind:
{
Description: Resource Provider type to be reserved. ,
Enum:
{
Microsoft.Compute: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
reviewDateTime:
{
Description: This is the date-time when the Azure Hybrid Benefit needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
type:
{
Description: Type of resource. "Microsoft.Capacity/reservations" ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Url to get the next page of reservationOrders. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Extended error information including error code and error message ,
Required: False ,
}
{
code:
{
Description: Error code describing the reason that service is not able to process the incoming request ,
Enum:
{
NotSpecified: No description available. ,
InternalServerError: No description available. ,
ServerTimeout: No description available. ,
AuthorizationFailed: No description available. ,
BadRequest: No description available. ,
ClientCertificateThumbprintNotSet: No description available. ,
InvalidRequestContent: No description available. ,
OperationFailed: No description available. ,
HttpMethodNotSupported: No description available. ,
InvalidRequestUri: No description available. ,
MissingTenantId: No description available. ,
InvalidTenantId: No description available. ,
InvalidReservationOrderId: No description available. ,
InvalidReservationId: No description available. ,
ReservationIdNotInReservationOrder: No description available. ,
ReservationOrderNotFound: No description available. ,
InvalidSubscriptionId: No description available. ,
InvalidAccessToken: No description available. ,
InvalidLocationId: No description available. ,
UnauthenticatedRequestsThrottled: No description available. ,
InvalidHealthCheckType: No description available. ,
Forbidden: No description available. ,
BillingScopeIdCannotBeChanged: No description available. ,
AppliedScopesNotAssociatedWithCommerceAccount: No description available. ,
PatchValuesSameAsExisting: No description available. ,
RoleAssignmentCreationFailed: No description available. ,
ReservationOrderCreationFailed: No description available. ,
ReservationOrderNotEnabled: No description available. ,
CapacityUpdateScopesFailed: No description available. ,
UnsupportedReservationTerm: No description available. ,
ReservationOrderIdAlreadyExists: No description available. ,
RiskCheckFailed: No description available. ,
CreateQuoteFailed: No description available. ,
ActivateQuoteFailed: No description available. ,
NonsupportedAccountId: No description available. ,
PaymentInstrumentNotFound: No description available. ,
MissingAppliedScopesForSingle: No description available. ,
NoValidReservationsToReRate: No description available. ,
ReRateOnlyAllowedForEA: No description available. ,
OperationCannotBePerformedInCurrentState: No description available. ,
InvalidSingleAppliedScopesCount: No description available. ,
InvalidFulfillmentRequestParameters: No description available. ,
NotSupportedCountry: No description available. ,
InvalidRefundQuantity: No description available. ,
PurchaseError: No description available. ,
BillingCustomerInputError: No description available. ,
BillingPaymentInstrumentSoftError: No description available. ,
BillingPaymentInstrumentHardError: No description available. ,
BillingTransientError: No description available. ,
BillingError: No description available. ,
FulfillmentConfigurationError: No description available. ,
FulfillmentOutOfStockError: No description available. ,
FulfillmentTransientError: No description available. ,
FulfillmentError: No description available. ,
CalculatePriceFailed: No description available. ,
AppliedScopesSameAsExisting: No description available. ,
SelfServiceRefundNotSupported: No description available. ,
RefundLimitExceeded: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Required: False ,
}
string ,
}
,
}
ReservationOrder_Purchase (updated)
Description :  Purchase `ReservationOrder` and create resource under the specified URI.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ReservationOrder_Purchase",
  "$parameters": {
    "body": {
      "$properties": {
        "properties": [
          {
            "#name": "reservedResourceType",
            "Description": {
              "new": "The type of the resource that is being reserved. In addition to below types we have also added the following: OpenAIPTU, MDC, Sentinel.",
              "old": "The type of the resource that is being reserved."
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "reservations": {
              "$properties": {
                "properties": [
                  {
                    "renewProperties": [
                      {
                        "purchaseProperties": [
                          {
                            "properties": [
                              {
                                "#name": "reservedResourceType",
                                "Description": {
                                  "new": "The type of the resource that is being reserved. In addition to below types we have also added the following: OpenAIPTU, MDC, Sentinel.",
                                  "old": "The type of the resource that is being reserved."
                                }
                              }
                            ]
                          }
                        ]
                      }
                    ]
                  }
                ]
              }
            }
          }
        ]
      }
    },
    "202": {
      "$properties": {
        "properties": [
          {
            "reservations": {
              "$properties": {
                "properties": [
                  {
                    "renewProperties": [
                      {
                        "purchaseProperties": [
                          {
                            "properties": [
                              {
                                "#name": "reservedResourceType",
                                "Description": {
                                  "new": "The type of the resource that is being reserved. In addition to below types we have also added the following: OpenAIPTU, MDC, Sentinel.",
                                  "old": "The type of the resource that is being reserved."
                                }
                              }
                            ]
                          }
                        ]
                      }
                    ]
                  }
                ]
              }
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}
{
reservationOrderId:
{
Description: Order Id of the reservation ,
Required: True ,
}
string ,
api-version:
{
Description: Supported version. ,
Required: True ,
}
string ,
body:
{
Description: Information needed for calculate or purchase reservation ,
Required: True ,
}
{
sku:
{
Description: The name of sku ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
}
,
location:
{
Description: The Azure region where the reserved resource lives. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of reservation purchase request ,
Required: False ,
}
{
reservedResourceType:
{
Description: The type of the resource that is being reserved. In addition to below types we have also added the following: OpenAIPTU, MDC, Sentinel. ,
Enum:
{
VirtualMachines: No description available. ,
SqlDatabases: No description available. ,
SuseLinux: No description available. ,
CosmosDb: No description available. ,
RedHat: No description available. ,
SqlDataWarehouse: No description available. ,
VMwareCloudSimple: No description available. ,
RedHatOsa: No description available. ,
Databricks: No description available. ,
AppService: No description available. ,
ManagedDisk: No description available. ,
BlockBlob: No description available. ,
RedisCache: No description available. ,
AzureDataExplorer: No description available. ,
MySql: No description available. ,
MariaDb: No description available. ,
PostgreSql: No description available. ,
DedicatedHost: No description available. ,
SapHana: No description available. ,
SqlAzureHybridBenefit: No description available. ,
AVS: No description available. ,
DataFactory: No description available. ,
NetAppStorage: No description available. ,
AzureFiles: No description available. ,
SqlEdge: No description available. ,
VirtualMachineSoftware: No description available. ,
}
,
Required: False ,
}
enum ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing reservation or savings plan ,
Required: False ,
}
string ,
term:
{
Description: Represent the term of reservation. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
billingPlan:
{
Description: Represent the billing plans. ,
Enum:
{
Upfront: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
quantity:
{
Description: Quantity of the skus that are part of the reservation. ,
Format: int32 ,
Required: False ,
}
integer ,
displayName:
{
Description: Friendly name of the reservation ,
Required: False ,
}
string ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopes:
{
Description: List of the subscriptions that the benefit will be applied. Do not specify if AppliedScopeType is Shared. This property will be deprecated and replaced by appliedScopeProperties instead for Single AppliedScopeType. ,
Required: False ,
}
[
string ,
]
,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the savings plan should apply benefit. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
renew:
{
Description: Setting this to true will automatically purchase a new reservation on the expiration date time. ,
Required: False ,
}
boolean ,
reservedResourceProperties:
{
Description: Properties specific to each reserved resource type. Not required if not applicable. ,
Required: False ,
}
{
instanceFlexibility:
{
Description: Turning this on will apply the reservation discount to other VMs in the same VM size group. Only specify for VirtualMachines reserved resource type. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
reviewDateTime:
{
Description: This is the date-time when the Azure hybrid benefit needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
etag:
{
Format: int32 ,
Required: False ,
}
integer ,
id:
{
Description: Identifier of the reservation ,
Required: False ,
}
string ,
name:
{
Description: Name of the reservation ,
Required: False ,
}
string ,
properties:
{
Description: Properties of a reservation order. ,
Required: False ,
}
{
displayName:
{
Description: Friendly name for user to easily identified the reservation. ,
Required: False ,
}
string ,
requestDateTime:
{
Description: This is the DateTime when the reservation was initially requested for purchase. ,
Format: date-time ,
Required: False ,
}
string ,
createdDateTime:
{
Description: This is the DateTime when the reservation was created. ,
Format: date-time ,
Required: False ,
}
string ,
expiryDate:
{
Description: This is the date when the reservation will expire. ,
Format: date ,
Required: False ,
}
string ,
expiryDateTime:
{
Description: This is the date-time when the reservation will expire. ,
Format: date-time ,
Required: False ,
}
string ,
benefitStartTime:
{
Description: This is the DateTime when the reservation benefit started. ,
Format: date-time ,
Required: False ,
}
string ,
originalQuantity:
{
Description: Total Quantity of the skus purchased in the reservation. ,
Format: int32 ,
Required: False ,
}
integer ,
term:
{
Description: Represent the term of reservation. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Current state of the reservation. ,
Enum:
{
Creating: No description available. ,
PendingResourceHold: No description available. ,
ConfirmedResourceHold: No description available. ,
PendingBilling: No description available. ,
ConfirmedBilling: No description available. ,
Created: No description available. ,
Succeeded: No description available. ,
Cancelled: No description available. ,
Expired: No description available. ,
BillingFailed: No description available. ,
Failed: No description available. ,
Split: No description available. ,
Merged: No description available. ,
}
,
Required: False ,
}
enum ,
billingPlan:
{
Description: Represent the billing plans. ,
Enum:
{
Upfront: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
planInformation:
{
Description: Information describing the type of billing plan for this reservation. ,
Required: False ,
}
{
pricingCurrencyTotal:
{
Description: Amount of money to be paid for the Order. Tax is not included. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
startDate:
{
Description: Date when the billing plan has started. ,
Format: date ,
Required: False ,
}
string ,
nextPaymentDueDate:
{
Description: For recurring billing plans, indicates the date when next payment will be processed. Null when total is paid off. ,
Format: date ,
Required: False ,
}
string ,
transactions:
{
Required: False ,
}
[
{
dueDate:
{
Description: Date when the payment needs to be done. ,
Format: date ,
Required: False ,
}
string ,
paymentDate:
{
Description: Date when the transaction is completed. Is null when it is scheduled. ,
Format: date ,
Required: False ,
}
string ,
pricingCurrencyTotal:
{
Description: Amount in pricing currency. Tax not included. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
billingCurrencyTotal:
{
Description: Amount charged in Billing currency. Tax not included. Is null for future payments ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
billingAccount:
{
Description: Shows the Account that is charged for this payment. ,
Required: False ,
}
string ,
status:
{
Description: Describes whether the payment is completed, failed, cancelled or scheduled in the future. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Scheduled: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
extendedStatusInfo:
{
Required: False ,
}
{
statusCode:
{
Enum:
{
None: No description available. ,
Pending: No description available. ,
Processing: No description available. ,
Active: No description available. ,
PurchaseError: No description available. ,
PaymentInstrumentError: No description available. ,
Split: No description available. ,
Merged: No description available. ,
Expired: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
reservations:
{
Required: False ,
}
[
{
location:
{
Description: The Azure region where the reserved resource lives. ,
Required: False ,
}
string ,
etag:
{
Format: int32 ,
Required: False ,
}
integer ,
sku:
{
Description: The sku information associated to this reservation ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties associated to this reservation ,
Required: False ,
}
{
reservedResourceType:
{
Description: The type of the resource that is being reserved. ,
Enum:
{
VirtualMachines: No description available. ,
SqlDatabases: No description available. ,
SuseLinux: No description available. ,
CosmosDb: No description available. ,
RedHat: No description available. ,
SqlDataWarehouse: No description available. ,
VMwareCloudSimple: No description available. ,
RedHatOsa: No description available. ,
Databricks: No description available. ,
AppService: No description available. ,
ManagedDisk: No description available. ,
BlockBlob: No description available. ,
RedisCache: No description available. ,
AzureDataExplorer: No description available. ,
MySql: No description available. ,
MariaDb: No description available. ,
PostgreSql: No description available. ,
DedicatedHost: No description available. ,
SapHana: No description available. ,
SqlAzureHybridBenefit: No description available. ,
AVS: No description available. ,
DataFactory: No description available. ,
NetAppStorage: No description available. ,
AzureFiles: No description available. ,
SqlEdge: No description available. ,
VirtualMachineSoftware: No description available. ,
}
,
Required: False ,
}
enum ,
instanceFlexibility:
{
Description: Allows reservation discount to be applied across skus within the same auto fit group. Not all skus support instance size flexibility. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Friendly name for user to easily identify the reservation ,
Required: False ,
}
string ,
appliedScopes:
{
Description: The list of applied scopes ,
Required: False ,
}
[
string ,
]
,
appliedScopeType:
{
Description: The applied scope type ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
archived:
{
Description: Indicates if the reservation is archived ,
Required: False ,
}
boolean ,
capabilities:
{
Description: Capabilities of the reservation ,
Required: False ,
}
string ,
quantity:
{
Description: Quantity of the skus that are part of the reservation. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: Current state of the reservation. ,
Enum:
{
Creating: No description available. ,
PendingResourceHold: No description available. ,
ConfirmedResourceHold: No description available. ,
PendingBilling: No description available. ,
ConfirmedBilling: No description available. ,
Created: No description available. ,
Succeeded: No description available. ,
Cancelled: No description available. ,
Expired: No description available. ,
BillingFailed: No description available. ,
Failed: No description available. ,
Split: No description available. ,
Merged: No description available. ,
}
,
Required: False ,
}
enum ,
effectiveDateTime:
{
Description: DateTime of the reservation starting when this version is effective from. ,
Format: date-time ,
Required: False ,
}
string ,
benefitStartTime:
{
Description: This is the DateTime when the reservation benefit started. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedDateTime:
{
Description: DateTime of the last time the reservation was updated. ,
Format: date-time ,
Required: False ,
}
string ,
expiryDate:
{
Description: This is the date when the reservation will expire. ,
Format: date ,
Required: False ,
}
string ,
expiryDateTime:
{
Description: This is the date-time when the reservation will expire. ,
Format: date-time ,
Required: False ,
}
string ,
reviewDateTime:
{
Description: This is the date-time when the Azure Hybrid Benefit needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
skuDescription:
{
Description: Description of the sku in english. ,
Required: False ,
}
string ,
extendedStatusInfo:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
{
statusCode:
{
Enum:
{
None: No description available. ,
Pending: No description available. ,
Processing: No description available. ,
Active: No description available. ,
PurchaseError: No description available. ,
PaymentInstrumentError: No description available. ,
Split: No description available. ,
Merged: No description available. ,
Expired: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
string ,
}
,
billingPlan:
{
Description: The billing plan options available for this sku. ,
Enum:
{
Upfront: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
displayProvisioningState:
{
Description: The provisioning state of the reservation for display, e.g. Succeeded ,
Required: False ,
}
string ,
provisioningSubState:
{
Description: The provisioning sub-state of the reservation, e.g. Succeeded ,
Required: False ,
}
string ,
purchaseDate:
{
Description: This is the date when the reservation was purchased. ,
Format: date ,
Required: False ,
}
string ,
purchaseDateTime:
{
Description: This is the date-time when the reservation was purchased. ,
Format: date-time ,
Required: False ,
}
string ,
splitProperties:
{
Description: Properties of reservation split ,
Required: False ,
}
{
splitDestinations:
{
Description: List of destination resource id that are created due to split. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
[
string ,
]
,
splitSource:
{
Description: Resource id of the reservation from which this is split. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
}
,
mergeProperties:
{
Description: Properties of reservation merge ,
Required: False ,
}
{
mergeDestination:
{
Description: Reservation resource id Created due to the merge. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
mergeSources:
{
Description: Resource ids of the source reservation's merged to form this reservation. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
[
string ,
]
,
}
,
swapProperties:
{
Description: Properties of reservation swap ,
Required: False ,
}
{
swapSource:
{
Description: Resource id of the source reservation that gets swapped. Format of the resource id is /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
swapDestination:
{
Description: Reservation resource id that the original resource gets swapped to. Format of the resource id is /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
}
,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the savings plan should apply benefit. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
billingScopeId:
{
Description: Subscription that will be charged for purchasing reservation or savings plan ,
Required: False ,
}
string ,
renew:
{
Description: Setting this to true will automatically purchase a new reservation on the expiration date time. ,
Required: False ,
}
boolean ,
renewSource:
{
Description: Reservation Id of the reservation from which this reservation is renewed. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}. ,
Required: False ,
}
string ,
renewDestination:
{
Description: Reservation Id of the reservation which is purchased because of renew. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}. ,
Required: False ,
}
string ,
renewProperties:
{
Description: The renew properties for a reservation. ,
Required: False ,
}
{
purchaseProperties:
{
Description: The request for reservation purchase ,
Required: False ,
}
{
sku:
{
Description: The name of sku ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
}
,
location:
{
Description: The Azure region where the reserved resource lives. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of reservation purchase request ,
Required: False ,
}
{
reservedResourceType:
{
Description: The type of the resource that is being reserved. In addition to below types we have also added the following: OpenAIPTU, MDC, Sentinel. ,
Enum:
{
VirtualMachines: No description available. ,
SqlDatabases: No description available. ,
SuseLinux: No description available. ,
CosmosDb: No description available. ,
RedHat: No description available. ,
SqlDataWarehouse: No description available. ,
VMwareCloudSimple: No description available. ,
RedHatOsa: No description available. ,
Databricks: No description available. ,
AppService: No description available. ,
ManagedDisk: No description available. ,
BlockBlob: No description available. ,
RedisCache: No description available. ,
AzureDataExplorer: No description available. ,
MySql: No description available. ,
MariaDb: No description available. ,
PostgreSql: No description available. ,
DedicatedHost: No description available. ,
SapHana: No description available. ,
SqlAzureHybridBenefit: No description available. ,
AVS: No description available. ,
DataFactory: No description available. ,
NetAppStorage: No description available. ,
AzureFiles: No description available. ,
SqlEdge: No description available. ,
VirtualMachineSoftware: No description available. ,
}
,
Required: False ,
}
enum ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing reservation or savings plan ,
Required: False ,
}
string ,
term:
{
Description: Represent the term of reservation. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
billingPlan:
{
Description: Represent the billing plans. ,
Enum:
{
Upfront: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
quantity:
{
Description: Quantity of the skus that are part of the reservation. ,
Format: int32 ,
Required: False ,
}
integer ,
displayName:
{
Description: Friendly name of the reservation ,
Required: False ,
}
string ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopes:
{
Description: List of the subscriptions that the benefit will be applied. Do not specify if AppliedScopeType is Shared. This property will be deprecated and replaced by appliedScopeProperties instead for Single AppliedScopeType. ,
Required: False ,
}
[
string ,
]
,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the savings plan should apply benefit. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
renew:
{
Description: Setting this to true will automatically purchase a new reservation on the expiration date time. ,
Required: False ,
}
boolean ,
reservedResourceProperties:
{
Description: Properties specific to each reserved resource type. Not required if not applicable. ,
Required: False ,
}
{
instanceFlexibility:
{
Description: Turning this on will apply the reservation discount to other VMs in the same VM size group. Only specify for VirtualMachines reserved resource type. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
reviewDateTime:
{
Description: This is the date-time when the Azure hybrid benefit needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
pricingCurrencyTotal:
{
Description: 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. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Required: False ,
}
number ,
}
,
billingCurrencyTotal:
{
Description: Currency and amount that customer will be charged in customer's local currency for renewal purchase. Tax is not included. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Required: False ,
}
number ,
}
,
}
,
term:
{
Description: Represent the term of reservation. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
userFriendlyAppliedScopeType:
{
Description: The applied scope type of the reservation for display, e.g. Shared ,
Required: False ,
}
string ,
userFriendlyRenewState:
{
Description: The renew state of the reservation for display, e.g. On ,
Required: False ,
}
string ,
utilization:
{
Description: Reservation utilization ,
Required: False ,
}
{
trend:
{
Description: last 7 day utilization trend for a reservation ,
Required: False ,
}
string ,
aggregates:
{
Description: The array of aggregates of a reservation's utilization ,
Required: False ,
}
[
{
grain:
{
Description: The grain of the aggregate ,
Required: False ,
}
number ,
grainUnit:
{
Description: The grain unit of the aggregate ,
Required: False ,
}
string ,
value:
{
Description: The aggregate value ,
Required: False ,
}
number ,
valueUnit:
{
Description: The aggregate value unit ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
kind:
{
Description: Resource Provider type to be reserved. ,
Enum:
{
Microsoft.Compute: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
reviewDateTime:
{
Description: This is the date-time when the Azure Hybrid Benefit needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
type:
{
Description: Type of resource. "Microsoft.Capacity/reservations" ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
$headers:
{
location:
{
Description: URL for determining when an operation has completed. Only use this value only when Azure-AsyncOperation isn't returned. ,
}
string ,
retry-after:
{
Description: Clients should wait for the Retry-After interval before polling again ,
}
integer ,
}
,
$schema:
{
Description: Details of a reservation order being returned. ,
}
{
etag:
{
Format: int32 ,
Required: False ,
}
integer ,
id:
{
Description: Identifier of the reservation ,
Required: False ,
}
string ,
name:
{
Description: Name of the reservation ,
Required: False ,
}
string ,
properties:
{
Description: Properties of a reservation order. ,
Required: False ,
}
{
displayName:
{
Description: Friendly name for user to easily identified the reservation. ,
Required: False ,
}
string ,
requestDateTime:
{
Description: This is the DateTime when the reservation was initially requested for purchase. ,
Format: date-time ,
Required: False ,
}
string ,
createdDateTime:
{
Description: This is the DateTime when the reservation was created. ,
Format: date-time ,
Required: False ,
}
string ,
expiryDate:
{
Description: This is the date when the reservation will expire. ,
Format: date ,
Required: False ,
}
string ,
expiryDateTime:
{
Description: This is the date-time when the reservation will expire. ,
Format: date-time ,
Required: False ,
}
string ,
benefitStartTime:
{
Description: This is the DateTime when the reservation benefit started. ,
Format: date-time ,
Required: False ,
}
string ,
originalQuantity:
{
Description: Total Quantity of the skus purchased in the reservation. ,
Format: int32 ,
Required: False ,
}
integer ,
term:
{
Description: Represent the term of reservation. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Current state of the reservation. ,
Enum:
{
Creating: No description available. ,
PendingResourceHold: No description available. ,
ConfirmedResourceHold: No description available. ,
PendingBilling: No description available. ,
ConfirmedBilling: No description available. ,
Created: No description available. ,
Succeeded: No description available. ,
Cancelled: No description available. ,
Expired: No description available. ,
BillingFailed: No description available. ,
Failed: No description available. ,
Split: No description available. ,
Merged: No description available. ,
}
,
Required: False ,
}
enum ,
billingPlan:
{
Description: Represent the billing plans. ,
Enum:
{
Upfront: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
planInformation:
{
Description: Information describing the type of billing plan for this reservation. ,
Required: False ,
}
{
pricingCurrencyTotal:
{
Description: Amount of money to be paid for the Order. Tax is not included. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
startDate:
{
Description: Date when the billing plan has started. ,
Format: date ,
Required: False ,
}
string ,
nextPaymentDueDate:
{
Description: For recurring billing plans, indicates the date when next payment will be processed. Null when total is paid off. ,
Format: date ,
Required: False ,
}
string ,
transactions:
{
Required: False ,
}
[
{
dueDate:
{
Description: Date when the payment needs to be done. ,
Format: date ,
Required: False ,
}
string ,
paymentDate:
{
Description: Date when the transaction is completed. Is null when it is scheduled. ,
Format: date ,
Required: False ,
}
string ,
pricingCurrencyTotal:
{
Description: Amount in pricing currency. Tax not included. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
billingCurrencyTotal:
{
Description: Amount charged in Billing currency. Tax not included. Is null for future payments ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
billingAccount:
{
Description: Shows the Account that is charged for this payment. ,
Required: False ,
}
string ,
status:
{
Description: Describes whether the payment is completed, failed, cancelled or scheduled in the future. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Scheduled: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
extendedStatusInfo:
{
Required: False ,
}
{
statusCode:
{
Enum:
{
None: No description available. ,
Pending: No description available. ,
Processing: No description available. ,
Active: No description available. ,
PurchaseError: No description available. ,
PaymentInstrumentError: No description available. ,
Split: No description available. ,
Merged: No description available. ,
Expired: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
reservations:
{
Required: False ,
}
[
{
location:
{
Description: The Azure region where the reserved resource lives. ,
Required: False ,
}
string ,
etag:
{
Format: int32 ,
Required: False ,
}
integer ,
sku:
{
Description: The sku information associated to this reservation ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties associated to this reservation ,
Required: False ,
}
{
reservedResourceType:
{
Description: The type of the resource that is being reserved. ,
Enum:
{
VirtualMachines: No description available. ,
SqlDatabases: No description available. ,
SuseLinux: No description available. ,
CosmosDb: No description available. ,
RedHat: No description available. ,
SqlDataWarehouse: No description available. ,
VMwareCloudSimple: No description available. ,
RedHatOsa: No description available. ,
Databricks: No description available. ,
AppService: No description available. ,
ManagedDisk: No description available. ,
BlockBlob: No description available. ,
RedisCache: No description available. ,
AzureDataExplorer: No description available. ,
MySql: No description available. ,
MariaDb: No description available. ,
PostgreSql: No description available. ,
DedicatedHost: No description available. ,
SapHana: No description available. ,
SqlAzureHybridBenefit: No description available. ,
AVS: No description available. ,
DataFactory: No description available. ,
NetAppStorage: No description available. ,
AzureFiles: No description available. ,
SqlEdge: No description available. ,
VirtualMachineSoftware: No description available. ,
}
,
Required: False ,
}
enum ,
instanceFlexibility:
{
Description: Allows reservation discount to be applied across skus within the same auto fit group. Not all skus support instance size flexibility. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Friendly name for user to easily identify the reservation ,
Required: False ,
}
string ,
appliedScopes:
{
Description: The list of applied scopes ,
Required: False ,
}
[
string ,
]
,
appliedScopeType:
{
Description: The applied scope type ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
archived:
{
Description: Indicates if the reservation is archived ,
Required: False ,
}
boolean ,
capabilities:
{
Description: Capabilities of the reservation ,
Required: False ,
}
string ,
quantity:
{
Description: Quantity of the skus that are part of the reservation. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: Current state of the reservation. ,
Enum:
{
Creating: No description available. ,
PendingResourceHold: No description available. ,
ConfirmedResourceHold: No description available. ,
PendingBilling: No description available. ,
ConfirmedBilling: No description available. ,
Created: No description available. ,
Succeeded: No description available. ,
Cancelled: No description available. ,
Expired: No description available. ,
BillingFailed: No description available. ,
Failed: No description available. ,
Split: No description available. ,
Merged: No description available. ,
}
,
Required: False ,
}
enum ,
effectiveDateTime:
{
Description: DateTime of the reservation starting when this version is effective from. ,
Format: date-time ,
Required: False ,
}
string ,
benefitStartTime:
{
Description: This is the DateTime when the reservation benefit started. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedDateTime:
{
Description: DateTime of the last time the reservation was updated. ,
Format: date-time ,
Required: False ,
}
string ,
expiryDate:
{
Description: This is the date when the reservation will expire. ,
Format: date ,
Required: False ,
}
string ,
expiryDateTime:
{
Description: This is the date-time when the reservation will expire. ,
Format: date-time ,
Required: False ,
}
string ,
reviewDateTime:
{
Description: This is the date-time when the Azure Hybrid Benefit needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
skuDescription:
{
Description: Description of the sku in english. ,
Required: False ,
}
string ,
extendedStatusInfo:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
{
statusCode:
{
Enum:
{
None: No description available. ,
Pending: No description available. ,
Processing: No description available. ,
Active: No description available. ,
PurchaseError: No description available. ,
PaymentInstrumentError: No description available. ,
Split: No description available. ,
Merged: No description available. ,
Expired: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
string ,
}
,
billingPlan:
{
Description: The billing plan options available for this sku. ,
Enum:
{
Upfront: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
displayProvisioningState:
{
Description: The provisioning state of the reservation for display, e.g. Succeeded ,
Required: False ,
}
string ,
provisioningSubState:
{
Description: The provisioning sub-state of the reservation, e.g. Succeeded ,
Required: False ,
}
string ,
purchaseDate:
{
Description: This is the date when the reservation was purchased. ,
Format: date ,
Required: False ,
}
string ,
purchaseDateTime:
{
Description: This is the date-time when the reservation was purchased. ,
Format: date-time ,
Required: False ,
}
string ,
splitProperties:
{
Description: Properties of reservation split ,
Required: False ,
}
{
splitDestinations:
{
Description: List of destination resource id that are created due to split. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
[
string ,
]
,
splitSource:
{
Description: Resource id of the reservation from which this is split. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
}
,
mergeProperties:
{
Description: Properties of reservation merge ,
Required: False ,
}
{
mergeDestination:
{
Description: Reservation resource id Created due to the merge. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
mergeSources:
{
Description: Resource ids of the source reservation's merged to form this reservation. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
[
string ,
]
,
}
,
swapProperties:
{
Description: Properties of reservation swap ,
Required: False ,
}
{
swapSource:
{
Description: Resource id of the source reservation that gets swapped. Format of the resource id is /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
swapDestination:
{
Description: Reservation resource id that the original resource gets swapped to. Format of the resource id is /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
}
,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the savings plan should apply benefit. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
billingScopeId:
{
Description: Subscription that will be charged for purchasing reservation or savings plan ,
Required: False ,
}
string ,
renew:
{
Description: Setting this to true will automatically purchase a new reservation on the expiration date time. ,
Required: False ,
}
boolean ,
renewSource:
{
Description: Reservation Id of the reservation from which this reservation is renewed. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}. ,
Required: False ,
}
string ,
renewDestination:
{
Description: Reservation Id of the reservation which is purchased because of renew. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}. ,
Required: False ,
}
string ,
renewProperties:
{
Description: The renew properties for a reservation. ,
Required: False ,
}
{
purchaseProperties:
{
Description: The request for reservation purchase ,
Required: False ,
}
{
sku:
{
Description: The name of sku ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
}
,
location:
{
Description: The Azure region where the reserved resource lives. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of reservation purchase request ,
Required: False ,
}
{
reservedResourceType:
{
Description: The type of the resource that is being reserved. In addition to below types we have also added the following: OpenAIPTU, MDC, Sentinel. ,
Enum:
{
VirtualMachines: No description available. ,
SqlDatabases: No description available. ,
SuseLinux: No description available. ,
CosmosDb: No description available. ,
RedHat: No description available. ,
SqlDataWarehouse: No description available. ,
VMwareCloudSimple: No description available. ,
RedHatOsa: No description available. ,
Databricks: No description available. ,
AppService: No description available. ,
ManagedDisk: No description available. ,
BlockBlob: No description available. ,
RedisCache: No description available. ,
AzureDataExplorer: No description available. ,
MySql: No description available. ,
MariaDb: No description available. ,
PostgreSql: No description available. ,
DedicatedHost: No description available. ,
SapHana: No description available. ,
SqlAzureHybridBenefit: No description available. ,
AVS: No description available. ,
DataFactory: No description available. ,
NetAppStorage: No description available. ,
AzureFiles: No description available. ,
SqlEdge: No description available. ,
VirtualMachineSoftware: No description available. ,
}
,
Required: False ,
}
enum ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing reservation or savings plan ,
Required: False ,
}
string ,
term:
{
Description: Represent the term of reservation. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
billingPlan:
{
Description: Represent the billing plans. ,
Enum:
{
Upfront: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
quantity:
{
Description: Quantity of the skus that are part of the reservation. ,
Format: int32 ,
Required: False ,
}
integer ,
displayName:
{
Description: Friendly name of the reservation ,
Required: False ,
}
string ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopes:
{
Description: List of the subscriptions that the benefit will be applied. Do not specify if AppliedScopeType is Shared. This property will be deprecated and replaced by appliedScopeProperties instead for Single AppliedScopeType. ,
Required: False ,
}
[
string ,
]
,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the savings plan should apply benefit. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
renew:
{
Description: Setting this to true will automatically purchase a new reservation on the expiration date time. ,
Required: False ,
}
boolean ,
reservedResourceProperties:
{
Description: Properties specific to each reserved resource type. Not required if not applicable. ,
Required: False ,
}
{
instanceFlexibility:
{
Description: Turning this on will apply the reservation discount to other VMs in the same VM size group. Only specify for VirtualMachines reserved resource type. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
reviewDateTime:
{
Description: This is the date-time when the Azure hybrid benefit needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
pricingCurrencyTotal:
{
Description: 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. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Required: False ,
}
number ,
}
,
billingCurrencyTotal:
{
Description: Currency and amount that customer will be charged in customer's local currency for renewal purchase. Tax is not included. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Required: False ,
}
number ,
}
,
}
,
term:
{
Description: Represent the term of reservation. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
userFriendlyAppliedScopeType:
{
Description: The applied scope type of the reservation for display, e.g. Shared ,
Required: False ,
}
string ,
userFriendlyRenewState:
{
Description: The renew state of the reservation for display, e.g. On ,
Required: False ,
}
string ,
utilization:
{
Description: Reservation utilization ,
Required: False ,
}
{
trend:
{
Description: last 7 day utilization trend for a reservation ,
Required: False ,
}
string ,
aggregates:
{
Description: The array of aggregates of a reservation's utilization ,
Required: False ,
}
[
{
grain:
{
Description: The grain of the aggregate ,
Required: False ,
}
number ,
grainUnit:
{
Description: The grain unit of the aggregate ,
Required: False ,
}
string ,
value:
{
Description: The aggregate value ,
Required: False ,
}
number ,
valueUnit:
{
Description: The aggregate value unit ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
kind:
{
Description: Resource Provider type to be reserved. ,
Enum:
{
Microsoft.Compute: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
reviewDateTime:
{
Description: This is the date-time when the Azure Hybrid Benefit needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
type:
{
Description: Type of resource. "Microsoft.Capacity/reservations" ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Extended error information including error code and error message ,
Required: False ,
}
{
code:
{
Description: Error code describing the reason that service is not able to process the incoming request ,
Enum:
{
NotSpecified: No description available. ,
InternalServerError: No description available. ,
ServerTimeout: No description available. ,
AuthorizationFailed: No description available. ,
BadRequest: No description available. ,
ClientCertificateThumbprintNotSet: No description available. ,
InvalidRequestContent: No description available. ,
OperationFailed: No description available. ,
HttpMethodNotSupported: No description available. ,
InvalidRequestUri: No description available. ,
MissingTenantId: No description available. ,
InvalidTenantId: No description available. ,
InvalidReservationOrderId: No description available. ,
InvalidReservationId: No description available. ,
ReservationIdNotInReservationOrder: No description available. ,
ReservationOrderNotFound: No description available. ,
InvalidSubscriptionId: No description available. ,
InvalidAccessToken: No description available. ,
InvalidLocationId: No description available. ,
UnauthenticatedRequestsThrottled: No description available. ,
InvalidHealthCheckType: No description available. ,
Forbidden: No description available. ,
BillingScopeIdCannotBeChanged: No description available. ,
AppliedScopesNotAssociatedWithCommerceAccount: No description available. ,
PatchValuesSameAsExisting: No description available. ,
RoleAssignmentCreationFailed: No description available. ,
ReservationOrderCreationFailed: No description available. ,
ReservationOrderNotEnabled: No description available. ,
CapacityUpdateScopesFailed: No description available. ,
UnsupportedReservationTerm: No description available. ,
ReservationOrderIdAlreadyExists: No description available. ,
RiskCheckFailed: No description available. ,
CreateQuoteFailed: No description available. ,
ActivateQuoteFailed: No description available. ,
NonsupportedAccountId: No description available. ,
PaymentInstrumentNotFound: No description available. ,
MissingAppliedScopesForSingle: No description available. ,
NoValidReservationsToReRate: No description available. ,
ReRateOnlyAllowedForEA: No description available. ,
OperationCannotBePerformedInCurrentState: No description available. ,
InvalidSingleAppliedScopesCount: No description available. ,
InvalidFulfillmentRequestParameters: No description available. ,
NotSupportedCountry: No description available. ,
InvalidRefundQuantity: No description available. ,
PurchaseError: No description available. ,
BillingCustomerInputError: No description available. ,
BillingPaymentInstrumentSoftError: No description available. ,
BillingPaymentInstrumentHardError: No description available. ,
BillingTransientError: No description available. ,
BillingError: No description available. ,
FulfillmentConfigurationError: No description available. ,
FulfillmentOutOfStockError: No description available. ,
FulfillmentTransientError: No description available. ,
FulfillmentError: No description available. ,
CalculatePriceFailed: No description available. ,
AppliedScopesSameAsExisting: No description available. ,
SelfServiceRefundNotSupported: No description available. ,
RefundLimitExceeded: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Required: False ,
}
string ,
}
,
}
ReservationOrder_Get (updated)
Description :  Get the details of the `ReservationOrder`.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ReservationOrder_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "reservations": {
              "$properties": {
                "properties": [
                  {
                    "renewProperties": [
                      {
                        "purchaseProperties": [
                          {
                            "properties": [
                              {
                                "#name": "reservedResourceType",
                                "Description": {
                                  "new": "The type of the resource that is being reserved. In addition to below types we have also added the following: OpenAIPTU, MDC, Sentinel.",
                                  "old": "The type of the resource that is being reserved."
                                }
                              }
                            ]
                          }
                        ]
                      }
                    ]
                  }
                ]
              }
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}
{
reservationOrderId:
{
Description: Order Id of the reservation ,
Required: True ,
}
string ,
api-version:
{
Description: Supported version. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the planInformation. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Format: int32 ,
Required: False ,
}
integer ,
id:
{
Description: Identifier of the reservation ,
Required: False ,
}
string ,
name:
{
Description: Name of the reservation ,
Required: False ,
}
string ,
properties:
{
Description: Properties of a reservation order. ,
Required: False ,
}
{
displayName:
{
Description: Friendly name for user to easily identified the reservation. ,
Required: False ,
}
string ,
requestDateTime:
{
Description: This is the DateTime when the reservation was initially requested for purchase. ,
Format: date-time ,
Required: False ,
}
string ,
createdDateTime:
{
Description: This is the DateTime when the reservation was created. ,
Format: date-time ,
Required: False ,
}
string ,
expiryDate:
{
Description: This is the date when the reservation will expire. ,
Format: date ,
Required: False ,
}
string ,
expiryDateTime:
{
Description: This is the date-time when the reservation will expire. ,
Format: date-time ,
Required: False ,
}
string ,
benefitStartTime:
{
Description: This is the DateTime when the reservation benefit started. ,
Format: date-time ,
Required: False ,
}
string ,
originalQuantity:
{
Description: Total Quantity of the skus purchased in the reservation. ,
Format: int32 ,
Required: False ,
}
integer ,
term:
{
Description: Represent the term of reservation. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Current state of the reservation. ,
Enum:
{
Creating: No description available. ,
PendingResourceHold: No description available. ,
ConfirmedResourceHold: No description available. ,
PendingBilling: No description available. ,
ConfirmedBilling: No description available. ,
Created: No description available. ,
Succeeded: No description available. ,
Cancelled: No description available. ,
Expired: No description available. ,
BillingFailed: No description available. ,
Failed: No description available. ,
Split: No description available. ,
Merged: No description available. ,
}
,
Required: False ,
}
enum ,
billingPlan:
{
Description: Represent the billing plans. ,
Enum:
{
Upfront: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
planInformation:
{
Description: Information describing the type of billing plan for this reservation. ,
Required: False ,
}
{
pricingCurrencyTotal:
{
Description: Amount of money to be paid for the Order. Tax is not included. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
startDate:
{
Description: Date when the billing plan has started. ,
Format: date ,
Required: False ,
}
string ,
nextPaymentDueDate:
{
Description: For recurring billing plans, indicates the date when next payment will be processed. Null when total is paid off. ,
Format: date ,
Required: False ,
}
string ,
transactions:
{
Required: False ,
}
[
{
dueDate:
{
Description: Date when the payment needs to be done. ,
Format: date ,
Required: False ,
}
string ,
paymentDate:
{
Description: Date when the transaction is completed. Is null when it is scheduled. ,
Format: date ,
Required: False ,
}
string ,
pricingCurrencyTotal:
{
Description: Amount in pricing currency. Tax not included. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
billingCurrencyTotal:
{
Description: Amount charged in Billing currency. Tax not included. Is null for future payments ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
billingAccount:
{
Description: Shows the Account that is charged for this payment. ,
Required: False ,
}
string ,
status:
{
Description: Describes whether the payment is completed, failed, cancelled or scheduled in the future. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Scheduled: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
extendedStatusInfo:
{
Required: False ,
}
{
statusCode:
{
Enum:
{
None: No description available. ,
Pending: No description available. ,
Processing: No description available. ,
Active: No description available. ,
PurchaseError: No description available. ,
PaymentInstrumentError: No description available. ,
Split: No description available. ,
Merged: No description available. ,
Expired: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
reservations:
{
Required: False ,
}
[
{
location:
{
Description: The Azure region where the reserved resource lives. ,
Required: False ,
}
string ,
etag:
{
Format: int32 ,
Required: False ,
}
integer ,
sku:
{
Description: The sku information associated to this reservation ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties associated to this reservation ,
Required: False ,
}
{
reservedResourceType:
{
Description: The type of the resource that is being reserved. ,
Enum:
{
VirtualMachines: No description available. ,
SqlDatabases: No description available. ,
SuseLinux: No description available. ,
CosmosDb: No description available. ,
RedHat: No description available. ,
SqlDataWarehouse: No description available. ,
VMwareCloudSimple: No description available. ,
RedHatOsa: No description available. ,
Databricks: No description available. ,
AppService: No description available. ,
ManagedDisk: No description available. ,
BlockBlob: No description available. ,
RedisCache: No description available. ,
AzureDataExplorer: No description available. ,
MySql: No description available. ,
MariaDb: No description available. ,
PostgreSql: No description available. ,
DedicatedHost: No description available. ,
SapHana: No description available. ,
SqlAzureHybridBenefit: No description available. ,
AVS: No description available. ,
DataFactory: No description available. ,
NetAppStorage: No description available. ,
AzureFiles: No description available. ,
SqlEdge: No description available. ,
VirtualMachineSoftware: No description available. ,
}
,
Required: False ,
}
enum ,
instanceFlexibility:
{
Description: Allows reservation discount to be applied across skus within the same auto fit group. Not all skus support instance size flexibility. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Friendly name for user to easily identify the reservation ,
Required: False ,
}
string ,
appliedScopes:
{
Description: The list of applied scopes ,
Required: False ,
}
[
string ,
]
,
appliedScopeType:
{
Description: The applied scope type ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
archived:
{
Description: Indicates if the reservation is archived ,
Required: False ,
}
boolean ,
capabilities:
{
Description: Capabilities of the reservation ,
Required: False ,
}
string ,
quantity:
{
Description: Quantity of the skus that are part of the reservation. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: Current state of the reservation. ,
Enum:
{
Creating: No description available. ,
PendingResourceHold: No description available. ,
ConfirmedResourceHold: No description available. ,
PendingBilling: No description available. ,
ConfirmedBilling: No description available. ,
Created: No description available. ,
Succeeded: No description available. ,
Cancelled: No description available. ,
Expired: No description available. ,
BillingFailed: No description available. ,
Failed: No description available. ,
Split: No description available. ,
Merged: No description available. ,
}
,
Required: False ,
}
enum ,
effectiveDateTime:
{
Description: DateTime of the reservation starting when this version is effective from. ,
Format: date-time ,
Required: False ,
}
string ,
benefitStartTime:
{
Description: This is the DateTime when the reservation benefit started. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedDateTime:
{
Description: DateTime of the last time the reservation was updated. ,
Format: date-time ,
Required: False ,
}
string ,
expiryDate:
{
Description: This is the date when the reservation will expire. ,
Format: date ,
Required: False ,
}
string ,
expiryDateTime:
{
Description: This is the date-time when the reservation will expire. ,
Format: date-time ,
Required: False ,
}
string ,
reviewDateTime:
{
Description: This is the date-time when the Azure Hybrid Benefit needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
skuDescription:
{
Description: Description of the sku in english. ,
Required: False ,
}
string ,
extendedStatusInfo:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
{
statusCode:
{
Enum:
{
None: No description available. ,
Pending: No description available. ,
Processing: No description available. ,
Active: No description available. ,
PurchaseError: No description available. ,
PaymentInstrumentError: No description available. ,
Split: No description available. ,
Merged: No description available. ,
Expired: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
string ,
}
,
billingPlan:
{
Description: The billing plan options available for this sku. ,
Enum:
{
Upfront: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
displayProvisioningState:
{
Description: The provisioning state of the reservation for display, e.g. Succeeded ,
Required: False ,
}
string ,
provisioningSubState:
{
Description: The provisioning sub-state of the reservation, e.g. Succeeded ,
Required: False ,
}
string ,
purchaseDate:
{
Description: This is the date when the reservation was purchased. ,
Format: date ,
Required: False ,
}
string ,
purchaseDateTime:
{
Description: This is the date-time when the reservation was purchased. ,
Format: date-time ,
Required: False ,
}
string ,
splitProperties:
{
Description: Properties of reservation split ,
Required: False ,
}
{
splitDestinations:
{
Description: List of destination resource id that are created due to split. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
[
string ,
]
,
splitSource:
{
Description: Resource id of the reservation from which this is split. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
}
,
mergeProperties:
{
Description: Properties of reservation merge ,
Required: False ,
}
{
mergeDestination:
{
Description: Reservation resource id Created due to the merge. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
mergeSources:
{
Description: Resource ids of the source reservation's merged to form this reservation. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
[
string ,
]
,
}
,
swapProperties:
{
Description: Properties of reservation swap ,
Required: False ,
}
{
swapSource:
{
Description: Resource id of the source reservation that gets swapped. Format of the resource id is /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
swapDestination:
{
Description: Reservation resource id that the original resource gets swapped to. Format of the resource id is /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
}
,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the savings plan should apply benefit. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
billingScopeId:
{
Description: Subscription that will be charged for purchasing reservation or savings plan ,
Required: False ,
}
string ,
renew:
{
Description: Setting this to true will automatically purchase a new reservation on the expiration date time. ,
Required: False ,
}
boolean ,
renewSource:
{
Description: Reservation Id of the reservation from which this reservation is renewed. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}. ,
Required: False ,
}
string ,
renewDestination:
{
Description: Reservation Id of the reservation which is purchased because of renew. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}. ,
Required: False ,
}
string ,
renewProperties:
{
Description: The renew properties for a reservation. ,
Required: False ,
}
{
purchaseProperties:
{
Description: The request for reservation purchase ,
Required: False ,
}
{
sku:
{
Description: The name of sku ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
}
,
location:
{
Description: The Azure region where the reserved resource lives. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of reservation purchase request ,
Required: False ,
}
{
reservedResourceType:
{
Description: The type of the resource that is being reserved. In addition to below types we have also added the following: OpenAIPTU, MDC, Sentinel. ,
Enum:
{
VirtualMachines: No description available. ,
SqlDatabases: No description available. ,
SuseLinux: No description available. ,
CosmosDb: No description available. ,
RedHat: No description available. ,
SqlDataWarehouse: No description available. ,
VMwareCloudSimple: No description available. ,
RedHatOsa: No description available. ,
Databricks: No description available. ,
AppService: No description available. ,
ManagedDisk: No description available. ,
BlockBlob: No description available. ,
RedisCache: No description available. ,
AzureDataExplorer: No description available. ,
MySql: No description available. ,
MariaDb: No description available. ,
PostgreSql: No description available. ,
DedicatedHost: No description available. ,
SapHana: No description available. ,
SqlAzureHybridBenefit: No description available. ,
AVS: No description available. ,
DataFactory: No description available. ,
NetAppStorage: No description available. ,
AzureFiles: No description available. ,
SqlEdge: No description available. ,
VirtualMachineSoftware: No description available. ,
}
,
Required: False ,
}
enum ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing reservation or savings plan ,
Required: False ,
}
string ,
term:
{
Description: Represent the term of reservation. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
billingPlan:
{
Description: Represent the billing plans. ,
Enum:
{
Upfront: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
quantity:
{
Description: Quantity of the skus that are part of the reservation. ,
Format: int32 ,
Required: False ,
}
integer ,
displayName:
{
Description: Friendly name of the reservation ,
Required: False ,
}
string ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopes:
{
Description: List of the subscriptions that the benefit will be applied. Do not specify if AppliedScopeType is Shared. This property will be deprecated and replaced by appliedScopeProperties instead for Single AppliedScopeType. ,
Required: False ,
}
[
string ,
]
,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the savings plan should apply benefit. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
renew:
{
Description: Setting this to true will automatically purchase a new reservation on the expiration date time. ,
Required: False ,
}
boolean ,
reservedResourceProperties:
{
Description: Properties specific to each reserved resource type. Not required if not applicable. ,
Required: False ,
}
{
instanceFlexibility:
{
Description: Turning this on will apply the reservation discount to other VMs in the same VM size group. Only specify for VirtualMachines reserved resource type. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
reviewDateTime:
{
Description: This is the date-time when the Azure hybrid benefit needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
pricingCurrencyTotal:
{
Description: 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. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Required: False ,
}
number ,
}
,
billingCurrencyTotal:
{
Description: Currency and amount that customer will be charged in customer's local currency for renewal purchase. Tax is not included. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Required: False ,
}
number ,
}
,
}
,
term:
{
Description: Represent the term of reservation. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
userFriendlyAppliedScopeType:
{
Description: The applied scope type of the reservation for display, e.g. Shared ,
Required: False ,
}
string ,
userFriendlyRenewState:
{
Description: The renew state of the reservation for display, e.g. On ,
Required: False ,
}
string ,
utilization:
{
Description: Reservation utilization ,
Required: False ,
}
{
trend:
{
Description: last 7 day utilization trend for a reservation ,
Required: False ,
}
string ,
aggregates:
{
Description: The array of aggregates of a reservation's utilization ,
Required: False ,
}
[
{
grain:
{
Description: The grain of the aggregate ,
Required: False ,
}
number ,
grainUnit:
{
Description: The grain unit of the aggregate ,
Required: False ,
}
string ,
value:
{
Description: The aggregate value ,
Required: False ,
}
number ,
valueUnit:
{
Description: The aggregate value unit ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
kind:
{
Description: Resource Provider type to be reserved. ,
Enum:
{
Microsoft.Compute: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
reviewDateTime:
{
Description: This is the date-time when the Azure Hybrid Benefit needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
type:
{
Description: Type of resource. "Microsoft.Capacity/reservations" ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Extended error information including error code and error message ,
Required: False ,
}
{
code:
{
Description: Error code describing the reason that service is not able to process the incoming request ,
Enum:
{
NotSpecified: No description available. ,
InternalServerError: No description available. ,
ServerTimeout: No description available. ,
AuthorizationFailed: No description available. ,
BadRequest: No description available. ,
ClientCertificateThumbprintNotSet: No description available. ,
InvalidRequestContent: No description available. ,
OperationFailed: No description available. ,
HttpMethodNotSupported: No description available. ,
InvalidRequestUri: No description available. ,
MissingTenantId: No description available. ,
InvalidTenantId: No description available. ,
InvalidReservationOrderId: No description available. ,
InvalidReservationId: No description available. ,
ReservationIdNotInReservationOrder: No description available. ,
ReservationOrderNotFound: No description available. ,
InvalidSubscriptionId: No description available. ,
InvalidAccessToken: No description available. ,
InvalidLocationId: No description available. ,
UnauthenticatedRequestsThrottled: No description available. ,
InvalidHealthCheckType: No description available. ,
Forbidden: No description available. ,
BillingScopeIdCannotBeChanged: No description available. ,
AppliedScopesNotAssociatedWithCommerceAccount: No description available. ,
PatchValuesSameAsExisting: No description available. ,
RoleAssignmentCreationFailed: No description available. ,
ReservationOrderCreationFailed: No description available. ,
ReservationOrderNotEnabled: No description available. ,
CapacityUpdateScopesFailed: No description available. ,
UnsupportedReservationTerm: No description available. ,
ReservationOrderIdAlreadyExists: No description available. ,
RiskCheckFailed: No description available. ,
CreateQuoteFailed: No description available. ,
ActivateQuoteFailed: No description available. ,
NonsupportedAccountId: No description available. ,
PaymentInstrumentNotFound: No description available. ,
MissingAppliedScopesForSingle: No description available. ,
NoValidReservationsToReRate: No description available. ,
ReRateOnlyAllowedForEA: No description available. ,
OperationCannotBePerformedInCurrentState: No description available. ,
InvalidSingleAppliedScopesCount: No description available. ,
InvalidFulfillmentRequestParameters: No description available. ,
NotSupportedCountry: No description available. ,
InvalidRefundQuantity: No description available. ,
PurchaseError: No description available. ,
BillingCustomerInputError: No description available. ,
BillingPaymentInstrumentSoftError: No description available. ,
BillingPaymentInstrumentHardError: No description available. ,
BillingTransientError: No description available. ,
BillingError: No description available. ,
FulfillmentConfigurationError: No description available. ,
FulfillmentOutOfStockError: No description available. ,
FulfillmentTransientError: No description available. ,
FulfillmentError: No description available. ,
CalculatePriceFailed: No description available. ,
AppliedScopesSameAsExisting: No description available. ,
SelfServiceRefundNotSupported: No description available. ,
RefundLimitExceeded: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Required: False ,
}
string ,
}
,
}
Reservation_Split (updated)
Description :  Split a `Reservation` into two `Reservation`s with specified quantity distribution.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Reservation_Split",
  "$responses": {
    "200": {
      "$items": {
        "$properties": {
          "properties": [
            {
              "renewProperties": [
                {
                  "purchaseProperties": [
                    {
                      "properties": [
                        {
                          "#name": "reservedResourceType",
                          "Description": {
                            "new": "The type of the resource that is being reserved. In addition to below types we have also added the following: OpenAIPTU, MDC, Sentinel.",
                            "old": "The type of the resource that is being reserved."
                          }
                        }
                      ]
                    }
                  ]
                }
              ]
            }
          ]
        }
      }
    }
  }
}

⚼ Request

POST:  /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/split
{
reservationOrderId:
{
Description: Order Id of the reservation ,
Required: True ,
}
string ,
api-version:
{
Description: Supported version. ,
Required: True ,
}
string ,
body:
{
Description: Information needed to Split a reservation item ,
Required: True ,
}
{
properties:
{
Description: Properties for reservation split ,
Required: False ,
}
{
quantities:
{
Description: List of the quantities in the new reservations to create. ,
Required: False ,
}
[
integer ,
]
,
reservationId:
{
Description: Resource id of the reservation to be split. Format of the resource id should be /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
location:
{
Description: The Azure region where the reserved resource lives. ,
Required: False ,
}
string ,
etag:
{
Format: int32 ,
Required: False ,
}
integer ,
sku:
{
Description: The sku information associated to this reservation ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties associated to this reservation ,
Required: False ,
}
{
reservedResourceType:
{
Description: The type of the resource that is being reserved. ,
Enum:
{
VirtualMachines: No description available. ,
SqlDatabases: No description available. ,
SuseLinux: No description available. ,
CosmosDb: No description available. ,
RedHat: No description available. ,
SqlDataWarehouse: No description available. ,
VMwareCloudSimple: No description available. ,
RedHatOsa: No description available. ,
Databricks: No description available. ,
AppService: No description available. ,
ManagedDisk: No description available. ,
BlockBlob: No description available. ,
RedisCache: No description available. ,
AzureDataExplorer: No description available. ,
MySql: No description available. ,
MariaDb: No description available. ,
PostgreSql: No description available. ,
DedicatedHost: No description available. ,
SapHana: No description available. ,
SqlAzureHybridBenefit: No description available. ,
AVS: No description available. ,
DataFactory: No description available. ,
NetAppStorage: No description available. ,
AzureFiles: No description available. ,
SqlEdge: No description available. ,
VirtualMachineSoftware: No description available. ,
}
,
Required: False ,
}
enum ,
instanceFlexibility:
{
Description: Allows reservation discount to be applied across skus within the same auto fit group. Not all skus support instance size flexibility. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Friendly name for user to easily identify the reservation ,
Required: False ,
}
string ,
appliedScopes:
{
Description: The list of applied scopes ,
Required: False ,
}
[
string ,
]
,
appliedScopeType:
{
Description: The applied scope type ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
archived:
{
Description: Indicates if the reservation is archived ,
Required: False ,
}
boolean ,
capabilities:
{
Description: Capabilities of the reservation ,
Required: False ,
}
string ,
quantity:
{
Description: Quantity of the skus that are part of the reservation. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: Current state of the reservation. ,
Enum:
{
Creating: No description available. ,
PendingResourceHold: No description available. ,
ConfirmedResourceHold: No description available. ,
PendingBilling: No description available. ,
ConfirmedBilling: No description available. ,
Created: No description available. ,
Succeeded: No description available. ,
Cancelled: No description available. ,
Expired: No description available. ,
BillingFailed: No description available. ,
Failed: No description available. ,
Split: No description available. ,
Merged: No description available. ,
}
,
Required: False ,
}
enum ,
effectiveDateTime:
{
Description: DateTime of the reservation starting when this version is effective from. ,
Format: date-time ,
Required: False ,
}
string ,
benefitStartTime:
{
Description: This is the DateTime when the reservation benefit started. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedDateTime:
{
Description: DateTime of the last time the reservation was updated. ,
Format: date-time ,
Required: False ,
}
string ,
expiryDate:
{
Description: This is the date when the reservation will expire. ,
Format: date ,
Required: False ,
}
string ,
expiryDateTime:
{
Description: This is the date-time when the reservation will expire. ,
Format: date-time ,
Required: False ,
}
string ,
reviewDateTime:
{
Description: This is the date-time when the Azure Hybrid Benefit needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
skuDescription:
{
Description: Description of the sku in english. ,
Required: False ,
}
string ,
extendedStatusInfo:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
{
statusCode:
{
Enum:
{
None: No description available. ,
Pending: No description available. ,
Processing: No description available. ,
Active: No description available. ,
PurchaseError: No description available. ,
PaymentInstrumentError: No description available. ,
Split: No description available. ,
Merged: No description available. ,
Expired: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
string ,
}
,
billingPlan:
{
Description: The billing plan options available for this sku. ,
Enum:
{
Upfront: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
displayProvisioningState:
{
Description: The provisioning state of the reservation for display, e.g. Succeeded ,
Required: False ,
}
string ,
provisioningSubState:
{
Description: The provisioning sub-state of the reservation, e.g. Succeeded ,
Required: False ,
}
string ,
purchaseDate:
{
Description: This is the date when the reservation was purchased. ,
Format: date ,
Required: False ,
}
string ,
purchaseDateTime:
{
Description: This is the date-time when the reservation was purchased. ,
Format: date-time ,
Required: False ,
}
string ,
splitProperties:
{
Description: Properties of reservation split ,
Required: False ,
}
{
splitDestinations:
{
Description: List of destination resource id that are created due to split. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
[
string ,
]
,
splitSource:
{
Description: Resource id of the reservation from which this is split. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
}
,
mergeProperties:
{
Description: Properties of reservation merge ,
Required: False ,
}
{
mergeDestination:
{
Description: Reservation resource id Created due to the merge. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
mergeSources:
{
Description: Resource ids of the source reservation's merged to form this reservation. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
[
string ,
]
,
}
,
swapProperties:
{
Description: Properties of reservation swap ,
Required: False ,
}
{
swapSource:
{
Description: Resource id of the source reservation that gets swapped. Format of the resource id is /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
swapDestination:
{
Description: Reservation resource id that the original resource gets swapped to. Format of the resource id is /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
}
,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the savings plan should apply benefit. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
billingScopeId:
{
Description: Subscription that will be charged for purchasing reservation or savings plan ,
Required: False ,
}
string ,
renew:
{
Description: Setting this to true will automatically purchase a new reservation on the expiration date time. ,
Required: False ,
}
boolean ,
renewSource:
{
Description: Reservation Id of the reservation from which this reservation is renewed. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}. ,
Required: False ,
}
string ,
renewDestination:
{
Description: Reservation Id of the reservation which is purchased because of renew. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}. ,
Required: False ,
}
string ,
renewProperties:
{
Description: The renew properties for a reservation. ,
Required: False ,
}
{
purchaseProperties:
{
Description: The request for reservation purchase ,
Required: False ,
}
{
sku:
{
Description: The name of sku ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
}
,
location:
{
Description: The Azure region where the reserved resource lives. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of reservation purchase request ,
Required: False ,
}
{
reservedResourceType:
{
Description: The type of the resource that is being reserved. In addition to below types we have also added the following: OpenAIPTU, MDC, Sentinel. ,
Enum:
{
VirtualMachines: No description available. ,
SqlDatabases: No description available. ,
SuseLinux: No description available. ,
CosmosDb: No description available. ,
RedHat: No description available. ,
SqlDataWarehouse: No description available. ,
VMwareCloudSimple: No description available. ,
RedHatOsa: No description available. ,
Databricks: No description available. ,
AppService: No description available. ,
ManagedDisk: No description available. ,
BlockBlob: No description available. ,
RedisCache: No description available. ,
AzureDataExplorer: No description available. ,
MySql: No description available. ,
MariaDb: No description available. ,
PostgreSql: No description available. ,
DedicatedHost: No description available. ,
SapHana: No description available. ,
SqlAzureHybridBenefit: No description available. ,
AVS: No description available. ,
DataFactory: No description available. ,
NetAppStorage: No description available. ,
AzureFiles: No description available. ,
SqlEdge: No description available. ,
VirtualMachineSoftware: No description available. ,
}
,
Required: False ,
}
enum ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing reservation or savings plan ,
Required: False ,
}
string ,
term:
{
Description: Represent the term of reservation. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
billingPlan:
{
Description: Represent the billing plans. ,
Enum:
{
Upfront: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
quantity:
{
Description: Quantity of the skus that are part of the reservation. ,
Format: int32 ,
Required: False ,
}
integer ,
displayName:
{
Description: Friendly name of the reservation ,
Required: False ,
}
string ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopes:
{
Description: List of the subscriptions that the benefit will be applied. Do not specify if AppliedScopeType is Shared. This property will be deprecated and replaced by appliedScopeProperties instead for Single AppliedScopeType. ,
Required: False ,
}
[
string ,
]
,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the savings plan should apply benefit. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
renew:
{
Description: Setting this to true will automatically purchase a new reservation on the expiration date time. ,
Required: False ,
}
boolean ,
reservedResourceProperties:
{
Description: Properties specific to each reserved resource type. Not required if not applicable. ,
Required: False ,
}
{
instanceFlexibility:
{
Description: Turning this on will apply the reservation discount to other VMs in the same VM size group. Only specify for VirtualMachines reserved resource type. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
reviewDateTime:
{
Description: This is the date-time when the Azure hybrid benefit needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
pricingCurrencyTotal:
{
Description: 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. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Required: False ,
}
number ,
}
,
billingCurrencyTotal:
{
Description: Currency and amount that customer will be charged in customer's local currency for renewal purchase. Tax is not included. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Required: False ,
}
number ,
}
,
}
,
term:
{
Description: Represent the term of reservation. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
userFriendlyAppliedScopeType:
{
Description: The applied scope type of the reservation for display, e.g. Shared ,
Required: False ,
}
string ,
userFriendlyRenewState:
{
Description: The renew state of the reservation for display, e.g. On ,
Required: False ,
}
string ,
utilization:
{
Description: Reservation utilization ,
Required: False ,
}
{
trend:
{
Description: last 7 day utilization trend for a reservation ,
Required: False ,
}
string ,
aggregates:
{
Description: The array of aggregates of a reservation's utilization ,
Required: False ,
}
[
{
grain:
{
Description: The grain of the aggregate ,
Required: False ,
}
number ,
grainUnit:
{
Description: The grain unit of the aggregate ,
Required: False ,
}
string ,
value:
{
Description: The aggregate value ,
Required: False ,
}
number ,
valueUnit:
{
Description: The aggregate value unit ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
kind:
{
Description: Resource Provider type to be reserved. ,
Enum:
{
Microsoft.Compute: No description available. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (202)

{
location:
{
Description: URL for determining when an operation has completed. Only use this value only when Azure-AsyncOperation isn't returned. ,
}
string ,
retry-after:
{
Description: Clients should wait for the Retry-After interval before polling again ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: Extended error information including error code and error message ,
Required: False ,
}
{
code:
{
Description: Error code describing the reason that service is not able to process the incoming request ,
Enum:
{
NotSpecified: No description available. ,
InternalServerError: No description available. ,
ServerTimeout: No description available. ,
AuthorizationFailed: No description available. ,
BadRequest: No description available. ,
ClientCertificateThumbprintNotSet: No description available. ,
InvalidRequestContent: No description available. ,
OperationFailed: No description available. ,
HttpMethodNotSupported: No description available. ,
InvalidRequestUri: No description available. ,
MissingTenantId: No description available. ,
InvalidTenantId: No description available. ,
InvalidReservationOrderId: No description available. ,
InvalidReservationId: No description available. ,
ReservationIdNotInReservationOrder: No description available. ,
ReservationOrderNotFound: No description available. ,
InvalidSubscriptionId: No description available. ,
InvalidAccessToken: No description available. ,
InvalidLocationId: No description available. ,
UnauthenticatedRequestsThrottled: No description available. ,
InvalidHealthCheckType: No description available. ,
Forbidden: No description available. ,
BillingScopeIdCannotBeChanged: No description available. ,
AppliedScopesNotAssociatedWithCommerceAccount: No description available. ,
PatchValuesSameAsExisting: No description available. ,
RoleAssignmentCreationFailed: No description available. ,
ReservationOrderCreationFailed: No description available. ,
ReservationOrderNotEnabled: No description available. ,
CapacityUpdateScopesFailed: No description available. ,
UnsupportedReservationTerm: No description available. ,
ReservationOrderIdAlreadyExists: No description available. ,
RiskCheckFailed: No description available. ,
CreateQuoteFailed: No description available. ,
ActivateQuoteFailed: No description available. ,
NonsupportedAccountId: No description available. ,
PaymentInstrumentNotFound: No description available. ,
MissingAppliedScopesForSingle: No description available. ,
NoValidReservationsToReRate: No description available. ,
ReRateOnlyAllowedForEA: No description available. ,
OperationCannotBePerformedInCurrentState: No description available. ,
InvalidSingleAppliedScopesCount: No description available. ,
InvalidFulfillmentRequestParameters: No description available. ,
NotSupportedCountry: No description available. ,
InvalidRefundQuantity: No description available. ,
PurchaseError: No description available. ,
BillingCustomerInputError: No description available. ,
BillingPaymentInstrumentSoftError: No description available. ,
BillingPaymentInstrumentHardError: No description available. ,
BillingTransientError: No description available. ,
BillingError: No description available. ,
FulfillmentConfigurationError: No description available. ,
FulfillmentOutOfStockError: No description available. ,
FulfillmentTransientError: No description available. ,
FulfillmentError: No description available. ,
CalculatePriceFailed: No description available. ,
AppliedScopesSameAsExisting: No description available. ,
SelfServiceRefundNotSupported: No description available. ,
RefundLimitExceeded: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Required: False ,
}
string ,
}
,
}
Reservation_Merge (updated)
Description :  Merge the specified `Reservation`s into a new `Reservation`. The two `Reservation`s being merged must have same properties.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Reservation_Merge",
  "$responses": {
    "200": {
      "$items": {
        "$properties": {
          "properties": [
            {
              "renewProperties": [
                {
                  "purchaseProperties": [
                    {
                      "properties": [
                        {
                          "#name": "reservedResourceType",
                          "Description": {
                            "new": "The type of the resource that is being reserved. In addition to below types we have also added the following: OpenAIPTU, MDC, Sentinel.",
                            "old": "The type of the resource that is being reserved."
                          }
                        }
                      ]
                    }
                  ]
                }
              ]
            }
          ]
        }
      }
    }
  }
}

⚼ Request

POST:  /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/merge
{
reservationOrderId:
{
Description: Order Id of the reservation ,
Required: True ,
}
string ,
api-version:
{
Description: Supported version. ,
Required: True ,
}
string ,
body:
{
Description: Information needed for commercial request for a reservation ,
Required: True ,
}
{
properties:
{
Description: Properties for reservation merge ,
Required: False ,
}
{
sources:
{
Description: Format of the resource id should be /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
location:
{
Description: The Azure region where the reserved resource lives. ,
Required: False ,
}
string ,
etag:
{
Format: int32 ,
Required: False ,
}
integer ,
sku:
{
Description: The sku information associated to this reservation ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties associated to this reservation ,
Required: False ,
}
{
reservedResourceType:
{
Description: The type of the resource that is being reserved. ,
Enum:
{
VirtualMachines: No description available. ,
SqlDatabases: No description available. ,
SuseLinux: No description available. ,
CosmosDb: No description available. ,
RedHat: No description available. ,
SqlDataWarehouse: No description available. ,
VMwareCloudSimple: No description available. ,
RedHatOsa: No description available. ,
Databricks: No description available. ,
AppService: No description available. ,
ManagedDisk: No description available. ,
BlockBlob: No description available. ,
RedisCache: No description available. ,
AzureDataExplorer: No description available. ,
MySql: No description available. ,
MariaDb: No description available. ,
PostgreSql: No description available. ,
DedicatedHost: No description available. ,
SapHana: No description available. ,
SqlAzureHybridBenefit: No description available. ,
AVS: No description available. ,
DataFactory: No description available. ,
NetAppStorage: No description available. ,
AzureFiles: No description available. ,
SqlEdge: No description available. ,
VirtualMachineSoftware: No description available. ,
}
,
Required: False ,
}
enum ,
instanceFlexibility:
{
Description: Allows reservation discount to be applied across skus within the same auto fit group. Not all skus support instance size flexibility. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Friendly name for user to easily identify the reservation ,
Required: False ,
}
string ,
appliedScopes:
{
Description: The list of applied scopes ,
Required: False ,
}
[
string ,
]
,
appliedScopeType:
{
Description: The applied scope type ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
archived:
{
Description: Indicates if the reservation is archived ,
Required: False ,
}
boolean ,
capabilities:
{
Description: Capabilities of the reservation ,
Required: False ,
}
string ,
quantity:
{
Description: Quantity of the skus that are part of the reservation. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: Current state of the reservation. ,
Enum:
{
Creating: No description available. ,
PendingResourceHold: No description available. ,
ConfirmedResourceHold: No description available. ,
PendingBilling: No description available. ,
ConfirmedBilling: No description available. ,
Created: No description available. ,
Succeeded: No description available. ,
Cancelled: No description available. ,
Expired: No description available. ,
BillingFailed: No description available. ,
Failed: No description available. ,
Split: No description available. ,
Merged: No description available. ,
}
,
Required: False ,
}
enum ,
effectiveDateTime:
{
Description: DateTime of the reservation starting when this version is effective from. ,
Format: date-time ,
Required: False ,
}
string ,
benefitStartTime:
{
Description: This is the DateTime when the reservation benefit started. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedDateTime:
{
Description: DateTime of the last time the reservation was updated. ,
Format: date-time ,
Required: False ,
}
string ,
expiryDate:
{
Description: This is the date when the reservation will expire. ,
Format: date ,
Required: False ,
}
string ,
expiryDateTime:
{
Description: This is the date-time when the reservation will expire. ,
Format: date-time ,
Required: False ,
}
string ,
reviewDateTime:
{
Description: This is the date-time when the Azure Hybrid Benefit needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
skuDescription:
{
Description: Description of the sku in english. ,
Required: False ,
}
string ,
extendedStatusInfo:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
{
statusCode:
{
Enum:
{
None: No description available. ,
Pending: No description available. ,
Processing: No description available. ,
Active: No description available. ,
PurchaseError: No description available. ,
PaymentInstrumentError: No description available. ,
Split: No description available. ,
Merged: No description available. ,
Expired: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
string ,
}
,
billingPlan:
{
Description: The billing plan options available for this sku. ,
Enum:
{
Upfront: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
displayProvisioningState:
{
Description: The provisioning state of the reservation for display, e.g. Succeeded ,
Required: False ,
}
string ,
provisioningSubState:
{
Description: The provisioning sub-state of the reservation, e.g. Succeeded ,
Required: False ,
}
string ,
purchaseDate:
{
Description: This is the date when the reservation was purchased. ,
Format: date ,
Required: False ,
}
string ,
purchaseDateTime:
{
Description: This is the date-time when the reservation was purchased. ,
Format: date-time ,
Required: False ,
}
string ,
splitProperties:
{
Description: Properties of reservation split ,
Required: False ,
}
{
splitDestinations:
{
Description: List of destination resource id that are created due to split. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
[
string ,
]
,
splitSource:
{
Description: Resource id of the reservation from which this is split. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
}
,
mergeProperties:
{
Description: Properties of reservation merge ,
Required: False ,
}
{
mergeDestination:
{
Description: Reservation resource id Created due to the merge. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
mergeSources:
{
Description: Resource ids of the source reservation's merged to form this reservation. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
[
string ,
]
,
}
,
swapProperties:
{
Description: Properties of reservation swap ,
Required: False ,
}
{
swapSource:
{
Description: Resource id of the source reservation that gets swapped. Format of the resource id is /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
swapDestination:
{
Description: Reservation resource id that the original resource gets swapped to. Format of the resource id is /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
}
,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the savings plan should apply benefit. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
billingScopeId:
{
Description: Subscription that will be charged for purchasing reservation or savings plan ,
Required: False ,
}
string ,
renew:
{
Description: Setting this to true will automatically purchase a new reservation on the expiration date time. ,
Required: False ,
}
boolean ,
renewSource:
{
Description: Reservation Id of the reservation from which this reservation is renewed. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}. ,
Required: False ,
}
string ,
renewDestination:
{
Description: Reservation Id of the reservation which is purchased because of renew. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}. ,
Required: False ,
}
string ,
renewProperties:
{
Description: The renew properties for a reservation. ,
Required: False ,
}
{
purchaseProperties:
{
Description: The request for reservation purchase ,
Required: False ,
}
{
sku:
{
Description: The name of sku ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
}
,
location:
{
Description: The Azure region where the reserved resource lives. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of reservation purchase request ,
Required: False ,
}
{
reservedResourceType:
{
Description: The type of the resource that is being reserved. In addition to below types we have also added the following: OpenAIPTU, MDC, Sentinel. ,
Enum:
{
VirtualMachines: No description available. ,
SqlDatabases: No description available. ,
SuseLinux: No description available. ,
CosmosDb: No description available. ,
RedHat: No description available. ,
SqlDataWarehouse: No description available. ,
VMwareCloudSimple: No description available. ,
RedHatOsa: No description available. ,
Databricks: No description available. ,
AppService: No description available. ,
ManagedDisk: No description available. ,
BlockBlob: No description available. ,
RedisCache: No description available. ,
AzureDataExplorer: No description available. ,
MySql: No description available. ,
MariaDb: No description available. ,
PostgreSql: No description available. ,
DedicatedHost: No description available. ,
SapHana: No description available. ,
SqlAzureHybridBenefit: No description available. ,
AVS: No description available. ,
DataFactory: No description available. ,
NetAppStorage: No description available. ,
AzureFiles: No description available. ,
SqlEdge: No description available. ,
VirtualMachineSoftware: No description available. ,
}
,
Required: False ,
}
enum ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing reservation or savings plan ,
Required: False ,
}
string ,
term:
{
Description: Represent the term of reservation. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
billingPlan:
{
Description: Represent the billing plans. ,
Enum:
{
Upfront: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
quantity:
{
Description: Quantity of the skus that are part of the reservation. ,
Format: int32 ,
Required: False ,
}
integer ,
displayName:
{
Description: Friendly name of the reservation ,
Required: False ,
}
string ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopes:
{
Description: List of the subscriptions that the benefit will be applied. Do not specify if AppliedScopeType is Shared. This property will be deprecated and replaced by appliedScopeProperties instead for Single AppliedScopeType. ,
Required: False ,
}
[
string ,
]
,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the savings plan should apply benefit. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
renew:
{
Description: Setting this to true will automatically purchase a new reservation on the expiration date time. ,
Required: False ,
}
boolean ,
reservedResourceProperties:
{
Description: Properties specific to each reserved resource type. Not required if not applicable. ,
Required: False ,
}
{
instanceFlexibility:
{
Description: Turning this on will apply the reservation discount to other VMs in the same VM size group. Only specify for VirtualMachines reserved resource type. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
reviewDateTime:
{
Description: This is the date-time when the Azure hybrid benefit needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
pricingCurrencyTotal:
{
Description: 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. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Required: False ,
}
number ,
}
,
billingCurrencyTotal:
{
Description: Currency and amount that customer will be charged in customer's local currency for renewal purchase. Tax is not included. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Required: False ,
}
number ,
}
,
}
,
term:
{
Description: Represent the term of reservation. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
userFriendlyAppliedScopeType:
{
Description: The applied scope type of the reservation for display, e.g. Shared ,
Required: False ,
}
string ,
userFriendlyRenewState:
{
Description: The renew state of the reservation for display, e.g. On ,
Required: False ,
}
string ,
utilization:
{
Description: Reservation utilization ,
Required: False ,
}
{
trend:
{
Description: last 7 day utilization trend for a reservation ,
Required: False ,
}
string ,
aggregates:
{
Description: The array of aggregates of a reservation's utilization ,
Required: False ,
}
[
{
grain:
{
Description: The grain of the aggregate ,
Required: False ,
}
number ,
grainUnit:
{
Description: The grain unit of the aggregate ,
Required: False ,
}
string ,
value:
{
Description: The aggregate value ,
Required: False ,
}
number ,
valueUnit:
{
Description: The aggregate value unit ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
kind:
{
Description: Resource Provider type to be reserved. ,
Enum:
{
Microsoft.Compute: No description available. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (202)

{
location:
{
Description: URL for determining when an operation has completed. Only use this value only when Azure-AsyncOperation isn't returned. ,
}
string ,
retry-after:
{
Description: Clients should wait for the Retry-After interval before polling again ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: Extended error information including error code and error message ,
Required: False ,
}
{
code:
{
Description: Error code describing the reason that service is not able to process the incoming request ,
Enum:
{
NotSpecified: No description available. ,
InternalServerError: No description available. ,
ServerTimeout: No description available. ,
AuthorizationFailed: No description available. ,
BadRequest: No description available. ,
ClientCertificateThumbprintNotSet: No description available. ,
InvalidRequestContent: No description available. ,
OperationFailed: No description available. ,
HttpMethodNotSupported: No description available. ,
InvalidRequestUri: No description available. ,
MissingTenantId: No description available. ,
InvalidTenantId: No description available. ,
InvalidReservationOrderId: No description available. ,
InvalidReservationId: No description available. ,
ReservationIdNotInReservationOrder: No description available. ,
ReservationOrderNotFound: No description available. ,
InvalidSubscriptionId: No description available. ,
InvalidAccessToken: No description available. ,
InvalidLocationId: No description available. ,
UnauthenticatedRequestsThrottled: No description available. ,
InvalidHealthCheckType: No description available. ,
Forbidden: No description available. ,
BillingScopeIdCannotBeChanged: No description available. ,
AppliedScopesNotAssociatedWithCommerceAccount: No description available. ,
PatchValuesSameAsExisting: No description available. ,
RoleAssignmentCreationFailed: No description available. ,
ReservationOrderCreationFailed: No description available. ,
ReservationOrderNotEnabled: No description available. ,
CapacityUpdateScopesFailed: No description available. ,
UnsupportedReservationTerm: No description available. ,
ReservationOrderIdAlreadyExists: No description available. ,
RiskCheckFailed: No description available. ,
CreateQuoteFailed: No description available. ,
ActivateQuoteFailed: No description available. ,
NonsupportedAccountId: No description available. ,
PaymentInstrumentNotFound: No description available. ,
MissingAppliedScopesForSingle: No description available. ,
NoValidReservationsToReRate: No description available. ,
ReRateOnlyAllowedForEA: No description available. ,
OperationCannotBePerformedInCurrentState: No description available. ,
InvalidSingleAppliedScopesCount: No description available. ,
InvalidFulfillmentRequestParameters: No description available. ,
NotSupportedCountry: No description available. ,
InvalidRefundQuantity: No description available. ,
PurchaseError: No description available. ,
BillingCustomerInputError: No description available. ,
BillingPaymentInstrumentSoftError: No description available. ,
BillingPaymentInstrumentHardError: No description available. ,
BillingTransientError: No description available. ,
BillingError: No description available. ,
FulfillmentConfigurationError: No description available. ,
FulfillmentOutOfStockError: No description available. ,
FulfillmentTransientError: No description available. ,
FulfillmentError: No description available. ,
CalculatePriceFailed: No description available. ,
AppliedScopesSameAsExisting: No description available. ,
SelfServiceRefundNotSupported: No description available. ,
RefundLimitExceeded: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Required: False ,
}
string ,
}
,
}
Reservation_List (updated)
Description :  List `Reservation`s within a single `ReservationOrder`.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Reservation_List",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "renewProperties": [
                  {
                    "purchaseProperties": [
                      {
                        "properties": [
                          {
                            "#name": "reservedResourceType",
                            "Description": {
                              "new": "The type of the resource that is being reserved. In addition to below types we have also added the following: OpenAIPTU, MDC, Sentinel.",
                              "old": "The type of the resource that is being reserved."
                            }
                          }
                        ]
                      }
                    ]
                  }
                ]
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations
{
reservationOrderId:
{
Description: Order Id of the reservation ,
Required: True ,
}
string ,
api-version:
{
Description: Supported version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
location:
{
Description: The Azure region where the reserved resource lives. ,
Required: False ,
}
string ,
etag:
{
Format: int32 ,
Required: False ,
}
integer ,
sku:
{
Description: The sku information associated to this reservation ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties associated to this reservation ,
Required: False ,
}
{
reservedResourceType:
{
Description: The type of the resource that is being reserved. ,
Enum:
{
VirtualMachines: No description available. ,
SqlDatabases: No description available. ,
SuseLinux: No description available. ,
CosmosDb: No description available. ,
RedHat: No description available. ,
SqlDataWarehouse: No description available. ,
VMwareCloudSimple: No description available. ,
RedHatOsa: No description available. ,
Databricks: No description available. ,
AppService: No description available. ,
ManagedDisk: No description available. ,
BlockBlob: No description available. ,
RedisCache: No description available. ,
AzureDataExplorer: No description available. ,
MySql: No description available. ,
MariaDb: No description available. ,
PostgreSql: No description available. ,
DedicatedHost: No description available. ,
SapHana: No description available. ,
SqlAzureHybridBenefit: No description available. ,
AVS: No description available. ,
DataFactory: No description available. ,
NetAppStorage: No description available. ,
AzureFiles: No description available. ,
SqlEdge: No description available. ,
VirtualMachineSoftware: No description available. ,
}
,
Required: False ,
}
enum ,
instanceFlexibility:
{
Description: Allows reservation discount to be applied across skus within the same auto fit group. Not all skus support instance size flexibility. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Friendly name for user to easily identify the reservation ,
Required: False ,
}
string ,
appliedScopes:
{
Description: The list of applied scopes ,
Required: False ,
}
[
string ,
]
,
appliedScopeType:
{
Description: The applied scope type ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
archived:
{
Description: Indicates if the reservation is archived ,
Required: False ,
}
boolean ,
capabilities:
{
Description: Capabilities of the reservation ,
Required: False ,
}
string ,
quantity:
{
Description: Quantity of the skus that are part of the reservation. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: Current state of the reservation. ,
Enum:
{
Creating: No description available. ,
PendingResourceHold: No description available. ,
ConfirmedResourceHold: No description available. ,
PendingBilling: No description available. ,
ConfirmedBilling: No description available. ,
Created: No description available. ,
Succeeded: No description available. ,
Cancelled: No description available. ,
Expired: No description available. ,
BillingFailed: No description available. ,
Failed: No description available. ,
Split: No description available. ,
Merged: No description available. ,
}
,
Required: False ,
}
enum ,
effectiveDateTime:
{
Description: DateTime of the reservation starting when this version is effective from. ,
Format: date-time ,
Required: False ,
}
string ,
benefitStartTime:
{
Description: This is the DateTime when the reservation benefit started. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedDateTime:
{
Description: DateTime of the last time the reservation was updated. ,
Format: date-time ,
Required: False ,
}
string ,
expiryDate:
{
Description: This is the date when the reservation will expire. ,
Format: date ,
Required: False ,
}
string ,
expiryDateTime:
{
Description: This is the date-time when the reservation will expire. ,
Format: date-time ,
Required: False ,
}
string ,
reviewDateTime:
{
Description: This is the date-time when the Azure Hybrid Benefit needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
skuDescription:
{
Description: Description of the sku in english. ,
Required: False ,
}
string ,
extendedStatusInfo:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
{
statusCode:
{
Enum:
{
None: No description available. ,
Pending: No description available. ,
Processing: No description available. ,
Active: No description available. ,
PurchaseError: No description available. ,
PaymentInstrumentError: No description available. ,
Split: No description available. ,
Merged: No description available. ,
Expired: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
string ,
}
,
billingPlan:
{
Description: The billing plan options available for this sku. ,
Enum:
{
Upfront: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
displayProvisioningState:
{
Description: The provisioning state of the reservation for display, e.g. Succeeded ,
Required: False ,
}
string ,
provisioningSubState:
{
Description: The provisioning sub-state of the reservation, e.g. Succeeded ,
Required: False ,
}
string ,
purchaseDate:
{
Description: This is the date when the reservation was purchased. ,
Format: date ,
Required: False ,
}
string ,
purchaseDateTime:
{
Description: This is the date-time when the reservation was purchased. ,
Format: date-time ,
Required: False ,
}
string ,
splitProperties:
{
Description: Properties of reservation split ,
Required: False ,
}
{
splitDestinations:
{
Description: List of destination resource id that are created due to split. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
[
string ,
]
,
splitSource:
{
Description: Resource id of the reservation from which this is split. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
}
,
mergeProperties:
{
Description: Properties of reservation merge ,
Required: False ,
}
{
mergeDestination:
{
Description: Reservation resource id Created due to the merge. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
mergeSources:
{
Description: Resource ids of the source reservation's merged to form this reservation. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
[
string ,
]
,
}
,
swapProperties:
{
Description: Properties of reservation swap ,
Required: False ,
}
{
swapSource:
{
Description: Resource id of the source reservation that gets swapped. Format of the resource id is /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
swapDestination:
{
Description: Reservation resource id that the original resource gets swapped to. Format of the resource id is /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
}
,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the savings plan should apply benefit. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
billingScopeId:
{
Description: Subscription that will be charged for purchasing reservation or savings plan ,
Required: False ,
}
string ,
renew:
{
Description: Setting this to true will automatically purchase a new reservation on the expiration date time. ,
Required: False ,
}
boolean ,
renewSource:
{
Description: Reservation Id of the reservation from which this reservation is renewed. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}. ,
Required: False ,
}
string ,
renewDestination:
{
Description: Reservation Id of the reservation which is purchased because of renew. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}. ,
Required: False ,
}
string ,
renewProperties:
{
Description: The renew properties for a reservation. ,
Required: False ,
}
{
purchaseProperties:
{
Description: The request for reservation purchase ,
Required: False ,
}
{
sku:
{
Description: The name of sku ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
}
,
location:
{
Description: The Azure region where the reserved resource lives. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of reservation purchase request ,
Required: False ,
}
{
reservedResourceType:
{
Description: The type of the resource that is being reserved. In addition to below types we have also added the following: OpenAIPTU, MDC, Sentinel. ,
Enum:
{
VirtualMachines: No description available. ,
SqlDatabases: No description available. ,
SuseLinux: No description available. ,
CosmosDb: No description available. ,
RedHat: No description available. ,
SqlDataWarehouse: No description available. ,
VMwareCloudSimple: No description available. ,
RedHatOsa: No description available. ,
Databricks: No description available. ,
AppService: No description available. ,
ManagedDisk: No description available. ,
BlockBlob: No description available. ,
RedisCache: No description available. ,
AzureDataExplorer: No description available. ,
MySql: No description available. ,
MariaDb: No description available. ,
PostgreSql: No description available. ,
DedicatedHost: No description available. ,
SapHana: No description available. ,
SqlAzureHybridBenefit: No description available. ,
AVS: No description available. ,
DataFactory: No description available. ,
NetAppStorage: No description available. ,
AzureFiles: No description available. ,
SqlEdge: No description available. ,
VirtualMachineSoftware: No description available. ,
}
,
Required: False ,
}
enum ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing reservation or savings plan ,
Required: False ,
}
string ,
term:
{
Description: Represent the term of reservation. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
billingPlan:
{
Description: Represent the billing plans. ,
Enum:
{
Upfront: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
quantity:
{
Description: Quantity of the skus that are part of the reservation. ,
Format: int32 ,
Required: False ,
}
integer ,
displayName:
{
Description: Friendly name of the reservation ,
Required: False ,
}
string ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopes:
{
Description: List of the subscriptions that the benefit will be applied. Do not specify if AppliedScopeType is Shared. This property will be deprecated and replaced by appliedScopeProperties instead for Single AppliedScopeType. ,
Required: False ,
}
[
string ,
]
,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the savings plan should apply benefit. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
renew:
{
Description: Setting this to true will automatically purchase a new reservation on the expiration date time. ,
Required: False ,
}
boolean ,
reservedResourceProperties:
{
Description: Properties specific to each reserved resource type. Not required if not applicable. ,
Required: False ,
}
{
instanceFlexibility:
{
Description: Turning this on will apply the reservation discount to other VMs in the same VM size group. Only specify for VirtualMachines reserved resource type. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
reviewDateTime:
{
Description: This is the date-time when the Azure hybrid benefit needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
pricingCurrencyTotal:
{
Description: 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. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Required: False ,
}
number ,
}
,
billingCurrencyTotal:
{
Description: Currency and amount that customer will be charged in customer's local currency for renewal purchase. Tax is not included. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Required: False ,
}
number ,
}
,
}
,
term:
{
Description: Represent the term of reservation. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
userFriendlyAppliedScopeType:
{
Description: The applied scope type of the reservation for display, e.g. Shared ,
Required: False ,
}
string ,
userFriendlyRenewState:
{
Description: The renew state of the reservation for display, e.g. On ,
Required: False ,
}
string ,
utilization:
{
Description: Reservation utilization ,
Required: False ,
}
{
trend:
{
Description: last 7 day utilization trend for a reservation ,
Required: False ,
}
string ,
aggregates:
{
Description: The array of aggregates of a reservation's utilization ,
Required: False ,
}
[
{
grain:
{
Description: The grain of the aggregate ,
Required: False ,
}
number ,
grainUnit:
{
Description: The grain unit of the aggregate ,
Required: False ,
}
string ,
value:
{
Description: The aggregate value ,
Required: False ,
}
number ,
valueUnit:
{
Description: The aggregate value unit ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
kind:
{
Description: Resource Provider type to be reserved. ,
Enum:
{
Microsoft.Compute: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: Url to get the next page of reservations. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Extended error information including error code and error message ,
Required: False ,
}
{
code:
{
Description: Error code describing the reason that service is not able to process the incoming request ,
Enum:
{
NotSpecified: No description available. ,
InternalServerError: No description available. ,
ServerTimeout: No description available. ,
AuthorizationFailed: No description available. ,
BadRequest: No description available. ,
ClientCertificateThumbprintNotSet: No description available. ,
InvalidRequestContent: No description available. ,
OperationFailed: No description available. ,
HttpMethodNotSupported: No description available. ,
InvalidRequestUri: No description available. ,
MissingTenantId: No description available. ,
InvalidTenantId: No description available. ,
InvalidReservationOrderId: No description available. ,
InvalidReservationId: No description available. ,
ReservationIdNotInReservationOrder: No description available. ,
ReservationOrderNotFound: No description available. ,
InvalidSubscriptionId: No description available. ,
InvalidAccessToken: No description available. ,
InvalidLocationId: No description available. ,
UnauthenticatedRequestsThrottled: No description available. ,
InvalidHealthCheckType: No description available. ,
Forbidden: No description available. ,
BillingScopeIdCannotBeChanged: No description available. ,
AppliedScopesNotAssociatedWithCommerceAccount: No description available. ,
PatchValuesSameAsExisting: No description available. ,
RoleAssignmentCreationFailed: No description available. ,
ReservationOrderCreationFailed: No description available. ,
ReservationOrderNotEnabled: No description available. ,
CapacityUpdateScopesFailed: No description available. ,
UnsupportedReservationTerm: No description available. ,
ReservationOrderIdAlreadyExists: No description available. ,
RiskCheckFailed: No description available. ,
CreateQuoteFailed: No description available. ,
ActivateQuoteFailed: No description available. ,
NonsupportedAccountId: No description available. ,
PaymentInstrumentNotFound: No description available. ,
MissingAppliedScopesForSingle: No description available. ,
NoValidReservationsToReRate: No description available. ,
ReRateOnlyAllowedForEA: No description available. ,
OperationCannotBePerformedInCurrentState: No description available. ,
InvalidSingleAppliedScopesCount: No description available. ,
InvalidFulfillmentRequestParameters: No description available. ,
NotSupportedCountry: No description available. ,
InvalidRefundQuantity: No description available. ,
PurchaseError: No description available. ,
BillingCustomerInputError: No description available. ,
BillingPaymentInstrumentSoftError: No description available. ,
BillingPaymentInstrumentHardError: No description available. ,
BillingTransientError: No description available. ,
BillingError: No description available. ,
FulfillmentConfigurationError: No description available. ,
FulfillmentOutOfStockError: No description available. ,
FulfillmentTransientError: No description available. ,
FulfillmentError: No description available. ,
CalculatePriceFailed: No description available. ,
AppliedScopesSameAsExisting: No description available. ,
SelfServiceRefundNotSupported: No description available. ,
RefundLimitExceeded: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Required: False ,
}
string ,
}
,
}
Reservation_Get (updated)
Description :  Get specific `Reservation` details.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Reservation_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "renewProperties": [
              {
                "purchaseProperties": [
                  {
                    "properties": [
                      {
                        "#name": "reservedResourceType",
                        "Description": {
                          "new": "The type of the resource that is being reserved. In addition to below types we have also added the following: OpenAIPTU, MDC, Sentinel.",
                          "old": "The type of the resource that is being reserved."
                        }
                      }
                    ]
                  }
                ]
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}
{
reservationOrderId:
{
Description: Order Id of the reservation ,
Required: True ,
}
string ,
reservationId:
{
Description: Id of the reservation item ,
Required: True ,
}
string ,
api-version:
{
Description: Supported version. ,
Required: True ,
}
string ,
$expand:
{
Description: Supported value of this query is renewProperties ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
location:
{
Description: The Azure region where the reserved resource lives. ,
Required: False ,
}
string ,
etag:
{
Format: int32 ,
Required: False ,
}
integer ,
sku:
{
Description: The sku information associated to this reservation ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties associated to this reservation ,
Required: False ,
}
{
reservedResourceType:
{
Description: The type of the resource that is being reserved. ,
Enum:
{
VirtualMachines: No description available. ,
SqlDatabases: No description available. ,
SuseLinux: No description available. ,
CosmosDb: No description available. ,
RedHat: No description available. ,
SqlDataWarehouse: No description available. ,
VMwareCloudSimple: No description available. ,
RedHatOsa: No description available. ,
Databricks: No description available. ,
AppService: No description available. ,
ManagedDisk: No description available. ,
BlockBlob: No description available. ,
RedisCache: No description available. ,
AzureDataExplorer: No description available. ,
MySql: No description available. ,
MariaDb: No description available. ,
PostgreSql: No description available. ,
DedicatedHost: No description available. ,
SapHana: No description available. ,
SqlAzureHybridBenefit: No description available. ,
AVS: No description available. ,
DataFactory: No description available. ,
NetAppStorage: No description available. ,
AzureFiles: No description available. ,
SqlEdge: No description available. ,
VirtualMachineSoftware: No description available. ,
}
,
Required: False ,
}
enum ,
instanceFlexibility:
{
Description: Allows reservation discount to be applied across skus within the same auto fit group. Not all skus support instance size flexibility. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Friendly name for user to easily identify the reservation ,
Required: False ,
}
string ,
appliedScopes:
{
Description: The list of applied scopes ,
Required: False ,
}
[
string ,
]
,
appliedScopeType:
{
Description: The applied scope type ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
archived:
{
Description: Indicates if the reservation is archived ,
Required: False ,
}
boolean ,
capabilities:
{
Description: Capabilities of the reservation ,
Required: False ,
}
string ,
quantity:
{
Description: Quantity of the skus that are part of the reservation. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: Current state of the reservation. ,
Enum:
{
Creating: No description available. ,
PendingResourceHold: No description available. ,
ConfirmedResourceHold: No description available. ,
PendingBilling: No description available. ,
ConfirmedBilling: No description available. ,
Created: No description available. ,
Succeeded: No description available. ,
Cancelled: No description available. ,
Expired: No description available. ,
BillingFailed: No description available. ,
Failed: No description available. ,
Split: No description available. ,
Merged: No description available. ,
}
,
Required: False ,
}
enum ,
effectiveDateTime:
{
Description: DateTime of the reservation starting when this version is effective from. ,
Format: date-time ,
Required: False ,
}
string ,
benefitStartTime:
{
Description: This is the DateTime when the reservation benefit started. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedDateTime:
{
Description: DateTime of the last time the reservation was updated. ,
Format: date-time ,
Required: False ,
}
string ,
expiryDate:
{
Description: This is the date when the reservation will expire. ,
Format: date ,
Required: False ,
}
string ,
expiryDateTime:
{
Description: This is the date-time when the reservation will expire. ,
Format: date-time ,
Required: False ,
}
string ,
reviewDateTime:
{
Description: This is the date-time when the Azure Hybrid Benefit needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
skuDescription:
{
Description: Description of the sku in english. ,
Required: False ,
}
string ,
extendedStatusInfo:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
{
statusCode:
{
Enum:
{
None: No description available. ,
Pending: No description available. ,
Processing: No description available. ,
Active: No description available. ,
PurchaseError: No description available. ,
PaymentInstrumentError: No description available. ,
Split: No description available. ,
Merged: No description available. ,
Expired: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
string ,
}
,
billingPlan:
{
Description: The billing plan options available for this sku. ,
Enum:
{
Upfront: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
displayProvisioningState:
{
Description: The provisioning state of the reservation for display, e.g. Succeeded ,
Required: False ,
}
string ,
provisioningSubState:
{
Description: The provisioning sub-state of the reservation, e.g. Succeeded ,
Required: False ,
}
string ,
purchaseDate:
{
Description: This is the date when the reservation was purchased. ,
Format: date ,
Required: False ,
}
string ,
purchaseDateTime:
{
Description: This is the date-time when the reservation was purchased. ,
Format: date-time ,
Required: False ,
}
string ,
splitProperties:
{
Description: Properties of reservation split ,
Required: False ,
}
{
splitDestinations:
{
Description: List of destination resource id that are created due to split. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
[
string ,
]
,
splitSource:
{
Description: Resource id of the reservation from which this is split. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
}
,
mergeProperties:
{
Description: Properties of reservation merge ,
Required: False ,
}
{
mergeDestination:
{
Description: Reservation resource id Created due to the merge. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
mergeSources:
{
Description: Resource ids of the source reservation's merged to form this reservation. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
[
string ,
]
,
}
,
swapProperties:
{
Description: Properties of reservation swap ,
Required: False ,
}
{
swapSource:
{
Description: Resource id of the source reservation that gets swapped. Format of the resource id is /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
swapDestination:
{
Description: Reservation resource id that the original resource gets swapped to. Format of the resource id is /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
}
,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the savings plan should apply benefit. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
billingScopeId:
{
Description: Subscription that will be charged for purchasing reservation or savings plan ,
Required: False ,
}
string ,
renew:
{
Description: Setting this to true will automatically purchase a new reservation on the expiration date time. ,
Required: False ,
}
boolean ,
renewSource:
{
Description: Reservation Id of the reservation from which this reservation is renewed. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}. ,
Required: False ,
}
string ,
renewDestination:
{
Description: Reservation Id of the reservation which is purchased because of renew. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}. ,
Required: False ,
}
string ,
renewProperties:
{
Description: The renew properties for a reservation. ,
Required: False ,
}
{
purchaseProperties:
{
Description: The request for reservation purchase ,
Required: False ,
}
{
sku:
{
Description: The name of sku ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
}
,
location:
{
Description: The Azure region where the reserved resource lives. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of reservation purchase request ,
Required: False ,
}
{
reservedResourceType:
{
Description: The type of the resource that is being reserved. In addition to below types we have also added the following: OpenAIPTU, MDC, Sentinel. ,
Enum:
{
VirtualMachines: No description available. ,
SqlDatabases: No description available. ,
SuseLinux: No description available. ,
CosmosDb: No description available. ,
RedHat: No description available. ,
SqlDataWarehouse: No description available. ,
VMwareCloudSimple: No description available. ,
RedHatOsa: No description available. ,
Databricks: No description available. ,
AppService: No description available. ,
ManagedDisk: No description available. ,
BlockBlob: No description available. ,
RedisCache: No description available. ,
AzureDataExplorer: No description available. ,
MySql: No description available. ,
MariaDb: No description available. ,
PostgreSql: No description available. ,
DedicatedHost: No description available. ,
SapHana: No description available. ,
SqlAzureHybridBenefit: No description available. ,
AVS: No description available. ,
DataFactory: No description available. ,
NetAppStorage: No description available. ,
AzureFiles: No description available. ,
SqlEdge: No description available. ,
VirtualMachineSoftware: No description available. ,
}
,
Required: False ,
}
enum ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing reservation or savings plan ,
Required: False ,
}
string ,
term:
{
Description: Represent the term of reservation. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
billingPlan:
{
Description: Represent the billing plans. ,
Enum:
{
Upfront: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
quantity:
{
Description: Quantity of the skus that are part of the reservation. ,
Format: int32 ,
Required: False ,
}
integer ,
displayName:
{
Description: Friendly name of the reservation ,
Required: False ,
}
string ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopes:
{
Description: List of the subscriptions that the benefit will be applied. Do not specify if AppliedScopeType is Shared. This property will be deprecated and replaced by appliedScopeProperties instead for Single AppliedScopeType. ,
Required: False ,
}
[
string ,
]
,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the savings plan should apply benefit. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
renew:
{
Description: Setting this to true will automatically purchase a new reservation on the expiration date time. ,
Required: False ,
}
boolean ,
reservedResourceProperties:
{
Description: Properties specific to each reserved resource type. Not required if not applicable. ,
Required: False ,
}
{
instanceFlexibility:
{
Description: Turning this on will apply the reservation discount to other VMs in the same VM size group. Only specify for VirtualMachines reserved resource type. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
reviewDateTime:
{
Description: This is the date-time when the Azure hybrid benefit needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
pricingCurrencyTotal:
{
Description: 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. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Required: False ,
}
number ,
}
,
billingCurrencyTotal:
{
Description: Currency and amount that customer will be charged in customer's local currency for renewal purchase. Tax is not included. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Required: False ,
}
number ,
}
,
}
,
term:
{
Description: Represent the term of reservation. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
userFriendlyAppliedScopeType:
{
Description: The applied scope type of the reservation for display, e.g. Shared ,
Required: False ,
}
string ,
userFriendlyRenewState:
{
Description: The renew state of the reservation for display, e.g. On ,
Required: False ,
}
string ,
utilization:
{
Description: Reservation utilization ,
Required: False ,
}
{
trend:
{
Description: last 7 day utilization trend for a reservation ,
Required: False ,
}
string ,
aggregates:
{
Description: The array of aggregates of a reservation's utilization ,
Required: False ,
}
[
{
grain:
{
Description: The grain of the aggregate ,
Required: False ,
}
number ,
grainUnit:
{
Description: The grain unit of the aggregate ,
Required: False ,
}
string ,
value:
{
Description: The aggregate value ,
Required: False ,
}
number ,
valueUnit:
{
Description: The aggregate value unit ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
kind:
{
Description: Resource Provider type to be reserved. ,
Enum:
{
Microsoft.Compute: No description available. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: Extended error information including error code and error message ,
Required: False ,
}
{
code:
{
Description: Error code describing the reason that service is not able to process the incoming request ,
Enum:
{
NotSpecified: No description available. ,
InternalServerError: No description available. ,
ServerTimeout: No description available. ,
AuthorizationFailed: No description available. ,
BadRequest: No description available. ,
ClientCertificateThumbprintNotSet: No description available. ,
InvalidRequestContent: No description available. ,
OperationFailed: No description available. ,
HttpMethodNotSupported: No description available. ,
InvalidRequestUri: No description available. ,
MissingTenantId: No description available. ,
InvalidTenantId: No description available. ,
InvalidReservationOrderId: No description available. ,
InvalidReservationId: No description available. ,
ReservationIdNotInReservationOrder: No description available. ,
ReservationOrderNotFound: No description available. ,
InvalidSubscriptionId: No description available. ,
InvalidAccessToken: No description available. ,
InvalidLocationId: No description available. ,
UnauthenticatedRequestsThrottled: No description available. ,
InvalidHealthCheckType: No description available. ,
Forbidden: No description available. ,
BillingScopeIdCannotBeChanged: No description available. ,
AppliedScopesNotAssociatedWithCommerceAccount: No description available. ,
PatchValuesSameAsExisting: No description available. ,
RoleAssignmentCreationFailed: No description available. ,
ReservationOrderCreationFailed: No description available. ,
ReservationOrderNotEnabled: No description available. ,
CapacityUpdateScopesFailed: No description available. ,
UnsupportedReservationTerm: No description available. ,
ReservationOrderIdAlreadyExists: No description available. ,
RiskCheckFailed: No description available. ,
CreateQuoteFailed: No description available. ,
ActivateQuoteFailed: No description available. ,
NonsupportedAccountId: No description available. ,
PaymentInstrumentNotFound: No description available. ,
MissingAppliedScopesForSingle: No description available. ,
NoValidReservationsToReRate: No description available. ,
ReRateOnlyAllowedForEA: No description available. ,
OperationCannotBePerformedInCurrentState: No description available. ,
InvalidSingleAppliedScopesCount: No description available. ,
InvalidFulfillmentRequestParameters: No description available. ,
NotSupportedCountry: No description available. ,
InvalidRefundQuantity: No description available. ,
PurchaseError: No description available. ,
BillingCustomerInputError: No description available. ,
BillingPaymentInstrumentSoftError: No description available. ,
BillingPaymentInstrumentHardError: No description available. ,
BillingTransientError: No description available. ,
BillingError: No description available. ,
FulfillmentConfigurationError: No description available. ,
FulfillmentOutOfStockError: No description available. ,
FulfillmentTransientError: No description available. ,
FulfillmentError: No description available. ,
CalculatePriceFailed: No description available. ,
AppliedScopesSameAsExisting: No description available. ,
SelfServiceRefundNotSupported: No description available. ,
RefundLimitExceeded: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Required: False ,
}
string ,
}
,
}
Reservation_Update (updated)
Description :  Updates the applied scopes of the `Reservation`.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Reservation_Update",
  "$parameters": {
    "parameters": {
      "$properties": {
        "properties": [
          {
            "renewProperties": [
              {
                "purchaseProperties": [
                  {
                    "properties": [
                      {
                        "#name": "reservedResourceType",
                        "Description": {
                          "new": "The type of the resource that is being reserved. In addition to below types we have also added the following: OpenAIPTU, MDC, Sentinel.",
                          "old": "The type of the resource that is being reserved."
                        }
                      }
                    ]
                  }
                ]
              }
            ]
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "renewProperties": [
              {
                "purchaseProperties": [
                  {
                    "properties": [
                      {
                        "#name": "reservedResourceType",
                        "Description": {
                          "new": "The type of the resource that is being reserved. In addition to below types we have also added the following: OpenAIPTU, MDC, Sentinel.",
                          "old": "The type of the resource that is being reserved."
                        }
                      }
                    ]
                  }
                ]
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

PATCH:  /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}
{
reservationOrderId:
{
Description: Order Id of the reservation ,
Required: True ,
}
string ,
reservationId:
{
Description: Id of the reservation item ,
Required: True ,
}
string ,
api-version:
{
Description: Supported version. ,
Required: True ,
}
string ,
parameters:
{
Description: Information needed to patch a reservation item ,
Required: True ,
}
{
properties:
{
Description: Properties for reservation patch ,
Required: False ,
}
{
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopes:
{
Description: List of the subscriptions that the benefit will be applied. Do not specify if AppliedScopeType is Shared. This property will be deprecated and replaced by appliedScopeProperties instead for Single AppliedScopeType. ,
Required: False ,
}
[
string ,
]
,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the savings plan should apply benefit. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
instanceFlexibility:
{
Description: Turning this on will apply the reservation discount to other VMs in the same VM size group. Only specify for VirtualMachines reserved resource type. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: Display name of the reservation ,
Required: False ,
}
string ,
renew:
{
Description: Setting this to true will automatically purchase a new reservation on the expiration date time. ,
Required: False ,
}
boolean ,
renewProperties:
{
Required: False ,
}
{
purchaseProperties:
{
Description: The request for reservation purchase ,
Required: False ,
}
{
sku:
{
Description: The name of sku ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
}
,
location:
{
Description: The Azure region where the reserved resource lives. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of reservation purchase request ,
Required: False ,
}
{
reservedResourceType:
{
Description: The type of the resource that is being reserved. In addition to below types we have also added the following: OpenAIPTU, MDC, Sentinel. ,
Enum:
{
VirtualMachines: No description available. ,
SqlDatabases: No description available. ,
SuseLinux: No description available. ,
CosmosDb: No description available. ,
RedHat: No description available. ,
SqlDataWarehouse: No description available. ,
VMwareCloudSimple: No description available. ,
RedHatOsa: No description available. ,
Databricks: No description available. ,
AppService: No description available. ,
ManagedDisk: No description available. ,
BlockBlob: No description available. ,
RedisCache: No description available. ,
AzureDataExplorer: No description available. ,
MySql: No description available. ,
MariaDb: No description available. ,
PostgreSql: No description available. ,
DedicatedHost: No description available. ,
SapHana: No description available. ,
SqlAzureHybridBenefit: No description available. ,
AVS: No description available. ,
DataFactory: No description available. ,
NetAppStorage: No description available. ,
AzureFiles: No description available. ,
SqlEdge: No description available. ,
VirtualMachineSoftware: No description available. ,
}
,
Required: False ,
}
enum ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing reservation or savings plan ,
Required: False ,
}
string ,
term:
{
Description: Represent the term of reservation. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
billingPlan:
{
Description: Represent the billing plans. ,
Enum:
{
Upfront: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
quantity:
{
Description: Quantity of the skus that are part of the reservation. ,
Format: int32 ,
Required: False ,
}
integer ,
displayName:
{
Description: Friendly name of the reservation ,
Required: False ,
}
string ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopes:
{
Description: List of the subscriptions that the benefit will be applied. Do not specify if AppliedScopeType is Shared. This property will be deprecated and replaced by appliedScopeProperties instead for Single AppliedScopeType. ,
Required: False ,
}
[
string ,
]
,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the savings plan should apply benefit. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
renew:
{
Description: Setting this to true will automatically purchase a new reservation on the expiration date time. ,
Required: False ,
}
boolean ,
reservedResourceProperties:
{
Description: Properties specific to each reserved resource type. Not required if not applicable. ,
Required: False ,
}
{
instanceFlexibility:
{
Description: Turning this on will apply the reservation discount to other VMs in the same VM size group. Only specify for VirtualMachines reserved resource type. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
reviewDateTime:
{
Description: This is the date-time when the Azure hybrid benefit needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
reviewDateTime:
{
Description: This is the date-time when the Azure hybrid benefit needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
location:
{
Description: The Azure region where the reserved resource lives. ,
Required: False ,
}
string ,
etag:
{
Format: int32 ,
Required: False ,
}
integer ,
sku:
{
Description: The sku information associated to this reservation ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties associated to this reservation ,
Required: False ,
}
{
reservedResourceType:
{
Description: The type of the resource that is being reserved. ,
Enum:
{
VirtualMachines: No description available. ,
SqlDatabases: No description available. ,
SuseLinux: No description available. ,
CosmosDb: No description available. ,
RedHat: No description available. ,
SqlDataWarehouse: No description available. ,
VMwareCloudSimple: No description available. ,
RedHatOsa: No description available. ,
Databricks: No description available. ,
AppService: No description available. ,
ManagedDisk: No description available. ,
BlockBlob: No description available. ,
RedisCache: No description available. ,
AzureDataExplorer: No description available. ,
MySql: No description available. ,
MariaDb: No description available. ,
PostgreSql: No description available. ,
DedicatedHost: No description available. ,
SapHana: No description available. ,
SqlAzureHybridBenefit: No description available. ,
AVS: No description available. ,
DataFactory: No description available. ,
NetAppStorage: No description available. ,
AzureFiles: No description available. ,
SqlEdge: No description available. ,
VirtualMachineSoftware: No description available. ,
}
,
Required: False ,
}
enum ,
instanceFlexibility:
{
Description: Allows reservation discount to be applied across skus within the same auto fit group. Not all skus support instance size flexibility. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Friendly name for user to easily identify the reservation ,
Required: False ,
}
string ,
appliedScopes:
{
Description: The list of applied scopes ,
Required: False ,
}
[
string ,
]
,
appliedScopeType:
{
Description: The applied scope type ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
archived:
{
Description: Indicates if the reservation is archived ,
Required: False ,
}
boolean ,
capabilities:
{
Description: Capabilities of the reservation ,
Required: False ,
}
string ,
quantity:
{
Description: Quantity of the skus that are part of the reservation. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: Current state of the reservation. ,
Enum:
{
Creating: No description available. ,
PendingResourceHold: No description available. ,
ConfirmedResourceHold: No description available. ,
PendingBilling: No description available. ,
ConfirmedBilling: No description available. ,
Created: No description available. ,
Succeeded: No description available. ,
Cancelled: No description available. ,
Expired: No description available. ,
BillingFailed: No description available. ,
Failed: No description available. ,
Split: No description available. ,
Merged: No description available. ,
}
,
Required: False ,
}
enum ,
effectiveDateTime:
{
Description: DateTime of the reservation starting when this version is effective from. ,
Format: date-time ,
Required: False ,
}
string ,
benefitStartTime:
{
Description: This is the DateTime when the reservation benefit started. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedDateTime:
{
Description: DateTime of the last time the reservation was updated. ,
Format: date-time ,
Required: False ,
}
string ,
expiryDate:
{
Description: This is the date when the reservation will expire. ,
Format: date ,
Required: False ,
}
string ,
expiryDateTime:
{
Description: This is the date-time when the reservation will expire. ,
Format: date-time ,
Required: False ,
}
string ,
reviewDateTime:
{
Description: This is the date-time when the Azure Hybrid Benefit needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
skuDescription:
{
Description: Description of the sku in english. ,
Required: False ,
}
string ,
extendedStatusInfo:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
{
statusCode:
{
Enum:
{
None: No description available. ,
Pending: No description available. ,
Processing: No description available. ,
Active: No description available. ,
PurchaseError: No description available. ,
PaymentInstrumentError: No description available. ,
Split: No description available. ,
Merged: No description available. ,
Expired: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
string ,
}
,
billingPlan:
{
Description: The billing plan options available for this sku. ,
Enum:
{
Upfront: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
displayProvisioningState:
{
Description: The provisioning state of the reservation for display, e.g. Succeeded ,
Required: False ,
}
string ,
provisioningSubState:
{
Description: The provisioning sub-state of the reservation, e.g. Succeeded ,
Required: False ,
}
string ,
purchaseDate:
{
Description: This is the date when the reservation was purchased. ,
Format: date ,
Required: False ,
}
string ,
purchaseDateTime:
{
Description: This is the date-time when the reservation was purchased. ,
Format: date-time ,
Required: False ,
}
string ,
splitProperties:
{
Description: Properties of reservation split ,
Required: False ,
}
{
splitDestinations:
{
Description: List of destination resource id that are created due to split. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
[
string ,
]
,
splitSource:
{
Description: Resource id of the reservation from which this is split. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
}
,
mergeProperties:
{
Description: Properties of reservation merge ,
Required: False ,
}
{
mergeDestination:
{
Description: Reservation resource id Created due to the merge. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
mergeSources:
{
Description: Resource ids of the source reservation's merged to form this reservation. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
[
string ,
]
,
}
,
swapProperties:
{
Description: Properties of reservation swap ,
Required: False ,
}
{
swapSource:
{
Description: Resource id of the source reservation that gets swapped. Format of the resource id is /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
swapDestination:
{
Description: Reservation resource id that the original resource gets swapped to. Format of the resource id is /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
}
,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the savings plan should apply benefit. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
billingScopeId:
{
Description: Subscription that will be charged for purchasing reservation or savings plan ,
Required: False ,
}
string ,
renew:
{
Description: Setting this to true will automatically purchase a new reservation on the expiration date time. ,
Required: False ,
}
boolean ,
renewSource:
{
Description: Reservation Id of the reservation from which this reservation is renewed. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}. ,
Required: False ,
}
string ,
renewDestination:
{
Description: Reservation Id of the reservation which is purchased because of renew. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}. ,
Required: False ,
}
string ,
renewProperties:
{
Description: The renew properties for a reservation. ,
Required: False ,
}
{
purchaseProperties:
{
Description: The request for reservation purchase ,
Required: False ,
}
{
sku:
{
Description: The name of sku ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
}
,
location:
{
Description: The Azure region where the reserved resource lives. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of reservation purchase request ,
Required: False ,
}
{
reservedResourceType:
{
Description: The type of the resource that is being reserved. In addition to below types we have also added the following: OpenAIPTU, MDC, Sentinel. ,
Enum:
{
VirtualMachines: No description available. ,
SqlDatabases: No description available. ,
SuseLinux: No description available. ,
CosmosDb: No description available. ,
RedHat: No description available. ,
SqlDataWarehouse: No description available. ,
VMwareCloudSimple: No description available. ,
RedHatOsa: No description available. ,
Databricks: No description available. ,
AppService: No description available. ,
ManagedDisk: No description available. ,
BlockBlob: No description available. ,
RedisCache: No description available. ,
AzureDataExplorer: No description available. ,
MySql: No description available. ,
MariaDb: No description available. ,
PostgreSql: No description available. ,
DedicatedHost: No description available. ,
SapHana: No description available. ,
SqlAzureHybridBenefit: No description available. ,
AVS: No description available. ,
DataFactory: No description available. ,
NetAppStorage: No description available. ,
AzureFiles: No description available. ,
SqlEdge: No description available. ,
VirtualMachineSoftware: No description available. ,
}
,
Required: False ,
}
enum ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing reservation or savings plan ,
Required: False ,
}
string ,
term:
{
Description: Represent the term of reservation. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
billingPlan:
{
Description: Represent the billing plans. ,
Enum:
{
Upfront: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
quantity:
{
Description: Quantity of the skus that are part of the reservation. ,
Format: int32 ,
Required: False ,
}
integer ,
displayName:
{
Description: Friendly name of the reservation ,
Required: False ,
}
string ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopes:
{
Description: List of the subscriptions that the benefit will be applied. Do not specify if AppliedScopeType is Shared. This property will be deprecated and replaced by appliedScopeProperties instead for Single AppliedScopeType. ,
Required: False ,
}
[
string ,
]
,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the savings plan should apply benefit. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
renew:
{
Description: Setting this to true will automatically purchase a new reservation on the expiration date time. ,
Required: False ,
}
boolean ,
reservedResourceProperties:
{
Description: Properties specific to each reserved resource type. Not required if not applicable. ,
Required: False ,
}
{
instanceFlexibility:
{
Description: Turning this on will apply the reservation discount to other VMs in the same VM size group. Only specify for VirtualMachines reserved resource type. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
reviewDateTime:
{
Description: This is the date-time when the Azure hybrid benefit needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
pricingCurrencyTotal:
{
Description: 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. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Required: False ,
}
number ,
}
,
billingCurrencyTotal:
{
Description: Currency and amount that customer will be charged in customer's local currency for renewal purchase. Tax is not included. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Required: False ,
}
number ,
}
,
}
,
term:
{
Description: Represent the term of reservation. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
userFriendlyAppliedScopeType:
{
Description: The applied scope type of the reservation for display, e.g. Shared ,
Required: False ,
}
string ,
userFriendlyRenewState:
{
Description: The renew state of the reservation for display, e.g. On ,
Required: False ,
}
string ,
utilization:
{
Description: Reservation utilization ,
Required: False ,
}
{
trend:
{
Description: last 7 day utilization trend for a reservation ,
Required: False ,
}
string ,
aggregates:
{
Description: The array of aggregates of a reservation's utilization ,
Required: False ,
}
[
{
grain:
{
Description: The grain of the aggregate ,
Required: False ,
}
number ,
grainUnit:
{
Description: The grain unit of the aggregate ,
Required: False ,
}
string ,
value:
{
Description: The aggregate value ,
Required: False ,
}
number ,
valueUnit:
{
Description: The aggregate value unit ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
kind:
{
Description: Resource Provider type to be reserved. ,
Enum:
{
Microsoft.Compute: No description available. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URL for checking the ongoing status of the operation. ,
}
string ,
location:
{
Description: URL for determining when an operation has completed. Only use this value only when Azure-AsyncOperation isn't returned. ,
}
string ,
retry-after:
{
Description: Clients should wait for the Retry-After interval before polling again ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: Extended error information including error code and error message ,
Required: False ,
}
{
code:
{
Description: Error code describing the reason that service is not able to process the incoming request ,
Enum:
{
NotSpecified: No description available. ,
InternalServerError: No description available. ,
ServerTimeout: No description available. ,
AuthorizationFailed: No description available. ,
BadRequest: No description available. ,
ClientCertificateThumbprintNotSet: No description available. ,
InvalidRequestContent: No description available. ,
OperationFailed: No description available. ,
HttpMethodNotSupported: No description available. ,
InvalidRequestUri: No description available. ,
MissingTenantId: No description available. ,
InvalidTenantId: No description available. ,
InvalidReservationOrderId: No description available. ,
InvalidReservationId: No description available. ,
ReservationIdNotInReservationOrder: No description available. ,
ReservationOrderNotFound: No description available. ,
InvalidSubscriptionId: No description available. ,
InvalidAccessToken: No description available. ,
InvalidLocationId: No description available. ,
UnauthenticatedRequestsThrottled: No description available. ,
InvalidHealthCheckType: No description available. ,
Forbidden: No description available. ,
BillingScopeIdCannotBeChanged: No description available. ,
AppliedScopesNotAssociatedWithCommerceAccount: No description available. ,
PatchValuesSameAsExisting: No description available. ,
RoleAssignmentCreationFailed: No description available. ,
ReservationOrderCreationFailed: No description available. ,
ReservationOrderNotEnabled: No description available. ,
CapacityUpdateScopesFailed: No description available. ,
UnsupportedReservationTerm: No description available. ,
ReservationOrderIdAlreadyExists: No description available. ,
RiskCheckFailed: No description available. ,
CreateQuoteFailed: No description available. ,
ActivateQuoteFailed: No description available. ,
NonsupportedAccountId: No description available. ,
PaymentInstrumentNotFound: No description available. ,
MissingAppliedScopesForSingle: No description available. ,
NoValidReservationsToReRate: No description available. ,
ReRateOnlyAllowedForEA: No description available. ,
OperationCannotBePerformedInCurrentState: No description available. ,
InvalidSingleAppliedScopesCount: No description available. ,
InvalidFulfillmentRequestParameters: No description available. ,
NotSupportedCountry: No description available. ,
InvalidRefundQuantity: No description available. ,
PurchaseError: No description available. ,
BillingCustomerInputError: No description available. ,
BillingPaymentInstrumentSoftError: No description available. ,
BillingPaymentInstrumentHardError: No description available. ,
BillingTransientError: No description available. ,
BillingError: No description available. ,
FulfillmentConfigurationError: No description available. ,
FulfillmentOutOfStockError: No description available. ,
FulfillmentTransientError: No description available. ,
FulfillmentError: No description available. ,
CalculatePriceFailed: No description available. ,
AppliedScopesSameAsExisting: No description available. ,
SelfServiceRefundNotSupported: No description available. ,
RefundLimitExceeded: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Required: False ,
}
string ,
}
,
}
Reservation_ListRevisions (updated)
Description :  List of all the revisions for the `Reservation`.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Reservation_ListRevisions",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "renewProperties": [
                  {
                    "purchaseProperties": [
                      {
                        "properties": [
                          {
                            "#name": "reservedResourceType",
                            "Description": {
                              "new": "The type of the resource that is being reserved. In addition to below types we have also added the following: OpenAIPTU, MDC, Sentinel.",
                              "old": "The type of the resource that is being reserved."
                            }
                          }
                        ]
                      }
                    ]
                  }
                ]
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}/revisions
{
reservationOrderId:
{
Description: Order Id of the reservation ,
Required: True ,
}
string ,
reservationId:
{
Description: Id of the reservation item ,
Required: True ,
}
string ,
api-version:
{
Description: Supported version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
location:
{
Description: The Azure region where the reserved resource lives. ,
Required: False ,
}
string ,
etag:
{
Format: int32 ,
Required: False ,
}
integer ,
sku:
{
Description: The sku information associated to this reservation ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties associated to this reservation ,
Required: False ,
}
{
reservedResourceType:
{
Description: The type of the resource that is being reserved. ,
Enum:
{
VirtualMachines: No description available. ,
SqlDatabases: No description available. ,
SuseLinux: No description available. ,
CosmosDb: No description available. ,
RedHat: No description available. ,
SqlDataWarehouse: No description available. ,
VMwareCloudSimple: No description available. ,
RedHatOsa: No description available. ,
Databricks: No description available. ,
AppService: No description available. ,
ManagedDisk: No description available. ,
BlockBlob: No description available. ,
RedisCache: No description available. ,
AzureDataExplorer: No description available. ,
MySql: No description available. ,
MariaDb: No description available. ,
PostgreSql: No description available. ,
DedicatedHost: No description available. ,
SapHana: No description available. ,
SqlAzureHybridBenefit: No description available. ,
AVS: No description available. ,
DataFactory: No description available. ,
NetAppStorage: No description available. ,
AzureFiles: No description available. ,
SqlEdge: No description available. ,
VirtualMachineSoftware: No description available. ,
}
,
Required: False ,
}
enum ,
instanceFlexibility:
{
Description: Allows reservation discount to be applied across skus within the same auto fit group. Not all skus support instance size flexibility. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Friendly name for user to easily identify the reservation ,
Required: False ,
}
string ,
appliedScopes:
{
Description: The list of applied scopes ,
Required: False ,
}
[
string ,
]
,
appliedScopeType:
{
Description: The applied scope type ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
archived:
{
Description: Indicates if the reservation is archived ,
Required: False ,
}
boolean ,
capabilities:
{
Description: Capabilities of the reservation ,
Required: False ,
}
string ,
quantity:
{
Description: Quantity of the skus that are part of the reservation. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: Current state of the reservation. ,
Enum:
{
Creating: No description available. ,
PendingResourceHold: No description available. ,
ConfirmedResourceHold: No description available. ,
PendingBilling: No description available. ,
ConfirmedBilling: No description available. ,
Created: No description available. ,
Succeeded: No description available. ,
Cancelled: No description available. ,
Expired: No description available. ,
BillingFailed: No description available. ,
Failed: No description available. ,
Split: No description available. ,
Merged: No description available. ,
}
,
Required: False ,
}
enum ,
effectiveDateTime:
{
Description: DateTime of the reservation starting when this version is effective from. ,
Format: date-time ,
Required: False ,
}
string ,
benefitStartTime:
{
Description: This is the DateTime when the reservation benefit started. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedDateTime:
{
Description: DateTime of the last time the reservation was updated. ,
Format: date-time ,
Required: False ,
}
string ,
expiryDate:
{
Description: This is the date when the reservation will expire. ,
Format: date ,
Required: False ,
}
string ,
expiryDateTime:
{
Description: This is the date-time when the reservation will expire. ,
Format: date-time ,
Required: False ,
}
string ,
reviewDateTime:
{
Description: This is the date-time when the Azure Hybrid Benefit needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
skuDescription:
{
Description: Description of the sku in english. ,
Required: False ,
}
string ,
extendedStatusInfo:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
{
statusCode:
{
Enum:
{
None: No description available. ,
Pending: No description available. ,
Processing: No description available. ,
Active: No description available. ,
PurchaseError: No description available. ,
PaymentInstrumentError: No description available. ,
Split: No description available. ,
Merged: No description available. ,
Expired: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
string ,
}
,
billingPlan:
{
Description: The billing plan options available for this sku. ,
Enum:
{
Upfront: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
displayProvisioningState:
{
Description: The provisioning state of the reservation for display, e.g. Succeeded ,
Required: False ,
}
string ,
provisioningSubState:
{
Description: The provisioning sub-state of the reservation, e.g. Succeeded ,
Required: False ,
}
string ,
purchaseDate:
{
Description: This is the date when the reservation was purchased. ,
Format: date ,
Required: False ,
}
string ,
purchaseDateTime:
{
Description: This is the date-time when the reservation was purchased. ,
Format: date-time ,
Required: False ,
}
string ,
splitProperties:
{
Description: Properties of reservation split ,
Required: False ,
}
{
splitDestinations:
{
Description: List of destination resource id that are created due to split. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
[
string ,
]
,
splitSource:
{
Description: Resource id of the reservation from which this is split. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
}
,
mergeProperties:
{
Description: Properties of reservation merge ,
Required: False ,
}
{
mergeDestination:
{
Description: Reservation resource id Created due to the merge. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
mergeSources:
{
Description: Resource ids of the source reservation's merged to form this reservation. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
[
string ,
]
,
}
,
swapProperties:
{
Description: Properties of reservation swap ,
Required: False ,
}
{
swapSource:
{
Description: Resource id of the source reservation that gets swapped. Format of the resource id is /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
swapDestination:
{
Description: Reservation resource id that the original resource gets swapped to. Format of the resource id is /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
}
,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the savings plan should apply benefit. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
billingScopeId:
{
Description: Subscription that will be charged for purchasing reservation or savings plan ,
Required: False ,
}
string ,
renew:
{
Description: Setting this to true will automatically purchase a new reservation on the expiration date time. ,
Required: False ,
}
boolean ,
renewSource:
{
Description: Reservation Id of the reservation from which this reservation is renewed. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}. ,
Required: False ,
}
string ,
renewDestination:
{
Description: Reservation Id of the reservation which is purchased because of renew. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}. ,
Required: False ,
}
string ,
renewProperties:
{
Description: The renew properties for a reservation. ,
Required: False ,
}
{
purchaseProperties:
{
Description: The request for reservation purchase ,
Required: False ,
}
{
sku:
{
Description: The name of sku ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
}
,
location:
{
Description: The Azure region where the reserved resource lives. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of reservation purchase request ,
Required: False ,
}
{
reservedResourceType:
{
Description: The type of the resource that is being reserved. In addition to below types we have also added the following: OpenAIPTU, MDC, Sentinel. ,
Enum:
{
VirtualMachines: No description available. ,
SqlDatabases: No description available. ,
SuseLinux: No description available. ,
CosmosDb: No description available. ,
RedHat: No description available. ,
SqlDataWarehouse: No description available. ,
VMwareCloudSimple: No description available. ,
RedHatOsa: No description available. ,
Databricks: No description available. ,
AppService: No description available. ,
ManagedDisk: No description available. ,
BlockBlob: No description available. ,
RedisCache: No description available. ,
AzureDataExplorer: No description available. ,
MySql: No description available. ,
MariaDb: No description available. ,
PostgreSql: No description available. ,
DedicatedHost: No description available. ,
SapHana: No description available. ,
SqlAzureHybridBenefit: No description available. ,
AVS: No description available. ,
DataFactory: No description available. ,
NetAppStorage: No description available. ,
AzureFiles: No description available. ,
SqlEdge: No description available. ,
VirtualMachineSoftware: No description available. ,
}
,
Required: False ,
}
enum ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing reservation or savings plan ,
Required: False ,
}
string ,
term:
{
Description: Represent the term of reservation. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
billingPlan:
{
Description: Represent the billing plans. ,
Enum:
{
Upfront: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
quantity:
{
Description: Quantity of the skus that are part of the reservation. ,
Format: int32 ,
Required: False ,
}
integer ,
displayName:
{
Description: Friendly name of the reservation ,
Required: False ,
}
string ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopes:
{
Description: List of the subscriptions that the benefit will be applied. Do not specify if AppliedScopeType is Shared. This property will be deprecated and replaced by appliedScopeProperties instead for Single AppliedScopeType. ,
Required: False ,
}
[
string ,
]
,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the savings plan should apply benefit. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
renew:
{
Description: Setting this to true will automatically purchase a new reservation on the expiration date time. ,
Required: False ,
}
boolean ,
reservedResourceProperties:
{
Description: Properties specific to each reserved resource type. Not required if not applicable. ,
Required: False ,
}
{
instanceFlexibility:
{
Description: Turning this on will apply the reservation discount to other VMs in the same VM size group. Only specify for VirtualMachines reserved resource type. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
reviewDateTime:
{
Description: This is the date-time when the Azure hybrid benefit needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
pricingCurrencyTotal:
{
Description: 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. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Required: False ,
}
number ,
}
,
billingCurrencyTotal:
{
Description: Currency and amount that customer will be charged in customer's local currency for renewal purchase. Tax is not included. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Required: False ,
}
number ,
}
,
}
,
term:
{
Description: Represent the term of reservation. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
userFriendlyAppliedScopeType:
{
Description: The applied scope type of the reservation for display, e.g. Shared ,
Required: False ,
}
string ,
userFriendlyRenewState:
{
Description: The renew state of the reservation for display, e.g. On ,
Required: False ,
}
string ,
utilization:
{
Description: Reservation utilization ,
Required: False ,
}
{
trend:
{
Description: last 7 day utilization trend for a reservation ,
Required: False ,
}
string ,
aggregates:
{
Description: The array of aggregates of a reservation's utilization ,
Required: False ,
}
[
{
grain:
{
Description: The grain of the aggregate ,
Required: False ,
}
number ,
grainUnit:
{
Description: The grain unit of the aggregate ,
Required: False ,
}
string ,
value:
{
Description: The aggregate value ,
Required: False ,
}
number ,
valueUnit:
{
Description: The aggregate value unit ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
kind:
{
Description: Resource Provider type to be reserved. ,
Enum:
{
Microsoft.Compute: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: Url to get the next page of reservations. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Extended error information including error code and error message ,
Required: False ,
}
{
code:
{
Description: Error code describing the reason that service is not able to process the incoming request ,
Enum:
{
NotSpecified: No description available. ,
InternalServerError: No description available. ,
ServerTimeout: No description available. ,
AuthorizationFailed: No description available. ,
BadRequest: No description available. ,
ClientCertificateThumbprintNotSet: No description available. ,
InvalidRequestContent: No description available. ,
OperationFailed: No description available. ,
HttpMethodNotSupported: No description available. ,
InvalidRequestUri: No description available. ,
MissingTenantId: No description available. ,
InvalidTenantId: No description available. ,
InvalidReservationOrderId: No description available. ,
InvalidReservationId: No description available. ,
ReservationIdNotInReservationOrder: No description available. ,
ReservationOrderNotFound: No description available. ,
InvalidSubscriptionId: No description available. ,
InvalidAccessToken: No description available. ,
InvalidLocationId: No description available. ,
UnauthenticatedRequestsThrottled: No description available. ,
InvalidHealthCheckType: No description available. ,
Forbidden: No description available. ,
BillingScopeIdCannotBeChanged: No description available. ,
AppliedScopesNotAssociatedWithCommerceAccount: No description available. ,
PatchValuesSameAsExisting: No description available. ,
RoleAssignmentCreationFailed: No description available. ,
ReservationOrderCreationFailed: No description available. ,
ReservationOrderNotEnabled: No description available. ,
CapacityUpdateScopesFailed: No description available. ,
UnsupportedReservationTerm: No description available. ,
ReservationOrderIdAlreadyExists: No description available. ,
RiskCheckFailed: No description available. ,
CreateQuoteFailed: No description available. ,
ActivateQuoteFailed: No description available. ,
NonsupportedAccountId: No description available. ,
PaymentInstrumentNotFound: No description available. ,
MissingAppliedScopesForSingle: No description available. ,
NoValidReservationsToReRate: No description available. ,
ReRateOnlyAllowedForEA: No description available. ,
OperationCannotBePerformedInCurrentState: No description available. ,
InvalidSingleAppliedScopesCount: No description available. ,
InvalidFulfillmentRequestParameters: No description available. ,
NotSupportedCountry: No description available. ,
InvalidRefundQuantity: No description available. ,
PurchaseError: No description available. ,
BillingCustomerInputError: No description available. ,
BillingPaymentInstrumentSoftError: No description available. ,
BillingPaymentInstrumentHardError: No description available. ,
BillingTransientError: No description available. ,
BillingError: No description available. ,
FulfillmentConfigurationError: No description available. ,
FulfillmentOutOfStockError: No description available. ,
FulfillmentTransientError: No description available. ,
FulfillmentError: No description available. ,
CalculatePriceFailed: No description available. ,
AppliedScopesSameAsExisting: No description available. ,
SelfServiceRefundNotSupported: No description available. ,
RefundLimitExceeded: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Required: False ,
}
string ,
}
,
}
Return_Post (updated)
Description :  Return a reservation and get refund information.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Return_Post",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "reservations": {
              "$properties": {
                "properties": [
                  {
                    "renewProperties": [
                      {
                        "purchaseProperties": [
                          {
                            "properties": [
                              {
                                "#name": "reservedResourceType",
                                "Description": {
                                  "new": "The type of the resource that is being reserved. In addition to below types we have also added the following: OpenAIPTU, MDC, Sentinel.",
                                  "old": "The type of the resource that is being reserved."
                                }
                              }
                            ]
                          }
                        ]
                      }
                    ]
                  }
                ]
              }
            }
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/return
{
reservationOrderId:
{
Description: Order Id of the reservation ,
Required: True ,
}
string ,
api-version:
{
Description: Supported version. ,
Required: True ,
}
string ,
body:
{
Description: Information needed for returning reservation. ,
Required: True ,
}
{
properties:
{
Description: Properties needed for refund request including the session id from calculate refund, the scope, the reservation to be returned and the return reason. ,
Required: False ,
}
{
sessionId:
{
Description: SessionId that was returned by CalculateRefund API. ,
Required: False ,
}
string ,
scope:
{
Description: The scope of the refund, e.g. Reservation ,
Required: False ,
}
string ,
reservationToReturn:
{
Description: Reservation to return ,
Required: False ,
}
{
reservationId:
{
Description: Fully qualified identifier of the reservation being returned ,
Required: False ,
}
string ,
quantity:
{
Description: Quantity to be returned. Must be greater than zero. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
returnReason:
{
Description: The reason of returning the reservation ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
etag:
{
Format: int32 ,
Required: False ,
}
integer ,
id:
{
Description: Identifier of the reservation ,
Required: False ,
}
string ,
name:
{
Description: Name of the reservation ,
Required: False ,
}
string ,
properties:
{
Description: Properties of a reservation order. ,
Required: False ,
}
{
displayName:
{
Description: Friendly name for user to easily identified the reservation. ,
Required: False ,
}
string ,
requestDateTime:
{
Description: This is the DateTime when the reservation was initially requested for purchase. ,
Format: date-time ,
Required: False ,
}
string ,
createdDateTime:
{
Description: This is the DateTime when the reservation was created. ,
Format: date-time ,
Required: False ,
}
string ,
expiryDate:
{
Description: This is the date when the reservation will expire. ,
Format: date ,
Required: False ,
}
string ,
expiryDateTime:
{
Description: This is the date-time when the reservation will expire. ,
Format: date-time ,
Required: False ,
}
string ,
benefitStartTime:
{
Description: This is the DateTime when the reservation benefit started. ,
Format: date-time ,
Required: False ,
}
string ,
originalQuantity:
{
Description: Total Quantity of the skus purchased in the reservation. ,
Format: int32 ,
Required: False ,
}
integer ,
term:
{
Description: Represent the term of reservation. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Current state of the reservation. ,
Enum:
{
Creating: No description available. ,
PendingResourceHold: No description available. ,
ConfirmedResourceHold: No description available. ,
PendingBilling: No description available. ,
ConfirmedBilling: No description available. ,
Created: No description available. ,
Succeeded: No description available. ,
Cancelled: No description available. ,
Expired: No description available. ,
BillingFailed: No description available. ,
Failed: No description available. ,
Split: No description available. ,
Merged: No description available. ,
}
,
Required: False ,
}
enum ,
billingPlan:
{
Description: Represent the billing plans. ,
Enum:
{
Upfront: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
planInformation:
{
Description: Information describing the type of billing plan for this reservation. ,
Required: False ,
}
{
pricingCurrencyTotal:
{
Description: Amount of money to be paid for the Order. Tax is not included. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
startDate:
{
Description: Date when the billing plan has started. ,
Format: date ,
Required: False ,
}
string ,
nextPaymentDueDate:
{
Description: For recurring billing plans, indicates the date when next payment will be processed. Null when total is paid off. ,
Format: date ,
Required: False ,
}
string ,
transactions:
{
Required: False ,
}
[
{
dueDate:
{
Description: Date when the payment needs to be done. ,
Format: date ,
Required: False ,
}
string ,
paymentDate:
{
Description: Date when the transaction is completed. Is null when it is scheduled. ,
Format: date ,
Required: False ,
}
string ,
pricingCurrencyTotal:
{
Description: Amount in pricing currency. Tax not included. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
billingCurrencyTotal:
{
Description: Amount charged in Billing currency. Tax not included. Is null for future payments ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
billingAccount:
{
Description: Shows the Account that is charged for this payment. ,
Required: False ,
}
string ,
status:
{
Description: Describes whether the payment is completed, failed, cancelled or scheduled in the future. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Scheduled: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
extendedStatusInfo:
{
Required: False ,
}
{
statusCode:
{
Enum:
{
None: No description available. ,
Pending: No description available. ,
Processing: No description available. ,
Active: No description available. ,
PurchaseError: No description available. ,
PaymentInstrumentError: No description available. ,
Split: No description available. ,
Merged: No description available. ,
Expired: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
reservations:
{
Required: False ,
}
[
{
location:
{
Description: The Azure region where the reserved resource lives. ,
Required: False ,
}
string ,
etag:
{
Format: int32 ,
Required: False ,
}
integer ,
sku:
{
Description: The sku information associated to this reservation ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties associated to this reservation ,
Required: False ,
}
{
reservedResourceType:
{
Description: The type of the resource that is being reserved. ,
Enum:
{
VirtualMachines: No description available. ,
SqlDatabases: No description available. ,
SuseLinux: No description available. ,
CosmosDb: No description available. ,
RedHat: No description available. ,
SqlDataWarehouse: No description available. ,
VMwareCloudSimple: No description available. ,
RedHatOsa: No description available. ,
Databricks: No description available. ,
AppService: No description available. ,
ManagedDisk: No description available. ,
BlockBlob: No description available. ,
RedisCache: No description available. ,
AzureDataExplorer: No description available. ,
MySql: No description available. ,
MariaDb: No description available. ,
PostgreSql: No description available. ,
DedicatedHost: No description available. ,
SapHana: No description available. ,
SqlAzureHybridBenefit: No description available. ,
AVS: No description available. ,
DataFactory: No description available. ,
NetAppStorage: No description available. ,
AzureFiles: No description available. ,
SqlEdge: No description available. ,
VirtualMachineSoftware: No description available. ,
}
,
Required: False ,
}
enum ,
instanceFlexibility:
{
Description: Allows reservation discount to be applied across skus within the same auto fit group. Not all skus support instance size flexibility. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Friendly name for user to easily identify the reservation ,
Required: False ,
}
string ,
appliedScopes:
{
Description: The list of applied scopes ,
Required: False ,
}
[
string ,
]
,
appliedScopeType:
{
Description: The applied scope type ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
archived:
{
Description: Indicates if the reservation is archived ,
Required: False ,
}
boolean ,
capabilities:
{
Description: Capabilities of the reservation ,
Required: False ,
}
string ,
quantity:
{
Description: Quantity of the skus that are part of the reservation. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: Current state of the reservation. ,
Enum:
{
Creating: No description available. ,
PendingResourceHold: No description available. ,
ConfirmedResourceHold: No description available. ,
PendingBilling: No description available. ,
ConfirmedBilling: No description available. ,
Created: No description available. ,
Succeeded: No description available. ,
Cancelled: No description available. ,
Expired: No description available. ,
BillingFailed: No description available. ,
Failed: No description available. ,
Split: No description available. ,
Merged: No description available. ,
}
,
Required: False ,
}
enum ,
effectiveDateTime:
{
Description: DateTime of the reservation starting when this version is effective from. ,
Format: date-time ,
Required: False ,
}
string ,
benefitStartTime:
{
Description: This is the DateTime when the reservation benefit started. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedDateTime:
{
Description: DateTime of the last time the reservation was updated. ,
Format: date-time ,
Required: False ,
}
string ,
expiryDate:
{
Description: This is the date when the reservation will expire. ,
Format: date ,
Required: False ,
}
string ,
expiryDateTime:
{
Description: This is the date-time when the reservation will expire. ,
Format: date-time ,
Required: False ,
}
string ,
reviewDateTime:
{
Description: This is the date-time when the Azure Hybrid Benefit needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
skuDescription:
{
Description: Description of the sku in english. ,
Required: False ,
}
string ,
extendedStatusInfo:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
{
statusCode:
{
Enum:
{
None: No description available. ,
Pending: No description available. ,
Processing: No description available. ,
Active: No description available. ,
PurchaseError: No description available. ,
PaymentInstrumentError: No description available. ,
Split: No description available. ,
Merged: No description available. ,
Expired: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
string ,
}
,
billingPlan:
{
Description: The billing plan options available for this sku. ,
Enum:
{
Upfront: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
displayProvisioningState:
{
Description: The provisioning state of the reservation for display, e.g. Succeeded ,
Required: False ,
}
string ,
provisioningSubState:
{
Description: The provisioning sub-state of the reservation, e.g. Succeeded ,
Required: False ,
}
string ,
purchaseDate:
{
Description: This is the date when the reservation was purchased. ,
Format: date ,
Required: False ,
}
string ,
purchaseDateTime:
{
Description: This is the date-time when the reservation was purchased. ,
Format: date-time ,
Required: False ,
}
string ,
splitProperties:
{
Description: Properties of reservation split ,
Required: False ,
}
{
splitDestinations:
{
Description: List of destination resource id that are created due to split. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
[
string ,
]
,
splitSource:
{
Description: Resource id of the reservation from which this is split. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
}
,
mergeProperties:
{
Description: Properties of reservation merge ,
Required: False ,
}
{
mergeDestination:
{
Description: Reservation resource id Created due to the merge. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
mergeSources:
{
Description: Resource ids of the source reservation's merged to form this reservation. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
[
string ,
]
,
}
,
swapProperties:
{
Description: Properties of reservation swap ,
Required: False ,
}
{
swapSource:
{
Description: Resource id of the source reservation that gets swapped. Format of the resource id is /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
swapDestination:
{
Description: Reservation resource id that the original resource gets swapped to. Format of the resource id is /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
}
,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the savings plan should apply benefit. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
billingScopeId:
{
Description: Subscription that will be charged for purchasing reservation or savings plan ,
Required: False ,
}
string ,
renew:
{
Description: Setting this to true will automatically purchase a new reservation on the expiration date time. ,
Required: False ,
}
boolean ,
renewSource:
{
Description: Reservation Id of the reservation from which this reservation is renewed. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}. ,
Required: False ,
}
string ,
renewDestination:
{
Description: Reservation Id of the reservation which is purchased because of renew. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}. ,
Required: False ,
}
string ,
renewProperties:
{
Description: The renew properties for a reservation. ,
Required: False ,
}
{
purchaseProperties:
{
Description: The request for reservation purchase ,
Required: False ,
}
{
sku:
{
Description: The name of sku ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
}
,
location:
{
Description: The Azure region where the reserved resource lives. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of reservation purchase request ,
Required: False ,
}
{
reservedResourceType:
{
Description: The type of the resource that is being reserved. In addition to below types we have also added the following: OpenAIPTU, MDC, Sentinel. ,
Enum:
{
VirtualMachines: No description available. ,
SqlDatabases: No description available. ,
SuseLinux: No description available. ,
CosmosDb: No description available. ,
RedHat: No description available. ,
SqlDataWarehouse: No description available. ,
VMwareCloudSimple: No description available. ,
RedHatOsa: No description available. ,
Databricks: No description available. ,
AppService: No description available. ,
ManagedDisk: No description available. ,
BlockBlob: No description available. ,
RedisCache: No description available. ,
AzureDataExplorer: No description available. ,
MySql: No description available. ,
MariaDb: No description available. ,
PostgreSql: No description available. ,
DedicatedHost: No description available. ,
SapHana: No description available. ,
SqlAzureHybridBenefit: No description available. ,
AVS: No description available. ,
DataFactory: No description available. ,
NetAppStorage: No description available. ,
AzureFiles: No description available. ,
SqlEdge: No description available. ,
VirtualMachineSoftware: No description available. ,
}
,
Required: False ,
}
enum ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing reservation or savings plan ,
Required: False ,
}
string ,
term:
{
Description: Represent the term of reservation. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
billingPlan:
{
Description: Represent the billing plans. ,
Enum:
{
Upfront: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
quantity:
{
Description: Quantity of the skus that are part of the reservation. ,
Format: int32 ,
Required: False ,
}
integer ,
displayName:
{
Description: Friendly name of the reservation ,
Required: False ,
}
string ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopes:
{
Description: List of the subscriptions that the benefit will be applied. Do not specify if AppliedScopeType is Shared. This property will be deprecated and replaced by appliedScopeProperties instead for Single AppliedScopeType. ,
Required: False ,
}
[
string ,
]
,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the savings plan should apply benefit. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
renew:
{
Description: Setting this to true will automatically purchase a new reservation on the expiration date time. ,
Required: False ,
}
boolean ,
reservedResourceProperties:
{
Description: Properties specific to each reserved resource type. Not required if not applicable. ,
Required: False ,
}
{
instanceFlexibility:
{
Description: Turning this on will apply the reservation discount to other VMs in the same VM size group. Only specify for VirtualMachines reserved resource type. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
reviewDateTime:
{
Description: This is the date-time when the Azure hybrid benefit needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
pricingCurrencyTotal:
{
Description: 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. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Required: False ,
}
number ,
}
,
billingCurrencyTotal:
{
Description: Currency and amount that customer will be charged in customer's local currency for renewal purchase. Tax is not included. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Required: False ,
}
number ,
}
,
}
,
term:
{
Description: Represent the term of reservation. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
userFriendlyAppliedScopeType:
{
Description: The applied scope type of the reservation for display, e.g. Shared ,
Required: False ,
}
string ,
userFriendlyRenewState:
{
Description: The renew state of the reservation for display, e.g. On ,
Required: False ,
}
string ,
utilization:
{
Description: Reservation utilization ,
Required: False ,
}
{
trend:
{
Description: last 7 day utilization trend for a reservation ,
Required: False ,
}
string ,
aggregates:
{
Description: The array of aggregates of a reservation's utilization ,
Required: False ,
}
[
{
grain:
{
Description: The grain of the aggregate ,
Required: False ,
}
number ,
grainUnit:
{
Description: The grain unit of the aggregate ,
Required: False ,
}
string ,
value:
{
Description: The aggregate value ,
Required: False ,
}
number ,
valueUnit:
{
Description: The aggregate value unit ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
kind:
{
Description: Resource Provider type to be reserved. ,
Enum:
{
Microsoft.Compute: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
reviewDateTime:
{
Description: This is the date-time when the Azure Hybrid Benefit needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
type:
{
Description: Type of resource. "Microsoft.Capacity/reservations" ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
$headers:
{
location: string ,
}
,
$schema:
{
Description: The response of refund request containing refund information of reservation ,
}
{
id:
{
Description: Fully qualified identifier of the reservation being returned ,
Required: False ,
}
string ,
properties:
{
Description: The refund properties of reservation ,
Required: False ,
}
{
sessionId:
{
Description: Refund session identifier ,
Required: False ,
}
string ,
quantity:
{
Description: Quantity to be returned ,
Format: int32 ,
Required: False ,
}
integer ,
billingRefundAmount:
{
Description: Pricing information containing the amount and the currency code ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
pricingRefundAmount:
{
Description: Pricing information containing the amount and the currency code ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
policyResult:
{
Description: Refund policy result ,
Required: False ,
}
{
properties:
{
Description: Refund policy result property ,
Required: False ,
}
{
consumedRefundsTotal:
{
Description: Pricing information containing the amount and the currency code ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
maxRefundLimit:
{
Description: Pricing information containing the amount and the currency code ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
policyErrors:
{
Description: Refund Policy errors ,
Required: False ,
}
[
{
code:
{
Description: Error code describing the reason that service is not able to process the incoming request ,
Enum:
{
NotSpecified: No description available. ,
InternalServerError: No description available. ,
ServerTimeout: No description available. ,
AuthorizationFailed: No description available. ,
BadRequest: No description available. ,
ClientCertificateThumbprintNotSet: No description available. ,
InvalidRequestContent: No description available. ,
OperationFailed: No description available. ,
HttpMethodNotSupported: No description available. ,
InvalidRequestUri: No description available. ,
MissingTenantId: No description available. ,
InvalidTenantId: No description available. ,
InvalidReservationOrderId: No description available. ,
InvalidReservationId: No description available. ,
ReservationIdNotInReservationOrder: No description available. ,
ReservationOrderNotFound: No description available. ,
InvalidSubscriptionId: No description available. ,
InvalidAccessToken: No description available. ,
InvalidLocationId: No description available. ,
UnauthenticatedRequestsThrottled: No description available. ,
InvalidHealthCheckType: No description available. ,
Forbidden: No description available. ,
BillingScopeIdCannotBeChanged: No description available. ,
AppliedScopesNotAssociatedWithCommerceAccount: No description available. ,
PatchValuesSameAsExisting: No description available. ,
RoleAssignmentCreationFailed: No description available. ,
ReservationOrderCreationFailed: No description available. ,
ReservationOrderNotEnabled: No description available. ,
CapacityUpdateScopesFailed: No description available. ,
UnsupportedReservationTerm: No description available. ,
ReservationOrderIdAlreadyExists: No description available. ,
RiskCheckFailed: No description available. ,
CreateQuoteFailed: No description available. ,
ActivateQuoteFailed: No description available. ,
NonsupportedAccountId: No description available. ,
PaymentInstrumentNotFound: No description available. ,
MissingAppliedScopesForSingle: No description available. ,
NoValidReservationsToReRate: No description available. ,
ReRateOnlyAllowedForEA: No description available. ,
OperationCannotBePerformedInCurrentState: No description available. ,
InvalidSingleAppliedScopesCount: No description available. ,
InvalidFulfillmentRequestParameters: No description available. ,
NotSupportedCountry: No description available. ,
InvalidRefundQuantity: No description available. ,
PurchaseError: No description available. ,
BillingCustomerInputError: No description available. ,
BillingPaymentInstrumentSoftError: No description available. ,
BillingPaymentInstrumentHardError: No description available. ,
BillingTransientError: No description available. ,
BillingError: No description available. ,
FulfillmentConfigurationError: No description available. ,
FulfillmentOutOfStockError: No description available. ,
FulfillmentTransientError: No description available. ,
FulfillmentError: No description available. ,
CalculatePriceFailed: No description available. ,
AppliedScopesSameAsExisting: No description available. ,
SelfServiceRefundNotSupported: No description available. ,
RefundLimitExceeded: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
billingInformation:
{
Description: billing information ,
Required: False ,
}
{
billingPlan:
{
Description: Represent the billing plans. ,
Enum:
{
Upfront: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
completedTransactions:
{
Description: The number of completed transactions in this reservation's payment ,
Format: int32 ,
Required: False ,
}
integer ,
totalTransactions:
{
Description: The number of total transactions in this reservation's payment ,
Format: int32 ,
Required: False ,
}
integer ,
billingCurrencyTotalPaidAmount:
{
Description: Pricing information containing the amount and the currency code ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
billingCurrencyProratedAmount:
{
Description: Pricing information containing the amount and the currency code ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
billingCurrencyRemainingCommitmentAmount:
{
Description: Pricing information containing the amount and the currency code ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Extended error information including error code and error message ,
Required: False ,
}
{
code:
{
Description: Error code describing the reason that service is not able to process the incoming request ,
Enum:
{
NotSpecified: No description available. ,
InternalServerError: No description available. ,
ServerTimeout: No description available. ,
AuthorizationFailed: No description available. ,
BadRequest: No description available. ,
ClientCertificateThumbprintNotSet: No description available. ,
InvalidRequestContent: No description available. ,
OperationFailed: No description available. ,
HttpMethodNotSupported: No description available. ,
InvalidRequestUri: No description available. ,
MissingTenantId: No description available. ,
InvalidTenantId: No description available. ,
InvalidReservationOrderId: No description available. ,
InvalidReservationId: No description available. ,
ReservationIdNotInReservationOrder: No description available. ,
ReservationOrderNotFound: No description available. ,
InvalidSubscriptionId: No description available. ,
InvalidAccessToken: No description available. ,
InvalidLocationId: No description available. ,
UnauthenticatedRequestsThrottled: No description available. ,
InvalidHealthCheckType: No description available. ,
Forbidden: No description available. ,
BillingScopeIdCannotBeChanged: No description available. ,
AppliedScopesNotAssociatedWithCommerceAccount: No description available. ,
PatchValuesSameAsExisting: No description available. ,
RoleAssignmentCreationFailed: No description available. ,
ReservationOrderCreationFailed: No description available. ,
ReservationOrderNotEnabled: No description available. ,
CapacityUpdateScopesFailed: No description available. ,
UnsupportedReservationTerm: No description available. ,
ReservationOrderIdAlreadyExists: No description available. ,
RiskCheckFailed: No description available. ,
CreateQuoteFailed: No description available. ,
ActivateQuoteFailed: No description available. ,
NonsupportedAccountId: No description available. ,
PaymentInstrumentNotFound: No description available. ,
MissingAppliedScopesForSingle: No description available. ,
NoValidReservationsToReRate: No description available. ,
ReRateOnlyAllowedForEA: No description available. ,
OperationCannotBePerformedInCurrentState: No description available. ,
InvalidSingleAppliedScopesCount: No description available. ,
InvalidFulfillmentRequestParameters: No description available. ,
NotSupportedCountry: No description available. ,
InvalidRefundQuantity: No description available. ,
PurchaseError: No description available. ,
BillingCustomerInputError: No description available. ,
BillingPaymentInstrumentSoftError: No description available. ,
BillingPaymentInstrumentHardError: No description available. ,
BillingTransientError: No description available. ,
BillingError: No description available. ,
FulfillmentConfigurationError: No description available. ,
FulfillmentOutOfStockError: No description available. ,
FulfillmentTransientError: No description available. ,
FulfillmentError: No description available. ,
CalculatePriceFailed: No description available. ,
AppliedScopesSameAsExisting: No description available. ,
SelfServiceRefundNotSupported: No description available. ,
RefundLimitExceeded: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Required: False ,
}
string ,
}
,
}
CalculateExchange_Post (updated)
Description :  Calculates price for exchanging `Reservations` if there are no policy errors.
Reference :  Link ¶

⚶ Changes

{
  "#id": "CalculateExchange_Post",
  "$parameters": {
    "body": {
      "$properties": {
        "properties": [
          {
            "reservationsToPurchase": {
              "$properties": {
                "properties": [
                  {
                    "#name": "reservedResourceType",
                    "Description": {
                      "new": "The type of the resource that is being reserved. In addition to below types we have also added the following: OpenAIPTU, MDC, Sentinel.",
                      "old": "The type of the resource that is being reserved."
                    }
                  }
                ]
              }
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "reservationsToPurchase": {
              "$properties": {
                "properties": [
                  {
                    "properties": [
                      {
                        "#name": "reservedResourceType",
                        "Description": {
                          "new": "The type of the resource that is being reserved. In addition to below types we have also added the following: OpenAIPTU, MDC, Sentinel.",
                          "old": "The type of the resource that is being reserved."
                        }
                      }
                    ]
                  }
                ]
              }
            }
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /providers/Microsoft.Capacity/calculateExchange
{
api-version:
{
Description: Supported version. ,
Required: True ,
}
string ,
body:
{
Description: Request containing purchases and refunds that need to be executed. ,
Required: True ,
}
{
properties:
{
Description: Calculate exchange request properties ,
Required: False ,
}
{
reservationsToPurchase:
{
Description: List of reservations that are being purchased in this exchange. ,
Required: False ,
}
[
{
sku:
{
Description: The name of sku ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
}
,
location:
{
Description: The Azure region where the reserved resource lives. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of reservation purchase request ,
Required: False ,
}
{
reservedResourceType:
{
Description: The type of the resource that is being reserved. In addition to below types we have also added the following: OpenAIPTU, MDC, Sentinel. ,
Enum:
{
VirtualMachines: No description available. ,
SqlDatabases: No description available. ,
SuseLinux: No description available. ,
CosmosDb: No description available. ,
RedHat: No description available. ,
SqlDataWarehouse: No description available. ,
VMwareCloudSimple: No description available. ,
RedHatOsa: No description available. ,
Databricks: No description available. ,
AppService: No description available. ,
ManagedDisk: No description available. ,
BlockBlob: No description available. ,
RedisCache: No description available. ,
AzureDataExplorer: No description available. ,
MySql: No description available. ,
MariaDb: No description available. ,
PostgreSql: No description available. ,
DedicatedHost: No description available. ,
SapHana: No description available. ,
SqlAzureHybridBenefit: No description available. ,
AVS: No description available. ,
DataFactory: No description available. ,
NetAppStorage: No description available. ,
AzureFiles: No description available. ,
SqlEdge: No description available. ,
VirtualMachineSoftware: No description available. ,
}
,
Required: False ,
}
enum ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing reservation or savings plan ,
Required: False ,
}
string ,
term:
{
Description: Represent the term of reservation. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
billingPlan:
{
Description: Represent the billing plans. ,
Enum:
{
Upfront: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
quantity:
{
Description: Quantity of the skus that are part of the reservation. ,
Format: int32 ,
Required: False ,
}
integer ,
displayName:
{
Description: Friendly name of the reservation ,
Required: False ,
}
string ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopes:
{
Description: List of the subscriptions that the benefit will be applied. Do not specify if AppliedScopeType is Shared. This property will be deprecated and replaced by appliedScopeProperties instead for Single AppliedScopeType. ,
Required: False ,
}
[
string ,
]
,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the savings plan should apply benefit. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
renew:
{
Description: Setting this to true will automatically purchase a new reservation on the expiration date time. ,
Required: False ,
}
boolean ,
reservedResourceProperties:
{
Description: Properties specific to each reserved resource type. Not required if not applicable. ,
Required: False ,
}
{
instanceFlexibility:
{
Description: Turning this on will apply the reservation discount to other VMs in the same VM size group. Only specify for VirtualMachines reserved resource type. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
reviewDateTime:
{
Description: This is the date-time when the Azure hybrid benefit needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
savingsPlansToPurchase:
{
Description: List of savings plans that are being purchased in this exchange. ,
Required: False ,
}
[
{
sku:
{
Description: The name of sku ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of a savings plan purchase ,
Required: False ,
}
{
displayName:
{
Description: Friendly name of the savings plan ,
Required: False ,
}
string ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing reservation or savings plan ,
Required: False ,
}
string ,
term:
{
Description: Represent savings plan term in ISO 8601 format. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
}
,
Required: False ,
}
enum ,
billingPlan:
{
Description: Represents the billing plan in ISO 8601 format. Required only for monthly billing plans. ,
Enum:
{
P1M: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the savings plan should apply benefit. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
commitment:
{
Description: Commitment towards the benefit. ,
Required: False ,
}
{
grain:
{
Description: Commitment grain. ,
Enum:
{
Hourly: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
]
,
reservationsToExchange:
{
Description: List of reservations that are being returned in this exchange. ,
Required: False ,
}
[
{
reservationId:
{
Description: Fully qualified identifier of the reservation being returned ,
Required: False ,
}
string ,
quantity:
{
Description: Quantity to be returned. Must be greater than zero. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Description: It should match what is used to GET the operation result. ,
Required: False ,
}
string ,
name:
{
Description: It must match the last segment of the id field, and will typically be a GUID / system generated value. ,
Required: False ,
}
string ,
status:
{
Description: Status of the operation. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: CalculateExchange response properties ,
Required: False ,
}
{
sessionId:
{
Description: Exchange session identifier ,
Required: False ,
}
string ,
netPayable:
{
Description: Pricing information containing the amount and the currency code ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
refundsTotal:
{
Description: Pricing information containing the amount and the currency code ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
purchasesTotal:
{
Description: Pricing information containing the amount and the currency code ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
reservationsToPurchase:
{
Description: Details of the reservations being purchased ,
Required: False ,
}
[
{
properties:
{
Description: The request for reservation purchase ,
Required: False ,
}
{
sku:
{
Description: The name of sku ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
}
,
location:
{
Description: The Azure region where the reserved resource lives. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of reservation purchase request ,
Required: False ,
}
{
reservedResourceType:
{
Description: The type of the resource that is being reserved. In addition to below types we have also added the following: OpenAIPTU, MDC, Sentinel. ,
Enum:
{
VirtualMachines: No description available. ,
SqlDatabases: No description available. ,
SuseLinux: No description available. ,
CosmosDb: No description available. ,
RedHat: No description available. ,
SqlDataWarehouse: No description available. ,
VMwareCloudSimple: No description available. ,
RedHatOsa: No description available. ,
Databricks: No description available. ,
AppService: No description available. ,
ManagedDisk: No description available. ,
BlockBlob: No description available. ,
RedisCache: No description available. ,
AzureDataExplorer: No description available. ,
MySql: No description available. ,
MariaDb: No description available. ,
PostgreSql: No description available. ,
DedicatedHost: No description available. ,
SapHana: No description available. ,
SqlAzureHybridBenefit: No description available. ,
AVS: No description available. ,
DataFactory: No description available. ,
NetAppStorage: No description available. ,
AzureFiles: No description available. ,
SqlEdge: No description available. ,
VirtualMachineSoftware: No description available. ,
}
,
Required: False ,
}
enum ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing reservation or savings plan ,
Required: False ,
}
string ,
term:
{
Description: Represent the term of reservation. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
billingPlan:
{
Description: Represent the billing plans. ,
Enum:
{
Upfront: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
quantity:
{
Description: Quantity of the skus that are part of the reservation. ,
Format: int32 ,
Required: False ,
}
integer ,
displayName:
{
Description: Friendly name of the reservation ,
Required: False ,
}
string ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopes:
{
Description: List of the subscriptions that the benefit will be applied. Do not specify if AppliedScopeType is Shared. This property will be deprecated and replaced by appliedScopeProperties instead for Single AppliedScopeType. ,
Required: False ,
}
[
string ,
]
,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the savings plan should apply benefit. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
renew:
{
Description: Setting this to true will automatically purchase a new reservation on the expiration date time. ,
Required: False ,
}
boolean ,
reservedResourceProperties:
{
Description: Properties specific to each reserved resource type. Not required if not applicable. ,
Required: False ,
}
{
instanceFlexibility:
{
Description: Turning this on will apply the reservation discount to other VMs in the same VM size group. Only specify for VirtualMachines reserved resource type. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
reviewDateTime:
{
Description: This is the date-time when the Azure hybrid benefit needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
billingCurrencyTotal:
{
Description: Pricing information containing the amount and the currency code ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
}
,
]
,
savingsPlansToPurchase:
{
Description: Details of the savings plans being purchased ,
Required: False ,
}
[
{
properties:
{
Description: Request body for savings plan purchase ,
Required: False ,
}
{
sku:
{
Description: The name of sku ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of a savings plan purchase ,
Required: False ,
}
{
displayName:
{
Description: Friendly name of the savings plan ,
Required: False ,
}
string ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing reservation or savings plan ,
Required: False ,
}
string ,
term:
{
Description: Represent savings plan term in ISO 8601 format. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
}
,
Required: False ,
}
enum ,
billingPlan:
{
Description: Represents the billing plan in ISO 8601 format. Required only for monthly billing plans. ,
Enum:
{
P1M: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the savings plan should apply benefit. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
commitment:
{
Description: Commitment towards the benefit. ,
Required: False ,
}
{
grain:
{
Description: Commitment grain. ,
Enum:
{
Hourly: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
billingCurrencyTotal:
{
Description: Pricing information containing the amount and the currency code ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
}
,
]
,
reservationsToExchange:
{
Description: Details of the reservations being returned ,
Required: False ,
}
[
{
reservationId:
{
Description: Fully qualified id of the reservation being returned. ,
Required: False ,
}
string ,
quantity:
{
Description: Quantity to be returned ,
Format: int32 ,
Required: False ,
}
integer ,
billingRefundAmount:
{
Description: Pricing information containing the amount and the currency code ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
billingInformation:
{
Description: billing information ,
Required: False ,
}
{
billingCurrencyTotalPaidAmount:
{
Description: Pricing information containing the amount and the currency code ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
billingCurrencyProratedAmount:
{
Description: Pricing information containing the amount and the currency code ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
billingCurrencyRemainingCommitmentAmount:
{
Description: Pricing information containing the amount and the currency code ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
}
,
}
,
]
,
policyResult:
{
Description: Exchange policy errors ,
Required: False ,
}
{
policyErrors:
{
Description: Exchange Policy errors ,
Required: False ,
}
[
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
error:
{
Description: Required if status == failed or status == canceled. ,
Required: False ,
}
{
code:
{
Description: Required if status == failed or status == cancelled. If status == failed, provide an invariant error code used for error troubleshooting, aggregation, and analysis. ,
Required: False ,
}
string ,
message:
{
Description: Required if status == failed. Localized. If status == failed, provide an actionable error message indicating what error occurred, and what the user can do to address the issue. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URL for checking the ongoing status of the operation. ,
}
string ,
location:
{
Description: URL for determining when an operation has completed. Only use this value only when Azure-AsyncOperation isn't returned. ,
}
string ,
retry-after:
{
Description: Clients should wait for the Retry-After interval before polling again ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: Extended error information including error code and error message ,
Required: False ,
}
{
code:
{
Description: Error code describing the reason that service is not able to process the incoming request ,
Enum:
{
NotSpecified: No description available. ,
InternalServerError: No description available. ,
ServerTimeout: No description available. ,
AuthorizationFailed: No description available. ,
BadRequest: No description available. ,
ClientCertificateThumbprintNotSet: No description available. ,
InvalidRequestContent: No description available. ,
OperationFailed: No description available. ,
HttpMethodNotSupported: No description available. ,
InvalidRequestUri: No description available. ,
MissingTenantId: No description available. ,
InvalidTenantId: No description available. ,
InvalidReservationOrderId: No description available. ,
InvalidReservationId: No description available. ,
ReservationIdNotInReservationOrder: No description available. ,
ReservationOrderNotFound: No description available. ,
InvalidSubscriptionId: No description available. ,
InvalidAccessToken: No description available. ,
InvalidLocationId: No description available. ,
UnauthenticatedRequestsThrottled: No description available. ,
InvalidHealthCheckType: No description available. ,
Forbidden: No description available. ,
BillingScopeIdCannotBeChanged: No description available. ,
AppliedScopesNotAssociatedWithCommerceAccount: No description available. ,
PatchValuesSameAsExisting: No description available. ,
RoleAssignmentCreationFailed: No description available. ,
ReservationOrderCreationFailed: No description available. ,
ReservationOrderNotEnabled: No description available. ,
CapacityUpdateScopesFailed: No description available. ,
UnsupportedReservationTerm: No description available. ,
ReservationOrderIdAlreadyExists: No description available. ,
RiskCheckFailed: No description available. ,
CreateQuoteFailed: No description available. ,
ActivateQuoteFailed: No description available. ,
NonsupportedAccountId: No description available. ,
PaymentInstrumentNotFound: No description available. ,
MissingAppliedScopesForSingle: No description available. ,
NoValidReservationsToReRate: No description available. ,
ReRateOnlyAllowedForEA: No description available. ,
OperationCannotBePerformedInCurrentState: No description available. ,
InvalidSingleAppliedScopesCount: No description available. ,
InvalidFulfillmentRequestParameters: No description available. ,
NotSupportedCountry: No description available. ,
InvalidRefundQuantity: No description available. ,
PurchaseError: No description available. ,
BillingCustomerInputError: No description available. ,
BillingPaymentInstrumentSoftError: No description available. ,
BillingPaymentInstrumentHardError: No description available. ,
BillingTransientError: No description available. ,
BillingError: No description available. ,
FulfillmentConfigurationError: No description available. ,
FulfillmentOutOfStockError: No description available. ,
FulfillmentTransientError: No description available. ,
FulfillmentError: No description available. ,
CalculatePriceFailed: No description available. ,
AppliedScopesSameAsExisting: No description available. ,
SelfServiceRefundNotSupported: No description available. ,
RefundLimitExceeded: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Required: False ,
}
string ,
}
,
}
Exchange_Post (updated)
Description :  Returns one or more `Reservations` in exchange for one or more `Reservation` purchases.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Exchange_Post",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "reservationsToPurchase": {
              "$properties": {
                "properties": [
                  {
                    "properties": [
                      {
                        "#name": "reservedResourceType",
                        "Description": {
                          "new": "The type of the resource that is being reserved. In addition to below types we have also added the following: OpenAIPTU, MDC, Sentinel.",
                          "old": "The type of the resource that is being reserved."
                        }
                      }
                    ]
                  }
                ]
              }
            }
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /providers/Microsoft.Capacity/exchange
{
api-version:
{
Description: Supported version. ,
Required: True ,
}
string ,
body:
{
Description: Request containing the refunds and purchases that need to be executed. ,
Required: True ,
}
{
properties:
{
Description: Exchange request properties ,
Required: False ,
}
{
sessionId:
{
Description: SessionId that was returned by CalculateExchange API. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Description: It should match what is used to GET the operation result. ,
Required: False ,
}
string ,
name:
{
Description: It must match the last segment of the id field, and will typically be a GUID / system generated value. ,
Required: False ,
}
string ,
status:
{
Description: Status of the operation. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
PendingRefunds: No description available. ,
PendingPurchases: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: Exchange response properties ,
Required: False ,
}
{
sessionId:
{
Description: Exchange session identifier ,
Required: False ,
}
string ,
netPayable:
{
Description: Pricing information containing the amount and the currency code ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
refundsTotal:
{
Description: Pricing information containing the amount and the currency code ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
purchasesTotal:
{
Description: Pricing information containing the amount and the currency code ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
reservationsToPurchase:
{
Description: Details of the reservations being purchased ,
Required: False ,
}
[
{
reservationOrderId:
{
Description: Fully qualified id of the reservationOrder being purchased ,
Required: False ,
}
string ,
reservationId:
{
Description: Fully qualified id of the reservation being purchased. This value is only guaranteed to be non-null if the purchase is successful. ,
Required: False ,
}
string ,
properties:
{
Description: The request for reservation purchase ,
Required: False ,
}
{
sku:
{
Description: The name of sku ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
}
,
location:
{
Description: The Azure region where the reserved resource lives. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of reservation purchase request ,
Required: False ,
}
{
reservedResourceType:
{
Description: The type of the resource that is being reserved. In addition to below types we have also added the following: OpenAIPTU, MDC, Sentinel. ,
Enum:
{
VirtualMachines: No description available. ,
SqlDatabases: No description available. ,
SuseLinux: No description available. ,
CosmosDb: No description available. ,
RedHat: No description available. ,
SqlDataWarehouse: No description available. ,
VMwareCloudSimple: No description available. ,
RedHatOsa: No description available. ,
Databricks: No description available. ,
AppService: No description available. ,
ManagedDisk: No description available. ,
BlockBlob: No description available. ,
RedisCache: No description available. ,
AzureDataExplorer: No description available. ,
MySql: No description available. ,
MariaDb: No description available. ,
PostgreSql: No description available. ,
DedicatedHost: No description available. ,
SapHana: No description available. ,
SqlAzureHybridBenefit: No description available. ,
AVS: No description available. ,
DataFactory: No description available. ,
NetAppStorage: No description available. ,
AzureFiles: No description available. ,
SqlEdge: No description available. ,
VirtualMachineSoftware: No description available. ,
}
,
Required: False ,
}
enum ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing reservation or savings plan ,
Required: False ,
}
string ,
term:
{
Description: Represent the term of reservation. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
billingPlan:
{
Description: Represent the billing plans. ,
Enum:
{
Upfront: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
quantity:
{
Description: Quantity of the skus that are part of the reservation. ,
Format: int32 ,
Required: False ,
}
integer ,
displayName:
{
Description: Friendly name of the reservation ,
Required: False ,
}
string ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopes:
{
Description: List of the subscriptions that the benefit will be applied. Do not specify if AppliedScopeType is Shared. This property will be deprecated and replaced by appliedScopeProperties instead for Single AppliedScopeType. ,
Required: False ,
}
[
string ,
]
,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the savings plan should apply benefit. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
renew:
{
Description: Setting this to true will automatically purchase a new reservation on the expiration date time. ,
Required: False ,
}
boolean ,
reservedResourceProperties:
{
Description: Properties specific to each reserved resource type. Not required if not applicable. ,
Required: False ,
}
{
instanceFlexibility:
{
Description: Turning this on will apply the reservation discount to other VMs in the same VM size group. Only specify for VirtualMachines reserved resource type. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
reviewDateTime:
{
Description: This is the date-time when the Azure hybrid benefit needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
billingCurrencyTotal:
{
Description: Pricing information containing the amount and the currency code ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
status:
{
Description: Status of the individual operation. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
savingsPlansToPurchase:
{
Description: Details of the savings plans being purchased ,
Required: False ,
}
[
{
savingsPlanOrderId:
{
Description: Fully qualified id of the savings plan order being purchased ,
Required: False ,
}
string ,
savingsPlanId:
{
Description: Fully qualified id of the savings plan being purchased. This value is only guaranteed to be non-null if the purchase is successful. ,
Required: False ,
}
string ,
properties:
{
Description: Request body for savings plan purchase ,
Required: False ,
}
{
sku:
{
Description: The name of sku ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of a savings plan purchase ,
Required: False ,
}
{
displayName:
{
Description: Friendly name of the savings plan ,
Required: False ,
}
string ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing reservation or savings plan ,
Required: False ,
}
string ,
term:
{
Description: Represent savings plan term in ISO 8601 format. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
}
,
Required: False ,
}
enum ,
billingPlan:
{
Description: Represents the billing plan in ISO 8601 format. Required only for monthly billing plans. ,
Enum:
{
P1M: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the savings plan should apply benefit. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
commitment:
{
Description: Commitment towards the benefit. ,
Required: False ,
}
{
grain:
{
Description: Commitment grain. ,
Enum:
{
Hourly: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
billingCurrencyTotal:
{
Description: Pricing information containing the amount and the currency code ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
status:
{
Description: Status of the individual operation. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
reservationsToExchange:
{
Description: Details of the reservations being returned ,
Required: False ,
}
[
{
reservationId:
{
Description: Fully qualified id of the reservation being returned. ,
Required: False ,
}
string ,
quantity:
{
Description: Quantity to be returned ,
Format: int32 ,
Required: False ,
}
integer ,
billingRefundAmount:
{
Description: Pricing information containing the amount and the currency code ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
billingInformation:
{
Description: billing information ,
Required: False ,
}
{
billingCurrencyTotalPaidAmount:
{
Description: Pricing information containing the amount and the currency code ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
billingCurrencyProratedAmount:
{
Description: Pricing information containing the amount and the currency code ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
billingCurrencyRemainingCommitmentAmount:
{
Description: Pricing information containing the amount and the currency code ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
}
,
status:
{
Description: Status of the individual operation. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
policyResult:
{
Description: Exchange policy errors ,
Required: False ,
}
{
policyErrors:
{
Description: Exchange Policy errors ,
Required: False ,
}
[
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
error:
{
Description: Required if status == failed or status == canceled. ,
Required: False ,
}
{
code:
{
Description: Required if status == failed or status == cancelled. If status == failed, provide an invariant error code used for error troubleshooting, aggregation, and analysis. ,
Required: False ,
}
string ,
message:
{
Description: Required if status == failed. Localized. If status == failed, provide an actionable error message indicating what error occurred, and what the user can do to address the issue. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URL for checking the ongoing status of the operation. ,
}
string ,
location:
{
Description: URL for determining when an operation has completed. Only use this value only when Azure-AsyncOperation isn't returned. ,
}
string ,
retry-after:
{
Description: Clients should wait for the Retry-After interval before polling again ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: Extended error information including error code and error message ,
Required: False ,
}
{
code:
{
Description: Error code describing the reason that service is not able to process the incoming request ,
Enum:
{
NotSpecified: No description available. ,
InternalServerError: No description available. ,
ServerTimeout: No description available. ,
AuthorizationFailed: No description available. ,
BadRequest: No description available. ,
ClientCertificateThumbprintNotSet: No description available. ,
InvalidRequestContent: No description available. ,
OperationFailed: No description available. ,
HttpMethodNotSupported: No description available. ,
InvalidRequestUri: No description available. ,
MissingTenantId: No description available. ,
InvalidTenantId: No description available. ,
InvalidReservationOrderId: No description available. ,
InvalidReservationId: No description available. ,
ReservationIdNotInReservationOrder: No description available. ,
ReservationOrderNotFound: No description available. ,
InvalidSubscriptionId: No description available. ,
InvalidAccessToken: No description available. ,
InvalidLocationId: No description available. ,
UnauthenticatedRequestsThrottled: No description available. ,
InvalidHealthCheckType: No description available. ,
Forbidden: No description available. ,
BillingScopeIdCannotBeChanged: No description available. ,
AppliedScopesNotAssociatedWithCommerceAccount: No description available. ,
PatchValuesSameAsExisting: No description available. ,
RoleAssignmentCreationFailed: No description available. ,
ReservationOrderCreationFailed: No description available. ,
ReservationOrderNotEnabled: No description available. ,
CapacityUpdateScopesFailed: No description available. ,
UnsupportedReservationTerm: No description available. ,
ReservationOrderIdAlreadyExists: No description available. ,
RiskCheckFailed: No description available. ,
CreateQuoteFailed: No description available. ,
ActivateQuoteFailed: No description available. ,
NonsupportedAccountId: No description available. ,
PaymentInstrumentNotFound: No description available. ,
MissingAppliedScopesForSingle: No description available. ,
NoValidReservationsToReRate: No description available. ,
ReRateOnlyAllowedForEA: No description available. ,
OperationCannotBePerformedInCurrentState: No description available. ,
InvalidSingleAppliedScopesCount: No description available. ,
InvalidFulfillmentRequestParameters: No description available. ,
NotSupportedCountry: No description available. ,
InvalidRefundQuantity: No description available. ,
PurchaseError: No description available. ,
BillingCustomerInputError: No description available. ,
BillingPaymentInstrumentSoftError: No description available. ,
BillingPaymentInstrumentHardError: No description available. ,
BillingTransientError: No description available. ,
BillingError: No description available. ,
FulfillmentConfigurationError: No description available. ,
FulfillmentOutOfStockError: No description available. ,
FulfillmentTransientError: No description available. ,
FulfillmentError: No description available. ,
CalculatePriceFailed: No description available. ,
AppliedScopesSameAsExisting: No description available. ,
SelfServiceRefundNotSupported: No description available. ,
RefundLimitExceeded: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Required: False ,
}
string ,
}
,
}
Reservation_ListAll (updated)
Description :  List the reservations and the roll up counts of reservations group by provisioning states that the user has access to in the current tenant.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Reservation_ListAll",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "renewProperties": [
                  {
                    "purchaseProperties": [
                      {
                        "properties": [
                          {
                            "#name": "reservedResourceType",
                            "Description": {
                              "new": "The type of the resource that is being reserved. In addition to below types we have also added the following: OpenAIPTU, MDC, Sentinel.",
                              "old": "The type of the resource that is being reserved."
                            }
                          }
                        ]
                      }
                    ]
                  }
                ]
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /providers/Microsoft.Capacity/reservations
{
api-version:
{
Description: Supported version. ,
Required: True ,
}
string ,
$filter:
{
Description: May be used to filter by reservation properties. The filter supports 'eq', 'or', and 'and'. It does not currently support 'ne', 'gt', 'le', 'ge', or 'not'. Reservation properties include sku/name, properties/{appliedScopeType, archived, displayName, displayProvisioningState, effectiveDateTime, expiryDate, expiryDateTime, provisioningState, quantity, renew, reservedResourceType, term, userFriendlyAppliedScopeType, userFriendlyRenewState} ,
Required: False ,
}
string ,
$orderby:
{
Description: May be used to sort order by reservation properties. ,
Required: False ,
}
string ,
refreshSummary:
{
Description: To indicate whether to refresh the roll up counts of the reservations group by provisioning states ,
Required: False ,
}
string ,
$skiptoken:
{
Description: The number of reservations to skip from the list before returning results ,
Required: False ,
}
number ,
selectedState:
{
Description: The selected provisioning state ,
Required: False ,
}
string ,
take:
{
Description: To number of reservations to return ,
Required: False ,
}
number ,
}

⚐ Response (200)

{
value:
{
Description: The list of reservations. ,
Required: False ,
}
[
{
location:
{
Description: The Azure region where the reserved resource lives. ,
Required: False ,
}
string ,
etag:
{
Format: int32 ,
Required: False ,
}
integer ,
sku:
{
Description: The sku information associated to this reservation ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties associated to this reservation ,
Required: False ,
}
{
reservedResourceType:
{
Description: The type of the resource that is being reserved. ,
Enum:
{
VirtualMachines: No description available. ,
SqlDatabases: No description available. ,
SuseLinux: No description available. ,
CosmosDb: No description available. ,
RedHat: No description available. ,
SqlDataWarehouse: No description available. ,
VMwareCloudSimple: No description available. ,
RedHatOsa: No description available. ,
Databricks: No description available. ,
AppService: No description available. ,
ManagedDisk: No description available. ,
BlockBlob: No description available. ,
RedisCache: No description available. ,
AzureDataExplorer: No description available. ,
MySql: No description available. ,
MariaDb: No description available. ,
PostgreSql: No description available. ,
DedicatedHost: No description available. ,
SapHana: No description available. ,
SqlAzureHybridBenefit: No description available. ,
AVS: No description available. ,
DataFactory: No description available. ,
NetAppStorage: No description available. ,
AzureFiles: No description available. ,
SqlEdge: No description available. ,
VirtualMachineSoftware: No description available. ,
}
,
Required: False ,
}
enum ,
instanceFlexibility:
{
Description: Allows reservation discount to be applied across skus within the same auto fit group. Not all skus support instance size flexibility. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Friendly name for user to easily identify the reservation ,
Required: False ,
}
string ,
appliedScopes:
{
Description: The list of applied scopes ,
Required: False ,
}
[
string ,
]
,
appliedScopeType:
{
Description: The applied scope type ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
archived:
{
Description: Indicates if the reservation is archived ,
Required: False ,
}
boolean ,
capabilities:
{
Description: Capabilities of the reservation ,
Required: False ,
}
string ,
quantity:
{
Description: Quantity of the skus that are part of the reservation. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: Current state of the reservation. ,
Enum:
{
Creating: No description available. ,
PendingResourceHold: No description available. ,
ConfirmedResourceHold: No description available. ,
PendingBilling: No description available. ,
ConfirmedBilling: No description available. ,
Created: No description available. ,
Succeeded: No description available. ,
Cancelled: No description available. ,
Expired: No description available. ,
BillingFailed: No description available. ,
Failed: No description available. ,
Split: No description available. ,
Merged: No description available. ,
}
,
Required: False ,
}
enum ,
effectiveDateTime:
{
Description: DateTime of the reservation starting when this version is effective from. ,
Format: date-time ,
Required: False ,
}
string ,
benefitStartTime:
{
Description: This is the DateTime when the reservation benefit started. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedDateTime:
{
Description: DateTime of the last time the reservation was updated. ,
Format: date-time ,
Required: False ,
}
string ,
expiryDate:
{
Description: This is the date when the reservation will expire. ,
Format: date ,
Required: False ,
}
string ,
expiryDateTime:
{
Description: This is the date-time when the reservation will expire. ,
Format: date-time ,
Required: False ,
}
string ,
reviewDateTime:
{
Description: This is the date-time when the Azure Hybrid Benefit needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
skuDescription:
{
Description: Description of the sku in english. ,
Required: False ,
}
string ,
extendedStatusInfo:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
{
statusCode:
{
Enum:
{
None: No description available. ,
Pending: No description available. ,
Processing: No description available. ,
Active: No description available. ,
PurchaseError: No description available. ,
PaymentInstrumentError: No description available. ,
Split: No description available. ,
Merged: No description available. ,
Expired: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
string ,
}
,
billingPlan:
{
Description: The billing plan options available for this sku. ,
Enum:
{
Upfront: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
displayProvisioningState:
{
Description: The provisioning state of the reservation for display, e.g. Succeeded ,
Required: False ,
}
string ,
provisioningSubState:
{
Description: The provisioning sub-state of the reservation, e.g. Succeeded ,
Required: False ,
}
string ,
purchaseDate:
{
Description: This is the date when the reservation was purchased. ,
Format: date ,
Required: False ,
}
string ,
purchaseDateTime:
{
Description: This is the date-time when the reservation was purchased. ,
Format: date-time ,
Required: False ,
}
string ,
splitProperties:
{
Description: Properties of reservation split ,
Required: False ,
}
{
splitDestinations:
{
Description: List of destination resource id that are created due to split. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
[
string ,
]
,
splitSource:
{
Description: Resource id of the reservation from which this is split. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
}
,
mergeProperties:
{
Description: Properties of reservation merge ,
Required: False ,
}
{
mergeDestination:
{
Description: Reservation resource id Created due to the merge. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
mergeSources:
{
Description: Resource ids of the source reservation's merged to form this reservation. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
[
string ,
]
,
}
,
swapProperties:
{
Description: Properties of reservation swap ,
Required: False ,
}
{
swapSource:
{
Description: Resource id of the source reservation that gets swapped. Format of the resource id is /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
swapDestination:
{
Description: Reservation resource id that the original resource gets swapped to. Format of the resource id is /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
}
,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the savings plan should apply benefit. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
billingScopeId:
{
Description: Subscription that will be charged for purchasing reservation or savings plan ,
Required: False ,
}
string ,
renew:
{
Description: Setting this to true will automatically purchase a new reservation on the expiration date time. ,
Required: False ,
}
boolean ,
renewSource:
{
Description: Reservation Id of the reservation from which this reservation is renewed. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}. ,
Required: False ,
}
string ,
renewDestination:
{
Description: Reservation Id of the reservation which is purchased because of renew. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}. ,
Required: False ,
}
string ,
renewProperties:
{
Description: The renew properties for a reservation. ,
Required: False ,
}
{
purchaseProperties:
{
Description: The request for reservation purchase ,
Required: False ,
}
{
sku:
{
Description: The name of sku ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
}
,
location:
{
Description: The Azure region where the reserved resource lives. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of reservation purchase request ,
Required: False ,
}
{
reservedResourceType:
{
Description: The type of the resource that is being reserved. In addition to below types we have also added the following: OpenAIPTU, MDC, Sentinel. ,
Enum:
{
VirtualMachines: No description available. ,
SqlDatabases: No description available. ,
SuseLinux: No description available. ,
CosmosDb: No description available. ,
RedHat: No description available. ,
SqlDataWarehouse: No description available. ,
VMwareCloudSimple: No description available. ,
RedHatOsa: No description available. ,
Databricks: No description available. ,
AppService: No description available. ,
ManagedDisk: No description available. ,
BlockBlob: No description available. ,
RedisCache: No description available. ,
AzureDataExplorer: No description available. ,
MySql: No description available. ,
MariaDb: No description available. ,
PostgreSql: No description available. ,
DedicatedHost: No description available. ,
SapHana: No description available. ,
SqlAzureHybridBenefit: No description available. ,
AVS: No description available. ,
DataFactory: No description available. ,
NetAppStorage: No description available. ,
AzureFiles: No description available. ,
SqlEdge: No description available. ,
VirtualMachineSoftware: No description available. ,
}
,
Required: False ,
}
enum ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing reservation or savings plan ,
Required: False ,
}
string ,
term:
{
Description: Represent the term of reservation. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
billingPlan:
{
Description: Represent the billing plans. ,
Enum:
{
Upfront: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
quantity:
{
Description: Quantity of the skus that are part of the reservation. ,
Format: int32 ,
Required: False ,
}
integer ,
displayName:
{
Description: Friendly name of the reservation ,
Required: False ,
}
string ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopes:
{
Description: List of the subscriptions that the benefit will be applied. Do not specify if AppliedScopeType is Shared. This property will be deprecated and replaced by appliedScopeProperties instead for Single AppliedScopeType. ,
Required: False ,
}
[
string ,
]
,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the savings plan should apply benefit. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
renew:
{
Description: Setting this to true will automatically purchase a new reservation on the expiration date time. ,
Required: False ,
}
boolean ,
reservedResourceProperties:
{
Description: Properties specific to each reserved resource type. Not required if not applicable. ,
Required: False ,
}
{
instanceFlexibility:
{
Description: Turning this on will apply the reservation discount to other VMs in the same VM size group. Only specify for VirtualMachines reserved resource type. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
reviewDateTime:
{
Description: This is the date-time when the Azure hybrid benefit needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
pricingCurrencyTotal:
{
Description: 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. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Required: False ,
}
number ,
}
,
billingCurrencyTotal:
{
Description: Currency and amount that customer will be charged in customer's local currency for renewal purchase. Tax is not included. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Required: False ,
}
number ,
}
,
}
,
term:
{
Description: Represent the term of reservation. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
userFriendlyAppliedScopeType:
{
Description: The applied scope type of the reservation for display, e.g. Shared ,
Required: False ,
}
string ,
userFriendlyRenewState:
{
Description: The renew state of the reservation for display, e.g. On ,
Required: False ,
}
string ,
utilization:
{
Description: Reservation utilization ,
Required: False ,
}
{
trend:
{
Description: last 7 day utilization trend for a reservation ,
Required: False ,
}
string ,
aggregates:
{
Description: The array of aggregates of a reservation's utilization ,
Required: False ,
}
[
{
grain:
{
Description: The grain of the aggregate ,
Required: False ,
}
number ,
grainUnit:
{
Description: The grain unit of the aggregate ,
Required: False ,
}
string ,
value:
{
Description: The aggregate value ,
Required: False ,
}
number ,
valueUnit:
{
Description: The aggregate value unit ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
kind:
{
Description: Resource Provider type to be reserved. ,
Enum:
{
Microsoft.Compute: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
summary:
{
Description: The roll out count summary of the reservations ,
Required: False ,
}
{
succeededCount:
{
Description: The number of reservation in Succeeded state ,
Required: False ,
}
number ,
failedCount:
{
Description: The number of reservation in Failed state ,
Required: False ,
}
number ,
expiringCount:
{
Description: The number of reservation in Expiring state ,
Required: False ,
}
number ,
expiredCount:
{
Description: The number of reservation in Expired state ,
Required: False ,
}
number ,
pendingCount:
{
Description: The number of reservation in Pending state ,
Required: False ,
}
number ,
cancelledCount:
{
Description: The number of reservation in Cancelled state ,
Required: False ,
}
number ,
processingCount:
{
Description: The number of reservation in Processing state ,
Required: False ,
}
number ,
warningCount:
{
Description: The number of reservation in Warning state ,
Required: False ,
}
number ,
noBenefitCount:
{
Description: The number of reservation in NoBenefit state ,
Required: False ,
}
number ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}