Skip to main content

applicable_maccs

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

Overview

Nameapplicable_maccs
TypeResource
Idazure.billing_benefits.applicable_maccs

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
idstringFully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
namestringThe name of the resource.
allowContributorsbooleanSetting this to true means multi-entity.
automaticShortfallstringSetting this to 'Enable' enables automatic shortfall charging when commitment is not met. Known values are: "Unknown", "Enabled", and "Disabled". (Unknown, Enabled, Disabled)
automaticShortfallSuppressReasonobjectOptional field to record suppression reason for automatic shortfall.
billingAccountResourceIdstringFully-qualified identifier of the billing account where the MACC is applied. Present only for Enterprise Agreement customers. Format must be Azure Resource ID: /providers/Microsoft.Billing/billingAccounts/{acctId:orgId}.
commitmentobjectCommitment towards the benefit.
displayNamestringDisplay name.
endAtstring (date-time)Must be end of month. Timestamp must be in the ISO date format YYYY-MM-DDT23:59:59Z.
entityTypestringRepresents type of the object being operated on. Possible values are primary or contributor. Required. Known values are: "Primary" and "Contributor". (Primary, Contributor)
milestonesarrayList of milestones associated with this MACC.
primaryBillingAccountResourceIdstringFully-qualified billing account resource identifier of the primary MACC. Format must be Azure Resource ID: /providers/Microsoft.Billing/billingAccounts/{acctId:orgId}.
primaryResourceIdstringFully-qualified resource identifier of the primary MACC. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/maccs/{maccName}.
productCodestringRepresents catalog UPN.
provisioningStatestringProvisioning state of MACC as assigned by RPaaS. This indicates the last operation's status. For all practical purposes, this can be ignored. For current status of MACC resource, refer to MaccStatus.
resourceIdstringThis is the resource identifier of either the primary MACC or the contributor. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/maccs/{maccName}.
shortfallobjectMACC shortfall.
startAtstring (date-time)Must be start of month. Timestamp must be in the ISO date format YYYY-MM-DDT00:00:00Z.
statusstringRepresents the current status of the MACC. Known values are: "Unknown", "Scheduled", "Active", "Pending", "Failed", "Canceled", "Completed", "Stopped", "PendingSettlement", "ShortfallCharged", and "ShortfallWaived". (Unknown, Scheduled, Active, Pending, Failed, Canceled, Completed, Stopped, PendingSettlement, ShortfallCharged, ShortfallWaived)
systemDataobjectAzure Resource Manager metadata containing createdBy and modifiedBy information.
systemIdstringThis is the globally unique identifier of the MACC which will not change for the lifetime of the MACC.
typestringThe type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
listselectbilling_account_idList maccs that are applicable for a given 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.

NameDatatypeDescription
billing_account_idstringThe billing account Id at which the benefits are listed. Accepted format is: {rootId:orgId}. Required.

SELECT examples

List maccs that are applicable for a given billing account.

SELECT
id,
name,
allowContributors,
automaticShortfall,
automaticShortfallSuppressReason,
billingAccountResourceId,
commitment,
displayName,
endAt,
entityType,
milestones,
primaryBillingAccountResourceId,
primaryResourceId,
productCode,
provisioningState,
resourceId,
shortfall,
startAt,
status,
systemData,
systemId,
type
FROM azure.billing_benefits.applicable_maccs
WHERE billing_account_id = '{{ billing_account_id }}' -- required
;