benefit_recommendations

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

Overview

Name	benefit_recommendations
Type	Resource
Id	azure.cost_management.benefit_recommendations

Fields

The following fields are returned by SELECT queries:

list

OK. The request has succeeded.

Name	Datatype	Description
kind	string	Reservation or SavingsPlan.
properties	object	The properties of the benefit recommendations.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	billingScope	$filter, $orderby, $expand	List of recommendations for purchasing savings plan.

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
billingScope	string	The scope associated with benefit recommendation operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resource group scope, /providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for enterprise agreement scope, and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billing profile scope
$expand	string	May be used to expand the properties by: properties/usage, properties/allRecommendationDetails
$filter	string	Can be used to filter benefitRecommendations by: properties/scope with allowed values ['Single', 'Shared'] and default value 'Shared'; and properties/lookBackPeriod with allowed values ['Last7Days', 'Last30Days', 'Last60Days'] and default value 'Last60Days'; properties/term with allowed values ['P1Y', 'P3Y'] and default value 'P3Y'; properties/subscriptionId; properties/resourceGroup
$orderby	string	May be used to order the recommendations by: properties/armSkuName. For the savings plan, the results are in order by default. There is no need to use this clause.

SELECT examples

list

List of recommendations for purchasing savings plan.

SELECT
kind,
properties
FROM azure.cost_management.benefit_recommendations
WHERE billingScope = '{{ billingScope }}' -- required
AND $filter = '{{ $filter }}'
AND $orderby = '{{ $orderby }}'
AND $expand = '{{ $expand }}'
;