Credit interface

Package:

@azure/arm-billingbenefits

Credit resource definition

Extends

TrackedResource

Properties

billingAccountResourceId	Fully-qualified identifier of the billing account where the benefit is applied. Present only for Enterprise Agreement customers.
billingProfileResourceId	Fully-qualified identifier of the billing profile where the benefit is applied. Present only for Field-led or Customer-led customers.
breakdown	Credit line-items/milestones/no-charge services breakdown
credit	The entire investment amount for the credit contract, including currency and amount
customerId	Fully-qualified identifier of the customer where the savings plan is applied. Present only for Partner-led customers. Format is /providers/Microsoft.Billing/billingAccounts/{acctId:orgId}
endAt	End DateTime in UTC.
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.
plan	Plan for the resource.
policies	Credit breakdown item representing a milestone, line-item, or no-charge service
productCode	Product UPN for the credit type
provisioningState	Provisioning state
reason	The reason for the credit. Not required if not applicable.
resourceId	Fully-qualified resource identifier of the resource. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/{benefitType}/{benefitName}.
sku	The resource model definition representing SKU
startAt	Start DateTime.
status	Status of the credit
systemId	System identifier

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

billingAccountResourceId

Fully-qualified identifier of the billing account where the benefit is applied. Present only for Enterprise Agreement customers.

billingAccountResourceId?: string

Property Value

string

billingProfileResourceId

Fully-qualified identifier of the billing profile where the benefit is applied. Present only for Field-led or Customer-led customers.

billingProfileResourceId?: string

Property Value

string

breakdown

Credit line-items/milestones/no-charge services breakdown

breakdown?: CreditBreakdownItem[]

Property Value

CreditBreakdownItem[]

credit

The entire investment amount for the credit contract, including currency and amount

credit?: Commitment

Property Value

Commitment

customerId

Fully-qualified identifier of the customer where the savings plan is applied. Present only for Partner-led customers. Format is /providers/Microsoft.Billing/billingAccounts/{acctId:orgId}

customerId?: string

Property Value

string

endAt

End DateTime in UTC.

endAt?: Date

Property Value

Date

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

plan

Plan for the resource.

plan?: Plan

Property Value

Plan

policies

Credit breakdown item representing a milestone, line-item, or no-charge service

policies?: CreditPolicies

Property Value

CreditPolicies

productCode

Product UPN for the credit type

productCode?: string

Property Value

string

provisioningState

Provisioning state

provisioningState?: string

Property Value

string

reason

The reason for the credit. Not required if not applicable.

reason?: CreditReason

Property Value

CreditReason

resourceId

Fully-qualified resource identifier of the resource. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/{benefitType}/{benefitName}.

resourceId?: string

Property Value

string

sku

The resource model definition representing SKU

sku?: Sku

Property Value

Sku

startAt

Start DateTime.

startAt?: Date

Property Value

Date

status

Status of the credit

status?: string

Property Value

string

systemId

System identifier

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