Get-AzBillingBenefitsSavingsPlan

Module:

Az.BillingBenefits Module

Get savings plan.

Syntax

List (Default)

Get-AzBillingBenefitsSavingsPlan
    -OrderId <String>
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

GetViaIdentitySavingsPlanOrder

Get-AzBillingBenefitsSavingsPlan
    -Id <String>
    -SavingsPlanOrderInputObject <IBillingBenefitsIdentity>
    [-Expand <String>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Get

Get-AzBillingBenefitsSavingsPlan
    -Id <String>
    -OrderId <String>
    [-Expand <String>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

GetViaIdentity

Get-AzBillingBenefitsSavingsPlan
    -InputObject <IBillingBenefitsIdentity>
    [-Expand <String>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Description

Get savings plan.

Examples

Example 1: List savings plan under a savings plan order

Get-AzBillingBenefitsSavingsPlan -OrderId d7ea1620-2bba-46e2-8434-11f31bfb984d

Name    Status    ExpiryDate            PurchaseDate          Term Scope  AppliedScopeDisplayName ProductName          CommitmentAmount CommitmentCurrencyCode
----    ------    ----------            ------------          ---- -----  ----------------------- -----------          ---------------- ------------------
PSTest7 Succeeded 11/29/2025 2:23:51 AM 11/29/2022 2:20:38 AM P3Y  Shared                         Compute_Savings_Plan 0.001            USD

List savings plan under a savings plan order

Example 2: Get a single savings plan

Get-AzBillingBenefitsSavingsPlan -OrderId d7ea1620-2bba-46e2-8434-11f31bfb984d -Id 9fde2a72-776b-49fc-869c-dca8859d7d62

Name    Status    ExpiryDate            PurchaseDate          Term Scope  AppliedScopeDisplayName ProductName          CommitmentAmount CommitmentCurrencyCode
----    ------    ----------            ------------          ---- -----  ----------------------- -----------          ---------------- ------------------
PSTest7 Succeeded 11/29/2025 2:23:51 AM 11/29/2022 2:20:38 AM P3Y  Shared                         Compute_Savings_Plan 0.001            USD

Get a single savings plan

Parameters

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Parameter properties

Type:	PSObject
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	AzureRMContext, AzureCredential

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Expand

May be used to expand the detail information of some properties.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

GetViaIdentitySavingsPlanOrder

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

Get

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

GetViaIdentity

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Id

ID of the savings plan

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	SavingsPlanId

Parameter sets

GetViaIdentitySavingsPlanOrder

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

Get

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-InputObject

Identity Parameter

Parameter properties

Type:	IBillingBenefitsIdentity
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

GetViaIdentity

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

-OrderId

Order ID of the savings plan

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	SavingsPlanOrderId

Parameter sets

List

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

Get

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-SavingsPlanOrderInputObject

Identity Parameter

Parameter properties

Type:	IBillingBenefitsIdentity
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

GetViaIdentitySavingsPlanOrder

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

IBillingBenefitsIdentity

Outputs

ISavingsPlanModel