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

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.
acceptanceMode	string	The mode of acceptance for an agreement. Known values are: "Other", "ClickToAccept", "ESignEmbedded", "ESignOffline", "Implicit", "Offline", and "PhysicalSign". (Other, ClickToAccept, ESignEmbedded, ESignOffline, Implicit, Offline, PhysicalSign)
agreementLink	string	The URL to download the agreement.
billingProfileInfo	array	The list of billing profiles associated with agreement and present only for specific agreements.
category	string	The category of the agreement. Known values are: "Other", "AffiliatePurchaseTerms", "IndirectForGovernmentAgreement", "MicrosoftCustomerAgreement", "MicrosoftPartnerAgreement", and "UKCloudComputeFramework". (Other, AffiliatePurchaseTerms, IndirectForGovernmentAgreement, MicrosoftCustomerAgreement, MicrosoftPartnerAgreement, UKCloudComputeFramework)
displayName	string	The name of the agreement signed by a customer.
effectiveDate	string (date-time)	The date from which the agreement is effective.
expirationDate	string (date-time)	The date when the agreement expires.
leadBillingAccountName	string	The ID of the lead billing account if this agreement is part of the Customer Affiliate Purchase Terms.
participants	array	The list of participants that participates in acceptance of an agreement.
status	string	The current status of the agreement.
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 < > % & \ ? /.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_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.
acceptanceMode	string	The mode of acceptance for an agreement. Known values are: "Other", "ClickToAccept", "ESignEmbedded", "ESignOffline", "Implicit", "Offline", and "PhysicalSign". (Other, ClickToAccept, ESignEmbedded, ESignOffline, Implicit, Offline, PhysicalSign)
agreementLink	string	The URL to download the agreement.
billingProfileInfo	array	The list of billing profiles associated with agreement and present only for specific agreements.
category	string	The category of the agreement. Known values are: "Other", "AffiliatePurchaseTerms", "IndirectForGovernmentAgreement", "MicrosoftCustomerAgreement", "MicrosoftPartnerAgreement", and "UKCloudComputeFramework". (Other, AffiliatePurchaseTerms, IndirectForGovernmentAgreement, MicrosoftCustomerAgreement, MicrosoftPartnerAgreement, UKCloudComputeFramework)
displayName	string	The name of the agreement signed by a customer.
effectiveDate	string (date-time)	The date from which the agreement is effective.
expirationDate	string (date-time)	The date when the agreement expires.
leadBillingAccountName	string	The ID of the lead billing account if this agreement is part of the Customer Affiliate Purchase Terms.
participants	array	The list of participants that participates in acceptance of an agreement.
status	string	The current status of the agreement.
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 < > % & \ ? /.
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_name, agreement_name		Gets an agreement by ID.
list_by_billing_account	select	billing_account_name	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
agreement_name	string	The ID that uniquely identifies an agreement. Required.
billing_account_name	string	The ID that uniquely identifies a billing account. Required.
expand	string	May be used to expand the participants. Default value is None.

SELECT examples

get

Gets an agreement by ID.

SELECT
id,
name,
acceptanceMode,
agreementLink,
billingProfileInfo,
category,
displayName,
effectiveDate,
expirationDate,
leadBillingAccountName,
participants,
status,
systemData,
tags,
type
FROM azure.billing.agreements
WHERE billing_account_name = '{{ billing_account_name }}' -- required
AND agreement_name = '{{ agreement_name }}' -- required
;

list_by_billing_account

Lists the agreements for a billing account.

SELECT
id,
name,
acceptanceMode,
agreementLink,
billingProfileInfo,
category,
displayName,
effectiveDate,
expirationDate,
leadBillingAccountName,
participants,
status,
systemData,
tags,
type
FROM azure.billing.agreements
WHERE billing_account_name = '{{ billing_account_name }}' -- required
AND expand = '{{ expand }}'
;