SavingsPlanModel interface

Package:

@azure/arm-billingbenefits

Savings plan

Extends

Resource

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 savings plan is applied. Present only for Enterprise Agreement customers. NOTE: This property will not be serialized. It can only be populated by the server.
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 savings plan is applied. Present only for Field-led or Customer-led customers. NOTE: This property will not be serialized. It can only be populated by the server.
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. NOTE: This property will not be serialized. It can only be populated by the server.
displayName	Display name
displayProvisioningState	The provisioning state of the savings plan for display, e.g. Succeeded NOTE: This property will not be serialized. It can only be populated by the server.
effectiveDateTime	DateTime of the savings plan starts providing benefit from. NOTE: This property will not be serialized. It can only be populated by the server.
expiryDateTime	Expiry date time NOTE: This property will not be serialized. It can only be populated by the server.
extendedStatusInfo	NOTE: This property will not be serialized. It can only be populated by the server.
provisioningState	Provisioning state NOTE: This property will not be serialized. It can only be populated by the server.
purchaseDateTime	Date time when the savings plan was purchased NOTE: This property will not be serialized. It can only be populated by the server.
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.
sku	Savings plan SKU
term	Represent benefit term in ISO 8601 format.
userFriendlyAppliedScopeType	The applied scope type of the savings plan for display, e.g. Shared NOTE: This property will not be serialized. It can only be populated by the server.
utilization	Savings plan utilization NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

id	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.
name	The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.
type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

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 savings plan is applied. Present only for Enterprise Agreement customers. NOTE: This property will not be serialized. It can only be populated by the server.

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 savings plan is applied. Present only for Field-led or Customer-led customers. NOTE: This property will not be serialized. It can only be populated by the server.

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. NOTE: This property will not be serialized. It can only be populated by the server.

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 NOTE: This property will not be serialized. It can only be populated by the server.

displayProvisioningState?: string

Property Value

string

effectiveDateTime

DateTime of the savings plan starts providing benefit from. NOTE: This property will not be serialized. It can only be populated by the server.

effectiveDateTime?: Date

Property Value

Date

expiryDateTime

Expiry date time NOTE: This property will not be serialized. It can only be populated by the server.

expiryDateTime?: Date

Property Value

Date

extendedStatusInfo

NOTE: This property will not be serialized. It can only be populated by the server.

extendedStatusInfo?: ExtendedStatusInfo

Property Value

ExtendedStatusInfo

provisioningState

Provisioning state NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

purchaseDateTime

Date time when the savings plan was purchased NOTE: This property will not be serialized. It can only be populated by the server.

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

sku

Savings plan SKU

sku: Sku

Property Value

Sku

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 NOTE: This property will not be serialized. It can only be populated by the server.

userFriendlyAppliedScopeType?: string

Property Value

string

utilization

Savings plan utilization NOTE: This property will not be serialized. It can only be populated by the server.

utilization?: Utilization

Property Value

Utilization

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From Resource.id

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From Resource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

Inherited From Resource.systemData

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From Resource.type