available_balances

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

Overview

Name	available_balances
Type	Resource
Id	azure.billing.available_balances

Fields

The following fields are returned by SELECT queries:

get_by_billing_profile

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.
amount	object	Credit amount for immediate payment.
paymentsOnAccount	array	The list of payments on accounts.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? /.
totalPaymentsOnAccount	object	Total amount of payments on accounts.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

get_by_billing_account

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.
amount	object	Credit amount for immediate payment.
paymentsOnAccount	array	The list of payments on accounts.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? /.
totalPaymentsOnAccount	object	Total amount of payments on accounts.
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_by_billing_profile	select	billing_account_name, billing_profile_name		The Available Credit or Payment on Account Balance for a billing profile. The credit balance can be used to settle due or past due invoices and is supported for billing accounts with agreement type Microsoft Customer Agreement. The payment on account balance is supported for billing accounts with agreement type Microsoft Customer Agreement.
get_by_billing_account	select	billing_account_name		The Available Credit or Payment on Account Balance for a billing account. The credit balance can be used to settle due or past due invoices and is supported for billing accounts with agreement type Microsoft Customer Agreement. The payment on account balance is supported for billing accounts with agreement type Microsoft Customer Agreement or Microsoft Online Services Program.

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_name	string	The ID that uniquely identifies a billing account. Required.
billing_profile_name	string	The ID that uniquely identifies a billing profile. Required.

SELECT examples

get_by_billing_profile

The Available Credit or Payment on Account Balance for a billing profile. The credit balance can be used to settle due or past due invoices and is supported for billing accounts with agreement type Microsoft Customer Agreement. The payment on account balance is supported for billing accounts with agreement type Microsoft Customer Agreement.

SELECT
id,
name,
amount,
paymentsOnAccount,
systemData,
tags,
totalPaymentsOnAccount,
type
FROM azure.billing.available_balances
WHERE billing_account_name = '{{ billing_account_name }}' -- required
AND billing_profile_name = '{{ billing_profile_name }}' -- required
;

get_by_billing_account

The Available Credit or Payment on Account Balance for a billing account. The credit balance can be used to settle due or past due invoices and is supported for billing accounts with agreement type Microsoft Customer Agreement. The payment on account balance is supported for billing accounts with agreement type Microsoft Customer Agreement or Microsoft Online Services Program.

SELECT
id,
name,
amount,
paymentsOnAccount,
systemData,
tags,
totalPaymentsOnAccount,
type
FROM azure.billing.available_balances
WHERE billing_account_name = '{{ billing_account_name }}' -- required
;