agreements

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

Overview

Name	agreements
Type	Resource
Id	azure.billing.agreements

Fields

The following fields are returned by SELECT queries:

get

A billing account.

Name	Datatype	Description
properties	object	An agreement.
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 < > % & \ ? /

list_by_billing_account

Result of listing agreements.

Name	Datatype	Description
properties	object	An agreement.
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 < > % & \ ? /

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	billingAccountName, agreementName		Gets an agreement by ID.
list_by_billing_account	select	billingAccountName	expand	Lists the agreements for a billing account.

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
agreementName	string	The ID that uniquely identifies an agreement.
billingAccountName	string	The ID that uniquely identifies a billing account.
expand	string	May be used to expand the participants.

SELECT examples

get

Gets an agreement by ID.

SELECT
properties,
tags
FROM azure.billing.agreements
WHERE billingAccountName = '{{ billingAccountName }}' -- required
AND agreementName = '{{ agreementName }}' -- required
;

list_by_billing_account

Lists the agreements for a billing account.

SELECT
properties,
tags
FROM azure.billing.agreements
WHERE billingAccountName = '{{ billingAccountName }}' -- required
AND expand = '{{ expand }}'
;