SavingsPlanModelProperties interface

Package:

@azure/arm-billingbenefits

Savings plan properties

Properties

appliedScopeProperties	Properties specific to applied scope type. Not required if not applicable.
appliedScopeType	Type of the Applied Scope.
benefitStartTime	This is the DateTime when the savings plan benefit started.
billingAccountId	Fully-qualified identifier of the billing account where the benefit is applied. Present only for Enterprise Agreement customers.
billingPlan	Represents the billing plan in ISO 8601 format. Required only for monthly billing plans.
billingProfileId	Fully-qualified identifier of the billing profile where the benefit is applied. Present only for Field-led or Customer-led customers.
billingScopeId	Subscription that will be charged for purchasing the benefit
commitment	Commitment towards the benefit.
customerId	Fully-qualified identifier of the customer where the savings plan is applied. Present only for Partner-led customers.
displayName	Display name
displayProvisioningState	The provisioning state of the savings plan for display, e.g. Succeeded
effectiveDateTime	DateTime of the savings plan starts providing benefit from.
expiryDateTime	Expiry date time
extendedStatusInfo
provisioningState	Provisioning state
purchaseDateTime	Date time when the savings plan was purchased
renew	Setting this to true will automatically purchase a new benefit on the expiration date time.
renewDestination	SavingsPlan Id of the SavingsPlan which is purchased because of renew.
renewProperties
renewSource	SavingsPlan Id of the SavingsPlan from which this SavingsPlan is renewed.
term	Represent benefit term in ISO 8601 format.
userFriendlyAppliedScopeType	The applied scope type of the savings plan for display, e.g. Shared
utilization	Savings plan utilization

Property Details

appliedScopeProperties

Properties specific to applied scope type. Not required if not applicable.

appliedScopeProperties?: AppliedScopeProperties

Property Value

AppliedScopeProperties

appliedScopeType

Type of the Applied Scope.

appliedScopeType?: string

Property Value

string

benefitStartTime

This is the DateTime when the savings plan benefit started.

benefitStartTime?: Date

Property Value

Date

billingAccountId

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

billingAccountId?: string

Property Value

string

billingPlan

Represents the billing plan in ISO 8601 format. Required only for monthly billing plans.

billingPlan?: string

Property Value

string

billingProfileId

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

billingProfileId?: string

Property Value

string

billingScopeId

Subscription that will be charged for purchasing the benefit

billingScopeId?: string

Property Value

string

commitment

Commitment towards the benefit.

commitment?: Commitment

Property Value

Commitment

customerId

Fully-qualified identifier of the customer where the savings plan is applied. Present only for Partner-led customers.

customerId?: string

Property Value

string

displayName

Display name

displayName?: string

Property Value

string

displayProvisioningState

The provisioning state of the savings plan for display, e.g. Succeeded

displayProvisioningState?: string

Property Value

string

effectiveDateTime

DateTime of the savings plan starts providing benefit from.

effectiveDateTime?: Date

Property Value

Date

expiryDateTime

Expiry date time

expiryDateTime?: Date

Property Value

Date

extendedStatusInfo

extendedStatusInfo?: ExtendedStatusInfo

Property Value

ExtendedStatusInfo

provisioningState

Provisioning state

provisioningState?: string

Property Value

string

purchaseDateTime

Date time when the savings plan was purchased

purchaseDateTime?: Date

Property Value

Date

renew

Setting this to true will automatically purchase a new benefit on the expiration date time.

renew?: boolean

Property Value

boolean

renewDestination

SavingsPlan Id of the SavingsPlan which is purchased because of renew.

renewDestination?: string

Property Value

string

renewProperties

renewProperties?: RenewProperties

Property Value

RenewProperties

renewSource

SavingsPlan Id of the SavingsPlan from which this SavingsPlan is renewed.

renewSource?: string

Property Value

string

term

Represent benefit term in ISO 8601 format.

term?: string

Property Value

string

userFriendlyAppliedScopeType

The applied scope type of the savings plan for display, e.g. Shared

userFriendlyAppliedScopeType?: string

Property Value

string

utilization

Savings plan utilization

utilization?: Utilization

Property Value

Utilization