events

Creates, updates, deletes, gets or lists an events resource.

Overview

Name	events
Type	Resource
Id	azure.consumption.events

Fields

The following fields are returned by SELECT queries:

list_by_billing_profile

OK. The request has succeeded.

Name	Datatype	Description
properties	object	The event properties. (title: Event summary properties)

list_by_billing_account

OK. The request has succeeded.

Name	Datatype	Description
properties	object	The event properties. (title: Event summary properties)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_by_billing_profile	select	billingAccountId, billingProfileId, startDate, endDate		Lists the events that decrements Azure credits or Microsoft Azure consumption commitment for a billing account or a billing profile for a given start and end date.
list_by_billing_account	select	billingAccountId	$filter	Lists the events that decrements Azure credits or Microsoft Azure consumption commitment for a billing account or a billing profile for a given start and end date.

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	Azure Billing Profile ID.
endDate	string	End date
startDate	string	Start date
$filter	string	May be used to filter the events by lotId, lotSource etc. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value is separated by a colon (:).

SELECT examples

list_by_billing_profile

Lists the events that decrements Azure credits or Microsoft Azure consumption commitment for a billing account or a billing profile for a given start and end date.

SELECT
properties
FROM azure.consumption.events
WHERE billingAccountId = '{{ billingAccountId }}' -- required
AND billingProfileId = '{{ billingProfileId }}' -- required
AND startDate = '{{ startDate }}' -- required
AND endDate = '{{ endDate }}' -- required
;

list_by_billing_account

Lists the events that decrements Azure credits or Microsoft Azure consumption commitment for a billing account or a billing profile for a given start and end date.

SELECT
properties
FROM azure.consumption.events
WHERE billingAccountId = '{{ billingAccountId }}' -- required
AND $filter = '{{ $filter }}'
;