benefit_utilization_summaries

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

Overview

Name	benefit_utilization_summaries
Type	Resource
Id	azure.cost_management.benefit_utilization_summaries

Fields

The following fields are returned by SELECT queries:

list_by_billing_profile_id

OK. The request has succeeded.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
kind	string	Supported values: 'SavingsPlan'.
systemData	object	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"

list_by_savings_plan_id

OK. The request has succeeded.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
kind	string	Supported values: 'SavingsPlan'.
systemData	object	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"

list_by_billing_account_id

OK. The request has succeeded.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
kind	string	Supported values: 'SavingsPlan'.
systemData	object	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"

list_by_savings_plan_order

OK. The request has succeeded.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
kind	string	Supported values: 'SavingsPlan'.
systemData	object	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"

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_by_billing_profile_id	select	billingAccountId, billingProfileId	grainParameter, filter	Lists savings plan utilization summaries for billing profile. Supported at grain values: 'Daily' and 'Monthly'.
list_by_savings_plan_id	select	savingsPlanOrderId, savingsPlanId	$filter, grainParameter	Lists the savings plan utilization summaries for daily or monthly grain.
list_by_billing_account_id	select	billingAccountId	grainParameter, filter	Lists savings plan utilization summaries for the enterprise agreement scope. Supported at grain values: 'Daily' and 'Monthly'.
list_by_savings_plan_order	select	savingsPlanOrderId	$filter, grainParameter	Lists the savings plan utilization summaries for daily or monthly grain.

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
billingAccountId	string	BillingAccount ID
billingProfileId	string	Billing profile ID.
savingsPlanId	string	Savings plan ID.
savingsPlanOrderId	string	Savings plan order ID.
$filter	string	Supports filtering by properties/usageDate.
filter	string	Supports filtering by properties/benefitId, properties/benefitOrderId and properties/usageDate.
grainParameter	string	Grain.

SELECT examples

list_by_billing_profile_id

Lists savings plan utilization summaries for billing profile. Supported at grain values: 'Daily' and 'Monthly'.

SELECT
id,
name,
kind,
systemData,
type
FROM azure.cost_management.benefit_utilization_summaries
WHERE billingAccountId = '{{ billingAccountId }}' -- required
AND billingProfileId = '{{ billingProfileId }}' -- required
AND grainParameter = '{{ grainParameter }}'
AND filter = '{{ filter }}'
;

list_by_savings_plan_id

Lists the savings plan utilization summaries for daily or monthly grain.

SELECT
id,
name,
kind,
systemData,
type
FROM azure.cost_management.benefit_utilization_summaries
WHERE savingsPlanOrderId = '{{ savingsPlanOrderId }}' -- required
AND savingsPlanId = '{{ savingsPlanId }}' -- required
AND $filter = '{{ $filter }}'
AND grainParameter = '{{ grainParameter }}'
;

list_by_billing_account_id

Lists savings plan utilization summaries for the enterprise agreement scope. Supported at grain values: 'Daily' and 'Monthly'.

SELECT
id,
name,
kind,
systemData,
type
FROM azure.cost_management.benefit_utilization_summaries
WHERE billingAccountId = '{{ billingAccountId }}' -- required
AND grainParameter = '{{ grainParameter }}'
AND filter = '{{ filter }}'
;

list_by_savings_plan_order

Lists the savings plan utilization summaries for daily or monthly grain.

SELECT
id,
name,
kind,
systemData,
type
FROM azure.cost_management.benefit_utilization_summaries
WHERE savingsPlanOrderId = '{{ savingsPlanOrderId }}' -- required
AND $filter = '{{ $filter }}'
AND grainParameter = '{{ grainParameter }}'
;