Reservation Recommendations - List

Service:: Consumption

API Version:: 2024-08-01

List of recommendations for purchasing reserved instances.

GET https://management.azure.com/{resourceScope}/providers/Microsoft.Consumption/reservationRecommendations?api-version=2024-08-01

With optional parameters:

GET https://management.azure.com/{resourceScope}/providers/Microsoft.Consumption/reservationRecommendations?api-version=2024-08-01&$filter={$filter}

URI Parameters

Name	In	Required	Type	Description
resourceScope	path	True	string	The fully qualified Azure Resource manager identifier of the resource.
api-version	query	True	string minLength: 1	The API version to use for this operation.
$filter	query		string	May be used to filter reservationRecommendations by: properties/scope with allowed values ['Single', 'Shared'] and default value 'Single'; properties/resourceType with allowed values ['VirtualMachines', 'SQLDatabases', 'PostgreSQL', 'ManagedDisk', 'MySQL', 'RedHat', 'MariaDB', 'RedisCache', 'CosmosDB', 'SqlDataWarehouse', 'SUSELinux', 'AppService', 'BlockBlob', 'AzureDataExplorer', 'VMwareCloudSimple'] and default value 'VirtualMachines'; and properties/lookBackPeriod with allowed values ['Last7Days', 'Last30Days', 'Last60Days'] and default value 'Last7Days'.

Responses

Name	Type	Description
200 OK	ReservationRecommendationsListResult	The request has succeeded.
204 No Content		Operation completed successfully.
Other Status Codes	ErrorResponse	An unexpected error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

ReservationRecommendationsByBillingAccount-Legacy

ReservationRecommendationsByBillingAccountFilterForScope

ReservationRecommendationsByBillingProfile-Modern

ReservationRecommendationsByResourceGroup-Legacy

ReservationRecommendationsBySubscription-Legacy

ReservationRecommendationsFilterBySubscriptionForScopeLookBackPeriod-Legacy

ReservationRecommendationsByBillingAccount-Legacy

Sample request

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.Consumption/reservationRecommendations?api-version=2024-08-01

Sample response

Status code:: 200

{
  "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/reservationRecommendations?api-version=2024-08-01&$skiptoken=AQAAAA%3D%3D&",
  "value": [
    {
      "name": "00000000-0000-0000-0000-000000000000",
      "type": "Microsoft.Consumption/reservationRecommendations",
      "id": "billingAccount/123456/providers/Microsoft.Consumption/reservationRecommendations/00000000-0000-0000-0000-000000000000",
      "kind": "legacy",
      "location": "westus",
      "properties": {
        "costWithNoReservedInstances": 12.0785105,
        "firstUsageDate": "2019-07-07T00:00:00-07:00",
        "instanceFlexibilityGroup": "DSv2 Series",
        "instanceFlexibilityRatio": 1,
        "lastUsageDate": "2019-08-07T00:00:00-07:00",
        "lookBackPeriod": "Last7Days",
        "meterId": "00000000-0000-0000-0000-000000000000",
        "netSavings": 0.588546019225182,
        "normalizedSize": "Standard_DS1_v2",
        "recommendedQuantity": 1,
        "recommendedQuantityNormalized": 1,
        "scope": "Shared",
        "skuProperties": [
          {
            "name": "Cores",
            "value": "1"
          },
          {
            "name": "Ram",
            "value": "1"
          }
        ],
        "term": "P1Y",
        "totalCostWithReservedInstances": 11.4899644807748,
        "totalHours": 701
      },
      "sku": "Standard_DS1_v2"
    },
    {
      "name": "00000000-0000-0000-0000-000000000000",
      "type": "Microsoft.Consumption/reservationRecommendations",
      "id": "billingAccount/123456/providers/Microsoft.Consumption/reservationRecommendations/00000000-0000-0000-0000-000000000000",
      "kind": "legacy",
      "location": "westus",
      "properties": {
        "costWithNoReservedInstances": 10.0785105,
        "firstUsageDate": "2019-07-07T00:00:00-07:00",
        "instanceFlexibilityGroup": "DSv2 Series",
        "instanceFlexibilityRatio": 1,
        "lastUsageDate": "2019-08-09T00:00:00-07:00",
        "lookBackPeriod": "Last7Days",
        "meterId": "00000000-0000-0000-0000-000000000000",
        "netSavings": 0.68,
        "normalizedSize": "Standard_DS1",
        "recommendedQuantity": 1,
        "recommendedQuantityNormalized": 1.2,
        "scope": "Shared",
        "skuProperties": [
          {
            "name": "SkuDisplayName",
            "value": "B"
          },
          {
            "name": "CPU",
            "value": "1"
          }
        ],
        "term": "P1Y",
        "totalCostWithReservedInstances": 13.48,
        "totalHours": 805
      },
      "sku": "Standard_DS1_v2"
    }
  ]
}

Status code:: 204

ReservationRecommendationsByBillingAccountFilterForScope

Sample request

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.Consumption/reservationRecommendations?api-version=2024-08-01&$filter=properties/scope eq 'Single'

Sample response

Status code:: 200

{
  "value": [
    {
      "name": "71fd91a7-13b9-4ade-bb11-85cfd6422d9d",
      "type": "Microsoft.Consumption/reservationRecommendations",
      "id": "billingAccount/123456/providers/Microsoft.Consumption/reservationRecommendations/71fd91a7-13b9-4ade-bb11-85cfd6422d9d",
      "kind": "legacy",
      "location": "westus3",
      "properties": {
        "costWithNoReservedInstances": 0.332,
        "firstUsageDate": "2024-04-30T07:00:00Z",
        "instanceFlexibilityGroup": "BS Series High Memory",
        "instanceFlexibilityRatio": 8,
        "lookBackPeriod": "Last7Days",
        "meterId": "9a3781ce-d0dc-5f76-99d7-29eb5aec447f",
        "netSavings": 0.13725114155251145,
        "normalizedSize": "Standard_B1ms",
        "recommendedQuantity": 1,
        "recommendedQuantityNormalized": 8,
        "resourceType": "virtualmachines",
        "scope": "Single",
        "skuProperties": [],
        "subscriptionId": "00000000-0000-0000-0000-000000000000",
        "term": "P1Y",
        "totalCostWithReservedInstances": 0.19474885844748857
      },
      "sku": "Standard_B4ms"
    },
    {
      "name": "904b99c2-baf3-4bff-98ff-a96238ccbc96",
      "type": "Microsoft.Consumption/reservationRecommendations",
      "id": "billingAccount/123456/providers/Microsoft.Consumption/reservationRecommendations/904b99c2-baf3-4bff-98ff-a96238ccbc96",
      "kind": "legacy",
      "location": "westus3",
      "properties": {
        "costWithNoReservedInstances": 0.332,
        "firstUsageDate": "2024-04-30T07:00:00Z",
        "instanceFlexibilityGroup": "BS Series High Memory",
        "instanceFlexibilityRatio": 8,
        "lookBackPeriod": "Last7Days",
        "meterId": "9a3781ce-d0dc-5f76-99d7-29eb5aec447f",
        "netSavings": 0.20688584474885846,
        "normalizedSize": "Standard_B1ms",
        "recommendedQuantity": 1,
        "recommendedQuantityNormalized": 8,
        "resourceType": "virtualmachines",
        "scope": "Single",
        "skuProperties": [],
        "subscriptionId": "00000000-0000-0000-0000-000000000000",
        "term": "P3Y",
        "totalCostWithReservedInstances": 0.12511415525114156
      },
      "sku": "Standard_B4ms"
    }
  ]
}

Status code:: 204

ReservationRecommendationsByBillingProfile-Modern

Sample request

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/123456/billingProfiles/6420/providers/Microsoft.Consumption/reservationRecommendations?api-version=2024-08-01

Sample response

Status code:: 200

{
  "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/reservationRecommendations?api-version=2024-08-01&$skiptoken=AQAAAA%3D%3D&",
  "value": [
    {
      "name": "00000000-0000-0000-0000-000000000000",
      "type": "Microsoft.Consumption/reservationRecommendations",
      "id": "/providers/Microsoft.Billing/billingAccounts/123456/billingProfiles/6420/providers/Microsoft.Consumption/reservationRecommendations/00000000-0000-0000-0000-000000000000",
      "kind": "modern",
      "properties": {
        "costWithNoReservedInstances": {
          "currency": "USD",
          "value": 279881.9457795231
        },
        "firstUsageDate": "2022-08-22T00:00:00Z",
        "instanceFlexibilityGroup": "NA",
        "instanceFlexibilityRatio": 1,
        "lastUsageDate": "2022-09-22T00:00:00Z",
        "location": "westus2",
        "lookBackPeriod": 60,
        "meterId": "30f7049a-b092-42f4-9173-9ec31ab945ad",
        "netSavings": {
          "currency": "USD",
          "value": 153766.87728637524
        },
        "normalizedSize": "SQLDB_BC_Compute_Gen5",
        "recommendedQuantity": 35,
        "recommendedQuantityNormalized": 35,
        "resourceType": "sqldatabases",
        "scope": "Single",
        "skuName": "SQLDB_BC_Compute_Gen5",
        "skuProperties": null,
        "subscriptionId": "c6aa8a01-a744-44a7-a4f1-caad17512f27",
        "term": "P3Y",
        "totalCostWithReservedInstances": {
          "currency": "USD",
          "value": 126115.06849314792
        },
        "totalHours": 717
      }
    },
    {
      "name": "00000000-0000-0000-0000-000000000000",
      "type": "Microsoft.Consumption/reservationRecommendations",
      "id": "/providers/Microsoft.Billing/billingAccounts/123456/billingProfiles/6420/providers/Microsoft.Consumption/reservationRecommendations/00000000-0000-0000-0000-000000000000",
      "kind": "modern",
      "properties": {
        "costWithNoReservedInstances": {
          "currency": "USD",
          "value": 93208.8596802244
        },
        "firstUsageDate": "2022-08-22T00:00:00Z",
        "instanceFlexibilityGroup": "NA",
        "instanceFlexibilityRatio": 1,
        "lastUsageDate": "2022-08-27T00:00:00Z",
        "location": "westus2",
        "lookBackPeriod": 60,
        "meterId": "30f7049a-b092-42f4-9173-9ec31ab945ad",
        "netSavings": {
          "currency": "USD",
          "value": 32553.85968022456
        },
        "normalizedSize": "SQLDB_BC_Compute_Gen5",
        "recommendedQuantity": 35,
        "recommendedQuantityNormalized": 35,
        "resourceType": "sqldatabases",
        "scope": "Single",
        "skuName": "SQLDB_BC_Compute_Gen5",
        "skuProperties": null,
        "subscriptionId": "c6aa8a01-a744-44a7-a4f1-caad17512f27",
        "term": "P1Y",
        "totalCostWithReservedInstances": {
          "currency": "USD",
          "value": 60654.99999999984
        },
        "totalHours": 527
      }
    }
  ]
}

Status code:: 204

ReservationRecommendationsByResourceGroup-Legacy

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testGroup/providers/Microsoft.Consumption/reservationRecommendations?api-version=2024-08-01

Sample response

Status code:: 200

{
  "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testGroup/providers/Microsoft.Consumption/reservationRecommendations?api-version=2024-08-01&$skiptoken=AQAAAA%3D%3D&",
  "value": [
    {
      "name": "reservationRecommendations1",
      "type": "Microsoft.Consumption/reservationRecommendations",
      "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGrouups/testGroup/providers/Microsoft.Consumption/reservationRecommendations/reservationRecommendations1",
      "kind": "legacy",
      "location": "northeurope",
      "properties": {
        "costWithNoReservedInstances": 0,
        "firstUsageDate": "2018-03-06T00:00:00Z",
        "lastUsageDate": "2018-03-08T00:00:00Z",
        "lookBackPeriod": "Last7Days",
        "meterId": "00000000-0000-0000-0000-000000000000",
        "netSavings": 4.634521202630137,
        "recommendedQuantity": 1,
        "scope": "Single",
        "subscriptionId": "00000000-0000-0000-0000-000000000000",
        "term": "P1Y",
        "totalCostWithReservedInstances": 0,
        "totalHours": 427
      },
      "sku": "Standard_DS1_v2"
    },
    {
      "name": "reservationRecommendations2",
      "type": "Microsoft.Consumption/reservationRecommendations",
      "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testGroup/providers/Microsoft.Consumption/reservationRecommendations/reservationRecommendations2",
      "kind": "legacy",
      "location": "northeurope",
      "properties": {
        "costWithNoReservedInstances": 0,
        "firstUsageDate": "2018-03-06T00:00:00Z",
        "lastUsageDate": "2018-03-09T00:00:00Z",
        "lookBackPeriod": "Last7Days",
        "meterId": "00000000-0000-0000-0000-000000000000",
        "netSavings": 7.289315723178081,
        "recommendedQuantity": 1,
        "scope": "Single",
        "subscriptionId": "00000000-0000-0000-0000-000000000000",
        "term": "P3Y",
        "totalCostWithReservedInstances": 0,
        "totalHours": 327
      },
      "sku": "Standard_DS1_v2"
    }
  ]
}

Status code:: 204

ReservationRecommendationsBySubscription-Legacy

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/reservationRecommendations?api-version=2024-08-01

Sample response

Status code:: 200

{
  "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/reservationRecommendations?api-version=2024-08-01&$skiptoken=AQAAAA%3D%3D&",
  "value": [
    {
      "name": "reservationRecommendations1",
      "type": "Microsoft.Consumption/reservationRecommendations",
      "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/reservationRecommendations/reservationRecommendations1",
      "kind": "legacy",
      "location": "northeurope",
      "properties": {
        "costWithNoReservedInstances": 0,
        "firstUsageDate": "2018-03-06T00:00:00Z",
        "lastUsageDate": "2018-03-10T00:00:00Z",
        "lookBackPeriod": "Last7Days",
        "meterId": "00000000-0000-0000-0000-000000000000",
        "netSavings": 4.634521202630137,
        "recommendedQuantity": 1,
        "scope": "Single",
        "subscriptionId": "00000000-0000-0000-0000-000000000000",
        "term": "P1Y",
        "totalCostWithReservedInstances": 0,
        "totalHours": 827
      },
      "sku": "Standard_DS1_v2"
    },
    {
      "name": "reservationRecommendations2",
      "type": "Microsoft.Consumption/reservationRecommendations",
      "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/reservationRecommendations/reservationRecommendations2",
      "kind": "legacy",
      "location": "northeurope",
      "properties": {
        "costWithNoReservedInstances": 0,
        "firstUsageDate": "2018-03-06T00:00:00Z",
        "lastUsageDate": "2018-03-15T00:00:00Z",
        "lookBackPeriod": "Last7Days",
        "meterId": "00000000-0000-0000-0000-000000000000",
        "netSavings": 7.289315723178081,
        "recommendedQuantity": 1,
        "scope": "Single",
        "subscriptionId": "00000000-0000-0000-0000-000000000000",
        "term": "P3Y",
        "totalCostWithReservedInstances": 0,
        "totalHours": 927
      },
      "sku": "Standard_DS1_v2"
    }
  ]
}

Status code:: 204

ReservationRecommendationsFilterBySubscriptionForScopeLookBackPeriod-Legacy

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/reservationRecommendations?api-version=2024-08-01&$filter=properties/scope eq 'Single' AND properties/lookBackPeriod eq 'Last7Days'

Sample response

Status code:: 200

{
  "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/reservationRecommendations?api-version=2024-08-01&$filter=properties/scope+eq+'Single'+AND+properties/lookBackPeriod+eq+'Last7Days'&$skiptoken=AQAAAA%3D%3D&",
  "value": [
    {
      "name": "reservationRecommendations1",
      "type": "Microsoft.Consumption/reservationRecommendations",
      "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/reservationRecommendations/reservationRecommendations1",
      "kind": "legacy",
      "location": "northeurope",
      "properties": {
        "costWithNoReservedInstances": 0,
        "firstUsageDate": "2018-03-06T00:00:00Z",
        "lastUsageDate": "2018-03-15T00:00:00Z",
        "lookBackPeriod": "Last7Days",
        "meterId": "00000000-0000-0000-0000-000000000000",
        "netSavings": 4.634521202630137,
        "recommendedQuantity": 1,
        "scope": "Single",
        "skuProperties": [
          {
            "name": "Cores",
            "value": "1"
          },
          {
            "name": "Ram",
            "value": "1"
          }
        ],
        "subscriptionId": "00000000-0000-0000-0000-000000000000",
        "term": "P1Y",
        "totalCostWithReservedInstances": 0,
        "totalHours": 527
      },
      "sku": "Standard_DS1_v2"
    },
    {
      "name": "reservationRecommendations2",
      "type": "Microsoft.Consumption/reservationRecommendations",
      "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/reservationRecommendations/reservationRecommendations2",
      "kind": "legacy",
      "location": "northeurope",
      "properties": {
        "costWithNoReservedInstances": 0,
        "firstUsageDate": "2018-03-06T00:00:00Z",
        "lastUsageDate": "2018-03-08T00:00:00Z",
        "lookBackPeriod": "Last7Days",
        "meterId": "00000000-0000-0000-0000-000000000000",
        "netSavings": 7.289315723178081,
        "recommendedQuantity": 1,
        "scope": "Single",
        "skuProperties": [
          {
            "name": "SkuDisplayName",
            "value": "B"
          },
          {
            "name": "CPU",
            "value": "1"
          }
        ],
        "subscriptionId": "00000000-0000-0000-0000-000000000000",
        "term": "P3Y",
        "totalCostWithReservedInstances": 0,
        "totalHours": 427
      },
      "sku": "Standard_DS1_v2"
    }
  ]
}

Status code:: 204

Definitions

Name	Description
amount	The amount plus currency .
createdByType	The type of identity that created the resource.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
LegacyReservationRecommendation	Legacy reservation recommendation.
LegacySharedScopeReservationRecommendationProperties	The properties of the legacy reservation recommendation for shared scope.
LegacySingleScopeReservationRecommendationProperties	The properties of the legacy reservation recommendation for single scope.
ModernReservationRecommendation	Modern reservation recommendation.
ModernSharedScopeReservationRecommendationProperties	The properties of the modern reservation recommendation for shared scope.
ModernSingleScopeReservationRecommendationProperties	The properties of the modern reservation recommendation for single scope.
ReservationRecommendationKind	Specifies the kind of reservation recommendation.
ReservationRecommendationsListResult	Result of listing reservation recommendations.
SkuProperty	The Sku property
systemData	Metadata pertaining to creation and last modification of the resource.

amount

Object

The amount plus currency .

Name	Type	Description
currency	string	Amount currency.
value	number (decimal)	Amount.

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

LegacyReservationRecommendation

Object

Legacy reservation recommendation.

Name	Type	Description
etag	string	The etag for the resource.
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind	string: legacy	Specifies the kind of reservation recommendation.
location	string	Resource location
name	string	The name of the resource
properties	LegacyReservationRecommendationProperties: LegacySharedScopeReservationRecommendationProperties LegacySingleScopeReservationRecommendationProperties	Properties for legacy reservation recommendation
sku	string	Resource sku
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

LegacySharedScopeReservationRecommendationProperties

Object

The properties of the legacy reservation recommendation for shared scope.

Name	Type	Description
costWithNoReservedInstances	number (decimal)	The total amount of cost without reserved instances.
firstUsageDate	string (date-time)	The usage date for looking back.
instanceFlexibilityGroup	string	The instance Flexibility Group.
instanceFlexibilityRatio	number (float)	The instance Flexibility Ratio.
lastUsageDate	string (date-time)	The last usage date used for looking back for computing the recommendation.
lookBackPeriod	string	The number of days of usage to look back for recommendation.
meterId	string (uuid)	The meter id (GUID)
netSavings	number (decimal)	Total estimated savings with reserved instances.
normalizedSize	string	The normalized Size.
recommendedQuantity	number (decimal)	Recommended quality for reserved instances.
recommendedQuantityNormalized	number (float)	The recommended Quantity Normalized.
resourceType	string	The azure resource type.
scope	string: Shared	Shared or single recommendation.
skuProperties	SkuProperty[]	List of sku properties
term	string	Term period of the reservation. ex: P1M, P1Y or P3Y.
totalCostWithReservedInstances	number (decimal)	The total amount of cost with reserved instances.
totalHours	integer (int32)	The total hours for which the cost is covered.

LegacySingleScopeReservationRecommendationProperties

Object

The properties of the legacy reservation recommendation for single scope.

Name	Type	Description
costWithNoReservedInstances	number (decimal)	The total amount of cost without reserved instances.
firstUsageDate	string (date-time)	The usage date for looking back.
instanceFlexibilityGroup	string	The instance Flexibility Group.
instanceFlexibilityRatio	number (float)	The instance Flexibility Ratio.
lastUsageDate	string (date-time)	The last usage date used for looking back for computing the recommendation.
lookBackPeriod	string	The number of days of usage to look back for recommendation.
meterId	string (uuid)	The meter id (GUID)
netSavings	number (decimal)	Total estimated savings with reserved instances.
normalizedSize	string	The normalized Size.
recommendedQuantity	number (decimal)	Recommended quality for reserved instances.
recommendedQuantityNormalized	number (float)	The recommended Quantity Normalized.
resourceType	string	The azure resource type.
scope	string: Single	Shared or single recommendation.
skuProperties	SkuProperty[]	List of sku properties
subscriptionId	string (uuid)	Subscription id associated with single scoped recommendation.
term	string	Term period of the reservation. ex: P1M, P1Y or P3Y.
totalCostWithReservedInstances	number (decimal)	The total amount of cost with reserved instances.
totalHours	integer (int32)	The total hours for which the cost is covered.

ModernReservationRecommendation

Object

Modern reservation recommendation.

Name	Type	Description
etag	string	The etag for the resource.
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind	string: modern	Specifies the kind of reservation recommendation.
location	string	Resource location
name	string	The name of the resource
properties	ModernReservationRecommendationProperties: ModernSharedScopeReservationRecommendationProperties ModernSingleScopeReservationRecommendationProperties	Properties for modern reservation recommendation
sku	string	Resource sku
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

ModernSharedScopeReservationRecommendationProperties

Object

The properties of the modern reservation recommendation for shared scope.

Name	Type	Description
costWithNoReservedInstances	amount	The total amount of cost without reserved instances.
firstUsageDate	string (date-time)	The usage date for looking back.
instanceFlexibilityGroup	string	The instance Flexibility Group.
instanceFlexibilityRatio	number (float)	The instance Flexibility Ratio.
lastUsageDate	string (date-time)	The last usage date used for looking back for computing the recommendation.
location	string	Resource Location.
lookBackPeriod	integer (int32)	The number of days of usage to look back for recommendation.
meterId	string (uuid)	The meter id (GUID)
netSavings	amount	Total estimated savings with reserved instances.
normalizedSize	string	The normalized Size.
recommendedQuantity	number (decimal)	Recommended quality for reserved instances.
recommendedQuantityNormalized	number (float)	The recommended Quantity Normalized.
resourceType	string	Resource type.
scope	string: Shared	Shared or single recommendation.
skuName	string	This is the ARM Sku name.
skuProperties	SkuProperty[]	List of sku properties
term	string	Term period of the reservation. ex: P1M, P1Y or P3Y.
totalCostWithReservedInstances	amount	The total amount of cost with reserved instances.
totalHours	integer (int32)	The total hours for which the cost is covered.

ModernSingleScopeReservationRecommendationProperties

Object

The properties of the modern reservation recommendation for single scope.

Name	Type	Description
costWithNoReservedInstances	amount	The total amount of cost without reserved instances.
firstUsageDate	string (date-time)	The usage date for looking back.
instanceFlexibilityGroup	string	The instance Flexibility Group.
instanceFlexibilityRatio	number (float)	The instance Flexibility Ratio.
lastUsageDate	string (date-time)	The last usage date used for looking back for computing the recommendation.
location	string	Resource Location.
lookBackPeriod	integer (int32)	The number of days of usage to look back for recommendation.
meterId	string (uuid)	The meter id (GUID)
netSavings	amount	Total estimated savings with reserved instances.
normalizedSize	string	The normalized Size.
recommendedQuantity	number (decimal)	Recommended quality for reserved instances.
recommendedQuantityNormalized	number (float)	The recommended Quantity Normalized.
resourceType	string	Resource type.
scope	string: Single	Shared or single recommendation.
skuName	string	This is the ARM Sku name.
skuProperties	SkuProperty[]	List of sku properties
subscriptionId	string (uuid)	Subscription ID associated with single scoped recommendation.
term	string	Term period of the reservation. ex: P1M, P1Y or P3Y.
totalCostWithReservedInstances	amount	The total amount of cost with reserved instances.
totalHours	integer (int32)	The total hours for which the cost is covered.

ReservationRecommendationKind

Enumeration

Specifies the kind of reservation recommendation.

Value	Description
legacy
modern