Package com.azure.resourcemanager.billingbenefits.models

Interface SavingsPlanModel

public interface SavingsPlanModel
An immutable client-side representation of SavingsPlanModel.

  • Method Summary

    Modifier and Type
    Method
    Description
    AppliedScopeProperties
    appliedScopeProperties()
    Gets the appliedScopeProperties property: Properties specific to applied scope type.
    AppliedScopeType
    appliedScopeType()
    Gets the appliedScopeType property: Type of the Applied Scope.
    OffsetDateTime
    benefitStartTime()
    Gets the benefitStartTime property: This is the DateTime when the savings plan benefit started.
    String
    billingAccountId()
    Gets the billingAccountId property: Fully-qualified identifier of the billing account where the savings plan is applied.
    BillingPlan
    billingPlan()
    Gets the billingPlan property: Represents the billing plan in ISO 8601 format.
    String
    billingProfileId()
    Gets the billingProfileId property: Fully-qualified identifier of the billing profile where the savings plan is applied.
    String
    billingScopeId()
    Gets the billingScopeId property: Subscription that will be charged for purchasing the benefit.
    Commitment
    commitment()
    Gets the commitment property: Commitment towards the benefit.
    String
    customerId()
    Gets the customerId property: Fully-qualified identifier of the customer where the savings plan is applied.
    String
    displayName()
    Gets the displayName property: Display name.
    String
    displayProvisioningState()
    Gets the displayProvisioningState property: The provisioning state of the savings plan for display, e.g.
    OffsetDateTime
    effectiveDateTime()
    Gets the effectiveDateTime property: DateTime of the savings plan starts providing benefit from.
    OffsetDateTime
    expiryDateTime()
    Gets the expiryDateTime property: Expiry date time.
    ExtendedStatusInfo
    extendedStatusInfo()
    Gets the extendedStatusInfo property: The extendedStatusInfo property.
    String
    id()
    Gets the id property: Fully qualified resource Id for the resource.
    SavingsPlanModelInner
    innerModel()
    Gets the inner com.azure.resourcemanager.billingbenefits.fluent.models.SavingsPlanModelInner object.
    String
    name()
    Gets the name property: The name of the resource.
    ProvisioningState
    provisioningState()
    Gets the provisioningState property: Provisioning state.
    OffsetDateTime
    purchaseDateTime()
    Gets the purchaseDateTime property: Date time when the savings plan was purchased.
    Boolean
    renew()
    Gets the renew property: Setting this to true will automatically purchase a new benefit on the expiration date time.
    String
    renewDestination()
    Gets the renewDestination property: SavingsPlan Id of the SavingsPlan which is purchased because of renew.
    RenewProperties
    renewProperties()
    Gets the renewProperties property: The renewProperties property.
    String
    renewSource()
    Gets the renewSource property: SavingsPlan Id of the SavingsPlan from which this SavingsPlan is renewed.
    Sku
    sku()
    Gets the sku property: Savings plan SKU.
    com.azure.core.management.SystemData
    systemData()
    Gets the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Term
    term()
    Gets the term property: Represent benefit term in ISO 8601 format.
    String
    type()
    Gets the type property: The type of the resource.
    String
    userFriendlyAppliedScopeType()
    Gets the userFriendlyAppliedScopeType property: The applied scope type of the savings plan for display, e.g.
    Utilization
    utilization()
    Gets the utilization property: Savings plan utilization.

  • Method Details

    • id

      String id()
      Gets the id property: Fully qualified resource Id for the resource.
      Returns:
      the id value.

    • name

      String name()
      Gets the name property: The name of the resource.
      Returns:
      the name value.

    • type

      String type()
      Gets the type property: The type of the resource.
      Returns:
      the type value.

    • sku

      Sku sku()
      Gets the sku property: Savings plan SKU.
      Returns:
      the sku value.

    • systemData

      com.azure.core.management.SystemData systemData()
      Gets the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.
      Returns:
      the systemData value.

    • displayName

      String displayName()
      Gets the displayName property: Display name.
      Returns:
      the displayName value.

    • provisioningState

      ProvisioningState provisioningState()
      Gets the provisioningState property: Provisioning state.
      Returns:
      the provisioningState value.

    • displayProvisioningState

      String displayProvisioningState()
      Gets the displayProvisioningState property: The provisioning state of the savings plan for display, e.g. Succeeded.
      Returns:
      the displayProvisioningState value.

    • billingScopeId

      String billingScopeId()
      Gets the billingScopeId property: Subscription that will be charged for purchasing the benefit.
      Returns:
      the billingScopeId value.

    • billingProfileId

      String billingProfileId()
      Gets the billingProfileId property: Fully-qualified identifier of the billing profile where the savings plan is applied. Present only for Field-led or Customer-led customers.
      Returns:
      the billingProfileId value.

    • customerId

      String customerId()
      Gets the customerId property: Fully-qualified identifier of the customer where the savings plan is applied. Present only for Partner-led customers.
      Returns:
      the customerId value.

    • billingAccountId

      String billingAccountId()
      Gets the billingAccountId property: Fully-qualified identifier of the billing account where the savings plan is applied. Present only for Enterprise Agreement customers.
      Returns:
      the billingAccountId value.

    • term

      Term term()
      Gets the term property: Represent benefit term in ISO 8601 format.
      Returns:
      the term value.

    • billingPlan

      BillingPlan billingPlan()
      Gets the billingPlan property: Represents the billing plan in ISO 8601 format. Required only for monthly billing plans.
      Returns:
      the billingPlan value.

    • appliedScopeType

      AppliedScopeType appliedScopeType()
      Gets the appliedScopeType property: Type of the Applied Scope.
      Returns:
      the appliedScopeType value.

    • userFriendlyAppliedScopeType

      String userFriendlyAppliedScopeType()
      Gets the userFriendlyAppliedScopeType property: The applied scope type of the savings plan for display, e.g. Shared.
      Returns:
      the userFriendlyAppliedScopeType value.

    • appliedScopeProperties

      AppliedScopeProperties appliedScopeProperties()
      Gets the appliedScopeProperties property: Properties specific to applied scope type. Not required if not applicable.
      Returns:
      the appliedScopeProperties value.

    • commitment

      Commitment commitment()
      Gets the commitment property: Commitment towards the benefit.
      Returns:
      the commitment value.

    • effectiveDateTime

      OffsetDateTime effectiveDateTime()
      Gets the effectiveDateTime property: DateTime of the savings plan starts providing benefit from.
      Returns:
      the effectiveDateTime value.

    • expiryDateTime

      OffsetDateTime expiryDateTime()
      Gets the expiryDateTime property: Expiry date time.
      Returns:
      the expiryDateTime value.

    • purchaseDateTime

      OffsetDateTime purchaseDateTime()
      Gets the purchaseDateTime property: Date time when the savings plan was purchased.
      Returns:
      the purchaseDateTime value.

    • benefitStartTime

      OffsetDateTime benefitStartTime()
      Gets the benefitStartTime property: This is the DateTime when the savings plan benefit started.
      Returns:
      the benefitStartTime value.

    • extendedStatusInfo

      ExtendedStatusInfo extendedStatusInfo()
      Gets the extendedStatusInfo property: The extendedStatusInfo property.
      Returns:
      the extendedStatusInfo value.

    • renew

      Boolean renew()
      Gets the renew property: Setting this to true will automatically purchase a new benefit on the expiration date time.
      Returns:
      the renew value.

    • utilization

      Utilization utilization()
      Gets the utilization property: Savings plan utilization.
      Returns:
      the utilization value.

    • renewSource

      String renewSource()
      Gets the renewSource property: SavingsPlan Id of the SavingsPlan from which this SavingsPlan is renewed.
      Returns:
      the renewSource value.

    • renewDestination

      String renewDestination()
      Gets the renewDestination property: SavingsPlan Id of the SavingsPlan which is purchased because of renew.
      Returns:
      the renewDestination value.

    • renewProperties

      RenewProperties renewProperties()
      Gets the renewProperties property: The renewProperties property.
      Returns:
      the renewProperties value.

    • innerModel

      SavingsPlanModelInner innerModel()
      Gets the inner com.azure.resourcemanager.billingbenefits.fluent.models.SavingsPlanModelInner object.
      Returns:
      the inner object.