generate_benefit_utilization_summaries_report

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

Overview

Name	generate_benefit_utilization_summaries_report
Type	Resource
Id	azure.cost_management.generate_benefit_utilization_summaries_report

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
generate_by_billing_account	exec	billing_account_id, grain, startDate, endDate		Triggers generation of a benefit utilization summaries report for the provided billing account. This API supports only enrollment accounts.
generate_by_billing_profile	exec	billing_account_id, billing_profile_id, grain, startDate, endDate		Triggers generation of a benefit utilization summaries report for the provided billing account and billing profile.
generate_by_reservation_order_id	exec	reservation_order_id, grain, startDate, endDate		Triggers generation of a benefit utilization summaries report for the provided reservation order.
generate_by_reservation_id	exec	reservation_order_id, reservation_id, grain, startDate, endDate		Triggers generation of a benefit utilization summaries report for the provided reservation.
generate_by_savings_plan_order_id	exec	savings_plan_order_id, grain, startDate, endDate		Triggers generation of a benefit utilization summaries report for the provided savings plan order.
generate_by_savings_plan_id	exec	savings_plan_order_id, savings_plan_id, grain, startDate, endDate		Triggers generation of a benefit utilization summaries report for the provided 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
billing_account_id	string	BillingAccount ID. Required.
billing_profile_id	string	Billing Profile ID. Required.
reservation_id	string	Reservation ID. Required.
reservation_order_id	string	Reservation Order ID. Required.
savings_plan_id	string	Savings plan ID. Required.
savings_plan_order_id	string	Savings plan order ID. Required.

Lifecycle Methods

generate_by_billing_account

Triggers generation of a benefit utilization summaries report for the provided billing account. This API supports only enrollment accounts.

EXEC azure.cost_management.generate_benefit_utilization_summaries_report.generate_by_billing_account 
@billing_account_id='{{ billing_account_id }}' --required 
@@json=
'{
"billingAccountId": "{{ billingAccountId }}", 
"billingProfileId": "{{ billingProfileId }}", 
"benefitOrderId": "{{ benefitOrderId }}", 
"benefitId": "{{ benefitId }}", 
"grain": "{{ grain }}", 
"startDate": "{{ startDate }}", 
"endDate": "{{ endDate }}", 
"kind": "{{ kind }}"
}'
;

generate_by_billing_profile

Triggers generation of a benefit utilization summaries report for the provided billing account and billing profile.

EXEC azure.cost_management.generate_benefit_utilization_summaries_report.generate_by_billing_profile 
@billing_account_id='{{ billing_account_id }}' --required, 
@billing_profile_id='{{ billing_profile_id }}' --required 
@@json=
'{
"billingAccountId": "{{ billingAccountId }}", 
"billingProfileId": "{{ billingProfileId }}", 
"benefitOrderId": "{{ benefitOrderId }}", 
"benefitId": "{{ benefitId }}", 
"grain": "{{ grain }}", 
"startDate": "{{ startDate }}", 
"endDate": "{{ endDate }}", 
"kind": "{{ kind }}"
}'
;

generate_by_reservation_order_id

Triggers generation of a benefit utilization summaries report for the provided reservation order.

EXEC azure.cost_management.generate_benefit_utilization_summaries_report.generate_by_reservation_order_id 
@reservation_order_id='{{ reservation_order_id }}' --required 
@@json=
'{
"billingAccountId": "{{ billingAccountId }}", 
"billingProfileId": "{{ billingProfileId }}", 
"benefitOrderId": "{{ benefitOrderId }}", 
"benefitId": "{{ benefitId }}", 
"grain": "{{ grain }}", 
"startDate": "{{ startDate }}", 
"endDate": "{{ endDate }}", 
"kind": "{{ kind }}"
}'
;

generate_by_reservation_id

Triggers generation of a benefit utilization summaries report for the provided reservation.

EXEC azure.cost_management.generate_benefit_utilization_summaries_report.generate_by_reservation_id 
@reservation_order_id='{{ reservation_order_id }}' --required, 
@reservation_id='{{ reservation_id }}' --required 
@@json=
'{
"billingAccountId": "{{ billingAccountId }}", 
"billingProfileId": "{{ billingProfileId }}", 
"benefitOrderId": "{{ benefitOrderId }}", 
"benefitId": "{{ benefitId }}", 
"grain": "{{ grain }}", 
"startDate": "{{ startDate }}", 
"endDate": "{{ endDate }}", 
"kind": "{{ kind }}"
}'
;

generate_by_savings_plan_order_id

Triggers generation of a benefit utilization summaries report for the provided savings plan order.

EXEC azure.cost_management.generate_benefit_utilization_summaries_report.generate_by_savings_plan_order_id 
@savings_plan_order_id='{{ savings_plan_order_id }}' --required 
@@json=
'{
"billingAccountId": "{{ billingAccountId }}", 
"billingProfileId": "{{ billingProfileId }}", 
"benefitOrderId": "{{ benefitOrderId }}", 
"benefitId": "{{ benefitId }}", 
"grain": "{{ grain }}", 
"startDate": "{{ startDate }}", 
"endDate": "{{ endDate }}", 
"kind": "{{ kind }}"
}'
;

generate_by_savings_plan_id

Triggers generation of a benefit utilization summaries report for the provided savings plan.

EXEC azure.cost_management.generate_benefit_utilization_summaries_report.generate_by_savings_plan_id 
@savings_plan_order_id='{{ savings_plan_order_id }}' --required, 
@savings_plan_id='{{ savings_plan_id }}' --required 
@@json=
'{
"billingAccountId": "{{ billingAccountId }}", 
"billingProfileId": "{{ billingProfileId }}", 
"benefitOrderId": "{{ benefitOrderId }}", 
"benefitId": "{{ benefitId }}", 
"grain": "{{ grain }}", 
"startDate": "{{ startDate }}", 
"endDate": "{{ endDate }}", 
"kind": "{{ kind }}"
}'
;