Reservation - List All
List the reservations and the roll up counts of reservations group by provisioning states that the user has access to in the current tenant.
GET https://management.azure.com/providers/Microsoft.Capacity/reservations?api-version=2022-11-01
GET https://management.azure.com/providers/Microsoft.Capacity/reservations?api-version=2022-11-01&$filter={$filter}&$orderby={$orderby}&refreshSummary={refreshSummary}&$skiptoken={$skiptoken}&selectedState={selectedState}&take={take}
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
api-version
|
query | True |
string |
Supported version. |
$filter
|
query |
string |
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} |
|
$orderby
|
query |
string |
May be used to sort order by reservation properties. |
|
$skiptoken
|
query |
number |
The number of reservations to skip from the list before returning results |
|
refresh
|
query |
string |
To indicate whether to refresh the roll up counts of the reservations group by provisioning states |
|
selected
|
query |
string |
The selected provisioning state |
|
take
|
query |
number |
To number of reservations to return |
Responses
Name | Type | Description |
---|---|---|
200 OK |
OK. The request has succeeded. |
|
Other Status Codes |
Error response describing why the operation failed. |
Examples
ReservationListAll
Sample Request
Sample Response
{
"value": [
{
"id": "/providers/microsoft.capacity/reservationOrders/00000000-0000-0000-0000-000000000001/reservations/00000000-0000-0000-0000-000000000000",
"name": "00000000-0000-0000-0000-000000000001/00000000-0000-0000-0000-000000000000",
"type": "Microsoft.Capacity/reservationOrders/reservations",
"location": "westus",
"sku": {
"name": "Standard_D1"
},
"properties": {
"appliedScopeType": "Shared",
"displayName": "VM_RI_07-21-2020_12-06",
"displayProvisioningState": "Succeeded",
"effectiveDateTime": "2017-09-22T22:46:32.7632798Z",
"expiryDate": "2023-07-21",
"expiryDateTime": "2023-07-21T22:46:32.7632798Z",
"provisioningState": "Succeeded",
"provisioningSubState": null,
"purchaseDate": "2021-04-22",
"purchaseDateTime": "2021-04-22T22:46:32.7632798Z",
"quantity": 2,
"renew": false,
"renewSource": "/providers/Microsoft.Capacity/reservationorders/00000000-0000-0000-0000-000000000002/reservations/00000000-0000-0000-0000-000000000003",
"reservedResourceType": "VirtualMachines",
"skuDescription": null,
"term": "P3Y",
"userFriendlyAppliedScopeType": "Shared",
"userFriendlyRenewState": "Off",
"utilization": {
"trend": "UP",
"aggregates": [
{
"grain": 1,
"grainUnit": "days",
"value": 0.05,
"valueUnit": "percentage"
},
{
"grain": 7,
"grainUnit": "days",
"value": 0.05,
"valueUnit": "percentage"
},
{
"grain": 30,
"grainUnit": "days",
"value": 0.05,
"valueUnit": "percentage"
}
]
}
}
}
],
"summary": {
"succeededCount": 1,
"failedCount": 0,
"expiringCount": 0,
"expiredCount": 0,
"pendingCount": 0,
"cancelledCount": 0
},
"nextLink": null
}
Definitions
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 |
The details of the error. |
Error |
Error response indicates that the service is not able to process the incoming request. The reason is provided in the 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. |
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 |
The renew properties for a reservation. |
Reservation |
Represent the billing plans. |
Reservation |
Properties of reservation merge |
Reservation |
The definition of the reservation. |
Reservations |
The list of reservations and summary of roll out count of reservations in each state. |
Reservation |
Properties of reservation split |
Reservations |
The properties of the reservations |
Reservation |
|
Reservation |
The roll up count summary of reservations in each state |
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 |
AppliedScopeProperties
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. |
AppliedScopeType
Type of the Applied Scope.
Name | Type | Description |
---|---|---|
ManagementGroup |
string |
|
Shared |
string |
|
Single |
string |
BillingCurrencyTotal
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. |
createdByType
The type of identity that created the resource.
Name | Type | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
ErrorDetails
The details of the error.
Name | Type | Description |
---|---|---|
code |
string |
Error code. |
message |
string |
Error message indicating why the operation failed. |
target |
string |
The target of the particular error. |
ErrorResponse
Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.
Name | Type | Description |
---|---|---|
error |
The details of the error. |
ExtendedStatusInfo
Name | Type | Description |
---|---|---|
message |
string |
The message giving detailed information about the status code. |
statusCode |
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.
Name | Type | Description |
---|---|---|
Off |
string |
|
On |
string |
Kind
Resource Provider type to be reserved.
Name | Type | Description |
---|---|---|
Microsoft.Compute |
string |
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.
Name | Type | Description |
---|---|---|
amount |
number |
|
currencyCode |
string |
The ISO 4217 3-letter currency code for the currency used by this purchase record. |
ProvisioningState
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 |
PurchaseRequest
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 |
RenewPropertiesResponse
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 |
ReservationBillingPlan
Represent the billing plans.
Name | Type | Description |
---|---|---|
Monthly |
string |
|
Upfront |
string |
ReservationMergeProperties
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} |
ReservationResponse
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" |
ReservationsListResult
The list of reservations and summary of roll out count of reservations in each state.
Name | Type | Description |
---|---|---|
nextLink |
string |
The link (url) to the next page of results. |
summary |
The roll out count summary of the reservations |
|
value |
The list of reservations. |
ReservationSplitProperties
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} |
ReservationsProperties
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 |
ReservationStatusCode
Name | Type | Description |
---|---|---|
Active |
string |
|
Expired |
string |
|
Merged |
string |
|
None |
string |
|
PaymentInstrumentError |
string |
|
Pending |
string |
|
Processing |
string |
|
PurchaseError |
string |
|
Split |
string |
|
Succeeded |
string |
ReservationSummary
The roll up count summary of reservations in each state
Name | Type | Description |
---|---|---|
cancelledCount |
number |
The number of reservation in Cancelled state |
expiredCount |
number |
The number of reservation in Expired state |
expiringCount |
number |
The number of reservation in Expiring state |
failedCount |
number |
The number of reservation in Failed state |
noBenefitCount |
number |
The number of reservation in NoBenefit state |
pendingCount |
number |
The number of reservation in Pending state |
processingCount |
number |
The number of reservation in Processing state |
succeededCount |
number |
The number of reservation in Succeeded state |
warningCount |
number |
The number of reservation in Warning state |
ReservationSwapProperties
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} |
ReservationTerm
Represent the term of reservation.
Name | Type | Description |
---|---|---|
P1Y |
string |
|
P3Y |
string |
|
P5Y |
string |
ReservationUtilizationAggregates
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 |
ReservedResourceProperties
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. |
ReservedResourceType
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 |
SkuName
The name of sku
Name | Type | Description |
---|---|---|
name |
string |
systemData
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. |
Utilization
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 |