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

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.
kind	string	Supported values: 'SavingsPlan'. Required. Known values are: "IncludedQuantity", "Reservation", and "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

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.
kind	string	Supported values: 'SavingsPlan'. Required. Known values are: "IncludedQuantity", "Reservation", and "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

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.
kind	string	Supported values: 'SavingsPlan'. Required. Known values are: "IncludedQuantity", "Reservation", and "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

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.
kind	string	Supported values: 'SavingsPlan'. Required. Known values are: "IncludedQuantity", "Reservation", and "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	billing_account_id, billing_profile_id	grainParameter, filter	Lists savings plan utilization summaries for billing profile. Supported at grain values: 'Daily' and 'Monthly'.
list_by_savings_plan_id	select	savings_plan_order_id, savings_plan_id	$filter, grainParameter	Lists the savings plan utilization summaries for daily or monthly grain.
list_by_billing_account_id	select	billing_account_id	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	savings_plan_order_id	$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
billing_account_id	string	BillingAccount ID. Required.
billing_profile_id	string	Billing Profile ID. Required.
savings_plan_id	string	Savings plan ID. Required.
savings_plan_order_id	string	Savings plan order ID. Required.
$filter	string	Supports filtering by properties/usageDate. Default value is None.
filter	string	Supports filtering by properties/benefitId, properties/benefitOrderId and properties/usageDate. Default value is None.
grainParameter	string	Grain. Known values are: "Hourly", "Daily", and "Monthly". Default value is None.

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 billing_account_id = '{{ billing_account_id }}' -- required
AND billing_profile_id = '{{ billing_profile_id }}' -- 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 savings_plan_order_id = '{{ savings_plan_order_id }}' -- required
AND savings_plan_id = '{{ savings_plan_id }}' -- 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 billing_account_id = '{{ billing_account_id }}' -- 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 savings_plan_order_id = '{{ savings_plan_order_id }}' -- required
AND $filter = '{{ $filter }}'
AND grainParameter = '{{ grainParameter }}'
;