SavingsPlanModel Class

Savings plan.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Inheritance

azure.mgmt.billing.models._models_py3.ProxyResourceWithTags

SavingsPlanModel

Constructor

SavingsPlanModel(*, sku: _models.Sku, tags: Dict[str, str] | None = None, display_name: str | None = None, provisioning_state: str | _models.ProvisioningState | None = None, billing_scope_id: str | None = None, term: str | _models.SavingsPlanTerm | None = None, renew: bool = False, renew_source: str | None = None, renew_destination: str | None = None, renew_properties: _models.RenewProperties | None = None, billing_plan: str | _models.BillingPlan | None = None, applied_scope_type: str | _models.AppliedScopeType | None = None, applied_scope_properties: _models.AppliedScopeProperties | None = None, commitment: _models.Commitment | None = None, product_code: str | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
tags	dict[str, str] Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & ? /.
sku	Sku Savings plan SKU. Required.
display_name	str Display name.
provisioning_state	str or ProvisioningState The provisioning state of the resource during a long-running operation. Known values are: "Succeeded", "Canceled", "Failed", "New", "Pending", "Provisioning", "PendingBilling", "ConfirmedBilling", "Creating", "Created", and "Expired".
billing_scope_id	str Subscription that will be charged for purchasing SavingsPlan.
term	str or SavingsPlanTerm Represents the Savings plan term in ISO 8601 format. Known values are: "P1Y", "P3Y", and "P5Y".
renew	bool Setting this to true will automatically purchase a new benefit on the expiration date time.
renew_source	str SavingsPlan Id of the SavingsPlan from which this SavingsPlan is renewed.
renew_destination	str SavingsPlan Id of the SavingsPlan which is purchased because of renew.
renew_properties	RenewProperties Properties specific to renew.
billing_plan	str or BillingPlan Represents the billing plan in ISO 8601 format. Required only for monthly purchases. "P1M"
applied_scope_type	str or AppliedScopeType Type of the Applied Scope. Known values are: "Single", "Shared", and "ManagementGroup".
applied_scope_properties	AppliedScopeProperties Properties specific to applied scope type. Not required if not applicable.
commitment	Commitment Commitment towards the benefit.
product_code	str Represents UPN.

Variables

Name	Description
id	str Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
name	str The name of the resource.
type	str The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
system_data	SystemData Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	dict[str, str] Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & ? /.
sku	Sku Savings plan SKU. Required.
display_name	str Display name.
provisioning_state	str or ProvisioningState The provisioning state of the resource during a long-running operation. Known values are: "Succeeded", "Canceled", "Failed", "New", "Pending", "Provisioning", "PendingBilling", "ConfirmedBilling", "Creating", "Created", and "Expired".
display_provisioning_state	str The provisioning state of the savings plan for display, e.g. Succeeded.
user_friendly_applied_scope_type	str The applied scope type of the savings plan for display, e.g. Shared.
billing_scope_id	str Subscription that will be charged for purchasing SavingsPlan.
billing_profile_id	str Fully-qualified identifier of the billing profile where the savings plan is applied. Present only for Field-led or Customer-led customers.
customer_id	str Fully-qualified identifier of the customer where the savings plan is applied. Present only for Partner-led customers.
billing_account_id	str Fully-qualified identifier of the billing account where the savings plan is applied.
term	str or SavingsPlanTerm Represents the Savings plan term in ISO 8601 format. Known values are: "P1Y", "P3Y", and "P5Y".
renew	bool Setting this to true will automatically purchase a new benefit on the expiration date time.
renew_source	str SavingsPlan Id of the SavingsPlan from which this SavingsPlan is renewed.
renew_destination	str SavingsPlan Id of the SavingsPlan which is purchased because of renew.
renew_properties	RenewProperties Properties specific to renew.
billing_plan	str or BillingPlan Represents the billing plan in ISO 8601 format. Required only for monthly purchases. "P1M"
applied_scope_type	str or AppliedScopeType Type of the Applied Scope. Known values are: "Single", "Shared", and "ManagementGroup".
applied_scope_properties	AppliedScopeProperties Properties specific to applied scope type. Not required if not applicable.
commitment	Commitment Commitment towards the benefit.
effective_date_time	datetime DateTime of the savings plan starting when this version is effective from.
benefit_start_time	datetime This is the DateTime when the savings plan benefit starts.
expiry_date_time	datetime This is the date-time when the savings plan will expire.
purchase_date_time	datetime Date time when the savings plan was purchased.
utilization	Utilization Savings plan utilization.
extended_status_info	ExtendedStatusInfo Extended status information.
product_code	str Represents UPN.