reservation_recommendation_details

Creates, updates, deletes, gets or lists a reservation_recommendation_details resource.

Overview

Name	reservation_recommendation_details
Type	Resource
Id	azure.consumption.reservation_recommendation_details

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
currency	string	An ISO 4217 currency code identifier for the costs and savings.
etag	string	The etag for the resource.
location	string	Resource Location.
resource	object	Resource specific properties.
resourceGroup	string	Resource Group.
savings	object	Savings information for the recommendation.
scope	string	Scope of the reservation, ex: Single or Shared.
sku	string	Resource sku.
systemData	object	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".
usage	object	Historical usage details used to calculate the estimated savings.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_scope, scope, region, term, lookBackPeriod, product	$filter	Details of a reservation recommendation for what-if analysis of reserved instances.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
lookBackPeriod	string	Filter the time period on which reservation recommendation results are based. Known values are: "Last7Days", "Last30Days", and "Last60Days". Required.
product	string	Filter the products for which reservation recommendation results are generated. Examples: Standard_DS1_v2 (for VM), Premium_SSD_Managed_Disks_P30 (for Managed Disks). Required.
region	string	Used to select the region the recommendation should be generated for. Required.
resource_scope	string	The scope associated with reservation recommendation details operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resource group scope, /providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for BillingAccount scope, and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope. Required.
scope	string	Scope of the reservation. Known values are: "Single" and "Shared". Required.
term	string	Specify length of reservation recommendation term. Known values are: "P1M", "P1Y", and "P3Y". Required.
$filter	string	Used to filter reservation recommendation details by: properties/subscriptionId can be specified for billing account and billing profile paths. Default value is None.

SELECT examples

get

Details of a reservation recommendation for what-if analysis of reserved instances.

SELECT
id,
name,
currency,
etag,
location,
resource,
resourceGroup,
savings,
scope,
sku,
systemData,
tags,
type,
usage
FROM azure.consumption.reservation_recommendation_details
WHERE resource_scope = '{{ resource_scope }}' -- required
AND scope = '{{ scope }}' -- required
AND region = '{{ region }}' -- required
AND term = '{{ term }}' -- required
AND lookBackPeriod = '{{ lookBackPeriod }}' -- required
AND product = '{{ product }}' -- required
AND $filter = '{{ $filter }}'
;