benefit_utilization_summaries_reports

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

Overview

Name	benefit_utilization_summaries_reports
Type	Resource
Id	azure.cost_management.benefit_utilization_summaries_reports

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	billingAccountId, startDate, endDate, grain		Triggers generation of a benefit utilization summaries report for the provided billing account. This API supports only enrollment accounts.
generate_by_billing_profile	exec	billingAccountId, billingProfileId, startDate, endDate, grain		Triggers generation of a benefit utilization summaries report for the provided billing account and billing profile.
generate_by_reservation_order_id	exec	reservationOrderId, startDate, endDate, grain		Triggers generation of a benefit utilization summaries report for the provided reservation order.
generate_by_reservation_id	exec	reservationOrderId, reservationId, startDate, endDate, grain		Triggers generation of a benefit utilization summaries report for the provided reservation.
generate_by_savings_plan_order_id	exec	savingsPlanOrderId, startDate, endDate, grain		Triggers generation of a benefit utilization summaries report for the provided savings plan order.
generate_by_savings_plan_id	exec	savingsPlanOrderId, savingsPlanId, startDate, endDate, grain		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
billingAccountId	string	BillingAccount ID
billingProfileId	string	Billing profile ID.
reservationId	string	Reservation ID
reservationOrderId	string	Reservation Order ID
savingsPlanId	string	Savings plan ID.
savingsPlanOrderId	string	Savings plan order ID.

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.benefit_utilization_summaries_reports.generate_by_billing_account 
@billingAccountId='{{ billingAccountId }}' --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.benefit_utilization_summaries_reports.generate_by_billing_profile 
@billingAccountId='{{ billingAccountId }}' --required, 
@billingProfileId='{{ billingProfileId }}' --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.benefit_utilization_summaries_reports.generate_by_reservation_order_id 
@reservationOrderId='{{ reservationOrderId }}' --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.benefit_utilization_summaries_reports.generate_by_reservation_id 
@reservationOrderId='{{ reservationOrderId }}' --required, 
@reservationId='{{ reservationId }}' --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.benefit_utilization_summaries_reports.generate_by_savings_plan_order_id 
@savingsPlanOrderId='{{ savingsPlanOrderId }}' --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.benefit_utilization_summaries_reports.generate_by_savings_plan_id 
@savingsPlanOrderId='{{ savingsPlanOrderId }}' --required, 
@savingsPlanId='{{ savingsPlanId }}' --required 
@@json=
'{
"billingAccountId": "{{ billingAccountId }}", 
"billingProfileId": "{{ billingProfileId }}", 
"benefitOrderId": "{{ benefitOrderId }}", 
"benefitId": "{{ benefitId }}", 
"grain": "{{ grain }}", 
"startDate": "{{ startDate }}", 
"endDate": "{{ endDate }}", 
"kind": "{{ kind }}"
}'
;