Macc interface

Package:

@azure/arm-billingbenefits

Microsoft Azure Consumption Commitment.

Extends

TrackedResource

Properties

allowContributors	Setting this to true means multi-entity.
automaticShortfall	Setting this to 'Enable' enables automatic shortfall charging when commitment is not met.
automaticShortfallSuppressReason	Optional field to record suppression reason for automatic shortfall.
billingAccountResourceId	Fully-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}
commitment	Commitment towards the benefit.
displayName	Display name
endAt	Must be end of month. Timestamp must be in the ISO date format YYYY-MM-DDT23:59:59Z.
entityType	Represents type of the object being operated on. Possible values are primary or contributor.
etag	The etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
identity	Managed service identity (system assigned and/or user assigned identities)
kind	Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. E.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.
managedBy	The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.
milestones	List of milestones associated with this MACC.
plan	Plan for the resource.
primaryBillingAccountResourceId	Fully-qualified billing account resource identifier of the primary MACC. Format must be Azure Resource ID: /providers/Microsoft.Billing/billingAccounts/{acctId:orgId}.
primaryResourceId	Fully-qualified resource identifier of the primary MACC. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/maccs/{maccName}.
productCode	Represents catalog UPN.
provisioningState	Provisioning 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.
resourceId	This is the resource identifier of either the primary MACC or the contributor. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/maccs/{maccName}.
shortfall	MACC shortfall
sku	The resource model definition representing SKU
startAt	Must be start of month. Timestamp must be in the ISO date format YYYY-MM-DDT00:00:00Z.
status	Represents the current status of the MACC.
systemId	This is the globally unique identifier of the MACC which will not change for the lifetime of the MACC.

Inherited Properties

id	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	The geo-location where the resource lives
name	The name of the resource
systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	Resource tags.
type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Property Details

allowContributors

Setting this to true means multi-entity.

allowContributors?: boolean

Property Value

boolean

automaticShortfall

Setting this to 'Enable' enables automatic shortfall charging when commitment is not met.

automaticShortfall?: string

Property Value

string

automaticShortfallSuppressReason

Optional field to record suppression reason for automatic shortfall.

automaticShortfallSuppressReason?: AutomaticShortfallSuppressReason

Property Value

AutomaticShortfallSuppressReason

billingAccountResourceId

Fully-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}

billingAccountResourceId?: string

Property Value

string

commitment

Commitment towards the benefit.

commitment?: Commitment

Property Value

Commitment

displayName

Display name

displayName?: string

Property Value

string

endAt

Must be end of month. Timestamp must be in the ISO date format YYYY-MM-DDT23:59:59Z.

endAt?: Date

Property Value

Date

entityType

Represents type of the object being operated on. Possible values are primary or contributor.

entityType?: string

Property Value

string

etag

The etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.

etag?: string

Property Value

string

identity

Managed service identity (system assigned and/or user assigned identities)

identity?: ManagedServiceIdentity

Property Value

ManagedServiceIdentity

kind

Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. E.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.

kind?: string

Property Value

string

managedBy

The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.

managedBy?: string

Property Value

string

milestones

List of milestones associated with this MACC.

milestones?: MaccMilestone[]

Property Value

MaccMilestone[]

plan

Plan for the resource.

plan?: Plan

Property Value

Plan

primaryBillingAccountResourceId

Fully-qualified billing account resource identifier of the primary MACC. Format must be Azure Resource ID: /providers/Microsoft.Billing/billingAccounts/{acctId:orgId}.

primaryBillingAccountResourceId?: string

Property Value

string

primaryResourceId

Fully-qualified resource identifier of the primary MACC. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/maccs/{maccName}.

primaryResourceId?: string

Property Value

string

productCode

Represents catalog UPN.

productCode?: string

Property Value

string

provisioningState

Provisioning 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.

provisioningState?: string

Property Value

string

resourceId

This is the resource identifier of either the primary MACC or the contributor. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/maccs/{maccName}.

resourceId?: string

Property Value

string

shortfall

MACC shortfall

shortfall?: Shortfall

Property Value

Shortfall

sku

The resource model definition representing SKU

sku?: Sku

Property Value

Sku

startAt

Must be start of month. Timestamp must be in the ISO date format YYYY-MM-DDT00:00:00Z.

startAt?: Date

Property Value

Date

status

Represents the current status of the MACC.

status?: string

Property Value

string

systemId

This is the globally unique identifier of the MACC which will not change for the lifetime of the MACC.

systemId?: string

Property Value

string

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

id?: string

Property Value

string

Inherited From TrackedResource.id

location

The geo-location where the resource lives

location: string

Property Value

string

Inherited From TrackedResource.location

name

The name of the resource

name?: string

Property Value

string

Inherited From TrackedResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

systemData?: SystemData

Property Value

SystemData

Inherited From TrackedResource.systemData

tags

Resource tags.

tags?: Record<string, string>

Property Value

Record<string, string>

Inherited From TrackedResource.tags

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

type?: string

Property Value

string

Inherited From TrackedResource.type