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
OK. The request has succeeded.
| 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 |
location | string | Resource Location. |
properties | object | The properties of the reservation recommendation. (title: Reservation Recommendation details properties) |
sku | string | Resource sku |
type | string | The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | resourceScope, 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. |
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) |
region | string | Used to select the region the recommendation should be generated for. |
resourceScope | 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 |
scope | string | Scope of the reservation. |
term | string | Specify length of reservation recommendation term. |
$filter | string | Used to filter reservation recommendation details by: properties/subscriptionId can be specified for billing account and billing profile paths. |
SELECT examples
- get
Details of a reservation recommendation for what-if analysis of reserved instances.
SELECT
id,
name,
location,
properties,
sku,
type
FROM azure.consumption.reservation_recommendation_details
WHERE resourceScope = '{{ resourceScope }}' -- required
AND scope = '{{ scope }}' -- required
AND region = '{{ region }}' -- required
AND term = '{{ term }}' -- required
AND lookBackPeriod = '{{ lookBackPeriod }}' -- required
AND product = '{{ product }}' -- required
AND $filter = '{{ $filter }}'
;