Reservation - Update
Updates a Reservation
.
Updates the applied scopes of the Reservation
.
PATCH https://management.azure.com/providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}?api-version=2022-11-01
Name | In | Required | Type | Description |
---|---|---|---|---|
reservation
|
path | True |
string |
Id of the reservation item |
reservation
|
path | True |
string |
Order Id of the reservation |
api-version
|
query | True |
string |
Supported version. |
Name | Type | Description |
---|---|---|
properties.appliedScopeProperties |
Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup |
|
properties.appliedScopeType |
Type of the Applied Scope. |
|
properties.appliedScopes |
string[] |
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. |
properties.instanceFlexibility |
Turning this on will apply the reservation discount to other VMs in the same VM size group. Only specify for VirtualMachines reserved resource type. |
|
properties.name |
string |
Display name of the reservation |
properties.renew |
boolean |
Setting this to true will automatically purchase a new reservation on the expiration date time. |
properties.renewProperties | ||
properties.reviewDateTime |
string |
This is the date-time when the Azure hybrid benefit needs to be reviewed. |
Name | Type | Description |
---|---|---|
200 OK |
Returns the updated |
|
202 Accepted |
The request is accepted and is being processed Headers
|
|
Other Status Codes |
Unexpected error |
Sample request
PATCH https://management.azure.com/providers/Microsoft.Capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/6ef59113-3482-40da-8d79-787f823e34bc?api-version=2022-11-01
{
"properties": {
"appliedScopeType": "Shared",
"instanceFlexibility": "Off"
}
}
Sample response
{
"sku": {
"name": "Standard_DS1_v2"
},
"id": "/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/6ef59113-3482-40da-8d79-787f823e34bc",
"type": "Microsoft.Capacity/reservationOrders/reservations",
"name": "6ef59113-3482-40da-8d79-787f823e34bc",
"etag": 4,
"location": "eastus",
"properties": {
"appliedScopeType": "Shared",
"renew": false,
"billingScopeId": "/subscriptions/19376483-64b8-49e4-a931-d5248828720a",
"quantity": 3,
"provisioningState": "Succeeded",
"expiryDate": "2018-09-22",
"expiryDateTime": "2018-09-22T23:57:48.1891638Z",
"displayName": "cabri_test",
"billingPlan": "Monthly",
"effectiveDateTime": "2017-09-22T23:57:48.1891638Z",
"lastUpdatedDateTime": "2017-09-22T23:57:54.3768768Z",
"reservedResourceType": "VirtualMachines",
"instanceFlexibility": "Off",
"skuDescription": "D1 v2",
"mergeProperties": {
"mergeSources": [
"/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/00238563-7312-4c20-a134-8c030bf938a7",
"/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/e0e4b4f5-77ea-4984-9ee4-6bf9850ee6de"
]
}
}
}
Azure-AsyncOperation: https://management.azure.com/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/6ef59113-3482-40da-8d79-787f823e34bc?api-version=2022-11-01
Location: https://management.azure.com/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/6ef59113-3482-40da-8d79-787f823e34bc?api-version=2022-11-01
Retry-After: 120
Name | Description |
---|---|
Applied |
Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup |
Applied |
Type of the Applied Scope. |
Billing |
Currency and amount that customer will be charged in customer's local currency for renewal purchase. Tax is not included. |
created |
The type of identity that created the resource. |
Error |
Error information |
Error |
Error code describing the reason that service is not able to process the incoming request |
Extended |
Extended error information including error code and error message |
Extended |
|
Instance |
Turning this on will apply the reservation discount to other VMs in the same VM size group. Only specify for VirtualMachines reserved resource type. |
Kind |
Resource Provider type to be reserved. |
Patch |
The request for reservation patch |
Pricing |
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. |
Provisioning |
Represent the current state of the Reservation. |
Purchase |
The request for reservation purchase |
Renew |
|
Renew |
The renew properties for a reservation. |
Reservation |
Represent the billing plans. |
Reservation |
Properties of reservation merge |
Reservation |
The definition of the reservation. |
Reservation |
Properties of reservation split |
Reservations |
The properties of the reservations |
Reservation |
|
Reservation |
Properties of reservation swap |
Reservation |
Represent the term of reservation. |
Reservation |
The aggregate values of reservation utilization |
Reserved |
Properties specific to each reserved resource type. Not required if not applicable. |
Reserved |
The type of the resource that is being reserved. |
Sku |
The name of sku |
system |
Metadata pertaining to creation and last modification of the resource. |
Utilization |
Reservation utilization |
Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup
Name | Type | Description |
---|---|---|
displayName |
string |
Display name |
managementGroupId |
string |
Fully-qualified identifier of the management group where the benefit must be applied. |
resourceGroupId |
string |
Fully-qualified identifier of the resource group. |
subscriptionId |
string |
Fully-qualified identifier of the subscription. |
tenantId |
string |
Tenant ID where the savings plan should apply benefit. |
Type of the Applied Scope.
Name | Type | Description |
---|---|---|
ManagementGroup |
string |
|
Shared |
string |
|
Single |
string |
Currency and amount that customer will be charged in customer's local currency for renewal purchase. Tax is not included.
Name | Type | Description |
---|---|---|
amount |
number |
|
currencyCode |
string |
The ISO 4217 3-letter currency code for the currency used by this purchase record. |
The type of identity that created the resource.
Name | Type | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
Error information
Name | Type | Description |
---|---|---|
error |
Extended error information including error code and error message |
Error code describing the reason that service is not able to process the incoming request
Name | Type | Description |
---|---|---|
ActivateQuoteFailed |
string |
|
AppliedScopesNotAssociatedWithCommerceAccount |
string |
|
AppliedScopesSameAsExisting |
string |
|
AuthorizationFailed |
string |
|
BadRequest |
string |
|
BillingCustomerInputError |
string |
|
BillingError |
string |
|
BillingPaymentInstrumentHardError |
string |
|
BillingPaymentInstrumentSoftError |
string |
|
BillingScopeIdCannotBeChanged |
string |
|
BillingTransientError |
string |
|
CalculatePriceFailed |
string |
|
CapacityUpdateScopesFailed |
string |
|
ClientCertificateThumbprintNotSet |
string |
|
CreateQuoteFailed |
string |
|
Forbidden |
string |
|
FulfillmentConfigurationError |
string |
|
FulfillmentError |
string |
|
FulfillmentOutOfStockError |
string |
|
FulfillmentTransientError |
string |
|
HttpMethodNotSupported |
string |
|
InternalServerError |
string |
|
InvalidAccessToken |
string |
|
InvalidFulfillmentRequestParameters |
string |
|
InvalidHealthCheckType |
string |
|
InvalidLocationId |
string |
|
InvalidRefundQuantity |
string |
|
InvalidRequestContent |
string |
|
InvalidRequestUri |
string |
|
InvalidReservationId |
string |
|
InvalidReservationOrderId |
string |
|
InvalidSingleAppliedScopesCount |
string |
|
InvalidSubscriptionId |
string |
|
InvalidTenantId |
string |
|
MissingAppliedScopesForSingle |
string |
|
MissingTenantId |
string |
|
NoValidReservationsToReRate |
string |
|
NonsupportedAccountId |
string |
|
NotSpecified |
string |
|
NotSupportedCountry |
string |
|
OperationCannotBePerformedInCurrentState |
string |
|
OperationFailed |
string |
|
PatchValuesSameAsExisting |
string |
|
PaymentInstrumentNotFound |
string |
|
PurchaseError |
string |
|
ReRateOnlyAllowedForEA |
string |
|
RefundLimitExceeded |
string |
|
ReservationIdNotInReservationOrder |
string |
|
ReservationOrderCreationFailed |
string |
|
ReservationOrderIdAlreadyExists |
string |
|
ReservationOrderNotEnabled |
string |
|
ReservationOrderNotFound |
string |
|
RiskCheckFailed |
string |
|
RoleAssignmentCreationFailed |
string |
|
SelfServiceRefundNotSupported |
string |
|
ServerTimeout |
string |
|
UnauthenticatedRequestsThrottled |
string |
|
UnsupportedReservationTerm |
string |
Extended error information including error code and error message
Name | Type | Description |
---|---|---|
code |
Error code describing the reason that service is not able to process the incoming request |
|
message |
string |
Name | Type | Description |
---|---|---|
message |
string |
The message giving detailed information about the status code. |
statusCode |
Turning this on will apply the reservation discount to other VMs in the same VM size group. Only specify for VirtualMachines reserved resource type.
Name | Type | Description |
---|---|---|
Off |
string |
|
On |
string |
Resource Provider type to be reserved.
Name | Type | Description |
---|---|---|
Microsoft.Compute |
string |
The request for reservation patch
Name | Type | Default value | Description |
---|---|---|---|
properties.appliedScopeProperties |
Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup |
||
properties.appliedScopeType |
Type of the Applied Scope. |
||
properties.appliedScopes |
string[] |
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. |
|
properties.instanceFlexibility |
Turning this on will apply the reservation discount to other VMs in the same VM size group. Only specify for VirtualMachines reserved resource type. |
||
properties.name |
string |
Display name of the reservation |
|
properties.renew |
boolean |
False |
Setting this to true will automatically purchase a new reservation on the expiration date time. |
properties.renewProperties | |||
properties.reviewDateTime |
string |
This is the date-time when the Azure hybrid benefit needs to be reviewed. |
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.
Name | Type | Description |
---|---|---|
amount |
number |
|
currencyCode |
string |
The ISO 4217 3-letter currency code for the currency used by this purchase record. |
Represent the current state of the Reservation.
Name | Type | Description |
---|---|---|
BillingFailed |
string |
|
Cancelled |
string |
|
ConfirmedBilling |
string |
|
ConfirmedResourceHold |
string |
|
Created |
string |
|
Creating |
string |
|
Expired |
string |
|
Failed |
string |
|
Merged |
string |
|
PendingBilling |
string |
|
PendingResourceHold |
string |
|
Split |
string |
|
Succeeded |
string |
The request for reservation purchase
Name | Type | Default value | Description |
---|---|---|---|
location |
string |
The Azure region where the reserved resource lives. |
|
properties.appliedScopeProperties |
Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup |
||
properties.appliedScopeType |
Type of the Applied Scope. |
||
properties.appliedScopes |
string[] |
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. |
|
properties.billingPlan |
Represent the billing plans. |
||
properties.billingScopeId |
string |
Subscription that will be charged for purchasing reservation or savings plan |
|
properties.displayName |
string |
Friendly name of the reservation |
|
properties.quantity |
integer |
Quantity of the skus that are part of the reservation. |
|
properties.renew |
boolean |
False |
Setting this to true will automatically purchase a new reservation on the expiration date time. |
properties.reservedResourceProperties |
Properties specific to each reserved resource type. Not required if not applicable. |
||
properties.reservedResourceType |
The type of the resource that is being reserved. |
||
properties.reviewDateTime |
string |
This is the date-time when the Azure hybrid benefit needs to be reviewed. |
|
properties.term |
Represent the term of reservation. |
||
sku |
The name of sku |
Name | Type | Description |
---|---|---|
purchaseProperties |
The request for reservation purchase |
The renew properties for a reservation.
Name | Type | Description |
---|---|---|
billingCurrencyTotal |
Currency and amount that customer will be charged in customer's local currency for renewal purchase. Tax is not included. |
|
pricingCurrencyTotal |
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. |
|
purchaseProperties |
The request for reservation purchase |
Represent the billing plans.
Name | Type | Description |
---|---|---|
Monthly |
string |
|
Upfront |
string |
Properties of reservation merge
Name | Type | Description |
---|---|---|
mergeDestination |
string |
Reservation resource id Created due to the merge. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} |
mergeSources |
string[] |
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} |
The definition of the reservation.
Name | Type | Description |
---|---|---|
etag |
integer |
|
id |
string |
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" |
kind |
Resource Provider type to be reserved. |
|
location |
string |
The Azure region where the reserved resource lives. |
name |
string |
The name of the resource |
properties |
The properties associated to this reservation |
|
sku |
The sku information associated to this reservation |
|
systemData |
Azure Resource Manager metadata containing createdBy and modifiedBy information. |
|
type |
string |
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
Properties of reservation split
Name | Type | Description |
---|---|---|
splitDestinations |
string[] |
List of destination resource id that are created due to split. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} |
splitSource |
string |
Resource id of the reservation from which this is split. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} |
The properties of the reservations
Name | Type | Default value | Description |
---|---|---|---|
appliedScopeProperties |
Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup |
||
appliedScopeType |
The applied scope type |
||
appliedScopes |
string[] |
The list of applied scopes |
|
archived |
boolean |
Indicates if the reservation is archived |
|
benefitStartTime |
string |
This is the DateTime when the reservation benefit started. |
|
billingPlan |
The billing plan options available for this sku. |
||
billingScopeId |
string |
Subscription that will be charged for purchasing reservation or savings plan |
|
capabilities |
string |
Capabilities of the reservation |
|
displayName |
string |
Friendly name for user to easily identify the reservation |
|
displayProvisioningState |
string |
The provisioning state of the reservation for display, e.g. Succeeded |
|
effectiveDateTime |
string |
DateTime of the reservation starting when this version is effective from. |
|
expiryDate |
string |
This is the date when the reservation will expire. |
|
expiryDateTime |
string |
This is the date-time when the reservation will expire. |
|
extendedStatusInfo |
The message giving detailed information about the status code. |
||
instanceFlexibility |
Allows reservation discount to be applied across skus within the same auto fit group. Not all skus support instance size flexibility. |
||
lastUpdatedDateTime |
string |
DateTime of the last time the reservation was updated. |
|
mergeProperties |
Properties of reservation merge |
||
provisioningState |
Current state of the reservation. |
||
provisioningSubState |
string |
The provisioning sub-state of the reservation, e.g. Succeeded |
|
purchaseDate |
string |
This is the date when the reservation was purchased. |
|
purchaseDateTime |
string |
This is the date-time when the reservation was purchased. |
|
quantity |
integer |
Quantity of the skus that are part of the reservation. |
|
renew |
boolean |
False |
Setting this to true will automatically purchase a new reservation on the expiration date time. |
renewDestination |
string |
Reservation Id of the reservation which is purchased because of renew. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}. |
|
renewProperties |
The renew properties for a reservation. |
||
renewSource |
string |
Reservation Id of the reservation from which this reservation is renewed. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}. |
|
reservedResourceType |
The type of the resource that is being reserved. |
||
reviewDateTime |
string |
This is the date-time when the Azure Hybrid Benefit needs to be reviewed. |
|
skuDescription |
string |
Description of the sku in english. |
|
splitProperties |
Properties of reservation split |
||
swapProperties |
Properties of reservation swap |
||
term |
Represent the term of reservation. |
||
userFriendlyAppliedScopeType |
string |
The applied scope type of the reservation for display, e.g. Shared |
|
userFriendlyRenewState |
string |
The renew state of the reservation for display, e.g. On |
|
utilization |
Reservation utilization |
Name | Type | Description |
---|---|---|
Active |
string |
|
Expired |
string |
|
Merged |
string |
|
None |
string |
|
PaymentInstrumentError |
string |
|
Pending |
string |
|
Processing |
string |
|
PurchaseError |
string |
|
Split |
string |
|
Succeeded |
string |
Properties of reservation swap
Name | Type | Description |
---|---|---|
swapDestination |
string |
Reservation resource id that the original resource gets swapped to. Format of the resource id is /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} |
swapSource |
string |
Resource id of the source reservation that gets swapped. Format of the resource id is /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} |
Represent the term of reservation.
Name | Type | Description |
---|---|---|
P1Y |
string |
|
P3Y |
string |
|
P5Y |
string |
The aggregate values of reservation utilization
Name | Type | Description |
---|---|---|
grain |
number |
The grain of the aggregate |
grainUnit |
string |
The grain unit of the aggregate |
value |
number |
The aggregate value |
valueUnit |
string |
The aggregate value unit |
Properties specific to each reserved resource type. Not required if not applicable.
Name | Type | Description |
---|---|---|
instanceFlexibility |
Turning this on will apply the reservation discount to other VMs in the same VM size group. Only specify for VirtualMachines reserved resource type. |
The type of the resource that is being reserved.
Name | Type | Description |
---|---|---|
AVS |
string |
|
AppService |
string |
|
AzureDataExplorer |
string |
|
AzureFiles |
string |
|
BlockBlob |
string |
|
CosmosDb |
string |
|
DataFactory |
string |
|
Databricks |
string |
|
DedicatedHost |
string |
|
ManagedDisk |
string |
|
MariaDb |
string |
|
MySql |
string |
|
NetAppStorage |
string |
|
PostgreSql |
string |
|
RedHat |
string |
|
RedHatOsa |
string |
|
RedisCache |
string |
|
SapHana |
string |
|
SqlAzureHybridBenefit |
string |
|
SqlDataWarehouse |
string |
|
SqlDatabases |
string |
|
SqlEdge |
string |
|
SuseLinux |
string |
|
VMwareCloudSimple |
string |
|
VirtualMachineSoftware |
string |
|
VirtualMachines |
string |
The name of sku
Name | Type | Description |
---|---|---|
name |
string |
Metadata pertaining to creation and last modification of the resource.
Name | Type | Description |
---|---|---|
createdAt |
string |
The timestamp of resource creation (UTC). |
createdBy |
string |
The identity that created the resource. |
createdByType |
The type of identity that created the resource. |
|
lastModifiedAt |
string |
The timestamp of resource last modification (UTC) |
lastModifiedBy |
string |
The identity that last modified the resource. |
lastModifiedByType |
The type of identity that last modified the resource. |
Reservation utilization
Name | Type | Description |
---|---|---|
aggregates |
The array of aggregates of a reservation's utilization |
|
trend |
string |
last 7 day utilization trend for a reservation |