credits

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

Overview

Name	credits
Type	Resource
Id	azure.consumption.credits

Fields

The following fields are returned by SELECT queries:

get

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.
balanceSummary	object	Summary of balances associated with this credit summary.
billingCurrency	string	The billing currency.
creditCurrency	string	The credit currency.
eTag	string	eTag of the resource. To handle concurrent update scenario, this field will be used to determine whether the user is updating the latest version or not.
expiredCredit	object	Expired credit.
isEstimatedBalance	boolean	If true, the listed details are based on an estimation and it will be subjected to change.
pendingCreditAdjustments	object	Pending credit adjustments.
pendingEligibleCharges	object	Pending eligible charges.
reseller	object	Credit's reseller.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	A list of Tag.
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
get	select	billing_account_id, billing_profile_id		The credit summary by billingAccountId and billingProfileId.

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	Azure Billing Profile ID. Required.

SELECT examples

get

The credit summary by billingAccountId and billingProfileId.

SELECT
id,
name,
balanceSummary,
billingCurrency,
creditCurrency,
eTag,
expiredCredit,
isEstimatedBalance,
pendingCreditAdjustments,
pendingEligibleCharges,
reseller,
systemData,
tags,
type
FROM azure.consumption.credits
WHERE billing_account_id = '{{ billing_account_id }}' -- required
AND billing_profile_id = '{{ billing_profile_id }}' -- required
;