Savings Plans - List By Billing Account

リファレンス

サービス:: Billing

API バージョン:: 2024-04-01

課金アカウント別に節約プランを一覧表示します。

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/savingsPlans?api-version=2024-04-01

省略可能なパラメーターを含む:

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/savingsPlans?api-version=2024-04-01&filter={filter}&orderBy={orderBy}&skiptoken={skiptoken}&take={take}&selectedState={selectedState}&refreshSummary={refreshSummary}

URI パラメーター

名前	/	必須	型	説明
billingAccountName	path	True	string pattern: ^([0-9]+\|([Pp][Cc][Nn]\.[A-Za-z0-9]+)\|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$	課金アカウントを一意に識別する ID。
api-version	query	True	string	クライアント要求で使用する API のバージョン。現在のバージョンは 2024-04-01 です。
filter	query		string	フィルタークエリオプションを使用すると、クライアントは要求 URL でアドレス指定されたリソースのコレクションをフィルター処理できます。
orderBy	query		string	orderby クエリオプションを使用すると、クライアントは特定の順序でリソースを要求できます。
refreshSummary	query		string	プロビジョニングの状態によって節約計画グループのロールアップ数を更新するかどうかを示すには
selectedState	query		string	選択したプロビジョニング状態
skiptoken	query		number	結果を返す前にリストからスキップする節約計画の数
take	query		number	返される節約計画の数

応答

名前	型	説明
200 OK	SavingsPlanModelListResult	要求が完了しました。
Other Status Codes	ErrorResponse	予期しないエラー。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装する

例

SavingsPlansList

要求のサンプル

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlans?api-version=2024-04-01&take=3&selectedState=Succeeded&refreshSummary=true


/**
 * Samples for SavingsPlans ListByBillingAccount.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/
     * savingsPlansListByBillingAccount.json
     */
    /**
     * Sample code: SavingsPlansList.
     * 
     * @param manager Entry point to BillingManager.
     */
    public static void savingsPlansList(com.azure.resourcemanager.billing.BillingManager manager) {
        manager.savingsPlans().listByBillingAccount(
            "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", null, null, null,
            3.0F, "Succeeded", "true", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.billing import BillingManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-billing
# USAGE
    python savings_plans_list_by_billing_account.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = BillingManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.savings_plans.list_by_billing_account(
        billing_account_name="00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/savingsPlansListByBillingAccount.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armbilling_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/billing/armbilling"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c08ac9813477921ad8295b98ced8f82d11b8f913/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/savingsPlansListByBillingAccount.json
func ExampleSavingsPlansClient_NewListByBillingAccountPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armbilling.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewSavingsPlansClient().NewListByBillingAccountPager("00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", &armbilling.SavingsPlansClientListByBillingAccountOptions{Filter: nil,
		OrderBy:        nil,
		Skiptoken:      nil,
		Take:           to.Ptr[float32](3),
		SelectedState:  to.Ptr("Succeeded"),
		RefreshSummary: to.Ptr("true"),
	})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.SavingsPlanModelListResult = armbilling.SavingsPlanModelListResult{
		// 	Value: []*armbilling.SavingsPlanModel{
		// 		{
		// 			Name: to.Ptr("30000000-0000-0000-0000-000000000000"),
		// 			Type: to.Ptr("microsoft.billing/billingAccounts/savingsPlanOrders/savingsPlans"),
		// 			ID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlanOrders/20000000-0000-0000-0000-000000000000/savingsPlans/30000000-0000-0000-0000-000000000000"),
		// 			Tags: map[string]*string{
		// 				"key1": to.Ptr("value1"),
		// 				"key2": to.Ptr("value2"),
		// 			},
		// 			Properties: &armbilling.SavingsPlanModelProperties{
		// 				AppliedScopeType: to.Ptr(armbilling.AppliedScopeTypeShared),
		// 				BenefitStartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-12-16T02:17:03.739Z"); return t}()),
		// 				BillingAccountID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31"),
		// 				BillingPlan: to.Ptr(armbilling.BillingPlanP1M),
		// 				BillingProfileID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-BBBB-CCC-DDD"),
		// 				BillingScopeID: to.Ptr("/subscriptions/10000000-0000-0000-0000-000000000000"),
		// 				Commitment: &armbilling.Commitment{
		// 					Amount: to.Ptr[float64](10),
		// 					CurrencyCode: to.Ptr("USD"),
		// 					Grain: to.Ptr(armbilling.CommitmentGrainHourly),
		// 				},
		// 				DisplayName: to.Ptr("SP1"),
		// 				DisplayProvisioningState: to.Ptr("Succeeded"),
		// 				EffectiveDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-12-16T02:17:04.989Z"); return t}()),
		// 				ExpiryDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-12-16T02:17:03.739Z"); return t}()),
		// 				ProductCode: to.Ptr("20000000-0000-0000-0000-000000000005"),
		// 				ProvisioningState: to.Ptr(armbilling.ProvisioningStateSucceeded),
		// 				PurchaseDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-12-16T02:14:58.230Z"); return t}()),
		// 				Renew: to.Ptr(false),
		// 				Term: to.Ptr(armbilling.SavingsPlanTermP1Y),
		// 				UserFriendlyAppliedScopeType: to.Ptr("Shared"),
		// 				Utilization: &armbilling.Utilization{
		// 					Aggregates: []*armbilling.UtilizationAggregates{
		// 						{
		// 							Grain: to.Ptr[float32](1),
		// 							GrainUnit: to.Ptr("days"),
		// 							Value: to.Ptr[float32](0),
		// 							ValueUnit: to.Ptr("percentage"),
		// 						},
		// 						{
		// 							Grain: to.Ptr[float32](7),
		// 							GrainUnit: to.Ptr("days"),
		// 							Value: to.Ptr[float32](0),
		// 							ValueUnit: to.Ptr("percentage"),
		// 						},
		// 						{
		// 							Grain: to.Ptr[float32](30),
		// 							GrainUnit: to.Ptr("days"),
		// 							Value: to.Ptr[float32](0),
		// 							ValueUnit: to.Ptr("percentage"),
		// 					}},
		// 					Trend: to.Ptr("SAME"),
		// 				},
		// 			},
		// 			SKU: &armbilling.SKU{
		// 				Name: to.Ptr("Compute_Savings_Plan"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("30000000-0000-0000-0000-000000000001"),
		// 			Type: to.Ptr("microsoft.billing/billingAccounts/savingsPlanOrders/savingsPlans"),
		// 			ID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlanOrders/20000000-0000-0000-0000-000000000001/savingsPlans/30000000-0000-0000-0000-000000000001"),
		// 			Tags: map[string]*string{
		// 				"key1": to.Ptr("value1"),
		// 				"key2": to.Ptr("value2"),
		// 			},
		// 			Properties: &armbilling.SavingsPlanModelProperties{
		// 				AppliedScopeProperties: &armbilling.AppliedScopeProperties{
		// 					DisplayName: to.Ptr("TestRg"),
		// 					ManagementGroupID: to.Ptr("/providers/Microsoft.Management/managementGroups/TestRg"),
		// 					TenantID: to.Ptr("50000000-0000-0000-0000-000000000000"),
		// 				},
		// 				AppliedScopeType: to.Ptr(armbilling.AppliedScopeTypeManagementGroup),
		// 				BenefitStartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-12-16T02:22:22.725Z"); return t}()),
		// 				BillingAccountID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31"),
		// 				BillingPlan: to.Ptr(armbilling.BillingPlanP1M),
		// 				BillingProfileID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-BBBB-CCC-DDD"),
		// 				BillingScopeID: to.Ptr("/subscriptions/10000000-0000-0000-0000-000000000000"),
		// 				Commitment: &armbilling.Commitment{
		// 					Amount: to.Ptr[float64](10),
		// 					CurrencyCode: to.Ptr("USD"),
		// 					Grain: to.Ptr(armbilling.CommitmentGrainHourly),
		// 				},
		// 				DisplayName: to.Ptr("SP2"),
		// 				DisplayProvisioningState: to.Ptr("Succeeded"),
		// 				EffectiveDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-12-16T02:22:24.553Z"); return t}()),
		// 				ExpiryDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-12-16T02:22:22.725Z"); return t}()),
		// 				ProductCode: to.Ptr("20000000-0000-0000-0000-000000000005"),
		// 				ProvisioningState: to.Ptr(armbilling.ProvisioningStateSucceeded),
		// 				PurchaseDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-12-16T02:20:23.473Z"); return t}()),
		// 				Renew: to.Ptr(false),
		// 				Term: to.Ptr(armbilling.SavingsPlanTermP1Y),
		// 				UserFriendlyAppliedScopeType: to.Ptr("ManagementGroup"),
		// 				Utilization: &armbilling.Utilization{
		// 					Aggregates: []*armbilling.UtilizationAggregates{
		// 						{
		// 							Grain: to.Ptr[float32](1),
		// 							GrainUnit: to.Ptr("days"),
		// 							Value: to.Ptr[float32](0),
		// 							ValueUnit: to.Ptr("percentage"),
		// 						},
		// 						{
		// 							Grain: to.Ptr[float32](7),
		// 							GrainUnit: to.Ptr("days"),
		// 							Value: to.Ptr[float32](0),
		// 							ValueUnit: to.Ptr("percentage"),
		// 						},
		// 						{
		// 							Grain: to.Ptr[float32](30),
		// 							GrainUnit: to.Ptr("days"),
		// 							Value: to.Ptr[float32](0),
		// 							ValueUnit: to.Ptr("percentage"),
		// 					}},
		// 					Trend: to.Ptr("SAME"),
		// 				},
		// 			},
		// 			SKU: &armbilling.SKU{
		// 				Name: to.Ptr("Compute_Savings_Plan"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("30000000-0000-0000-0000-000000000002"),
		// 			Type: to.Ptr("microsoft.billing/billingAccounts/savingsPlanOrders/savingsPlans"),
		// 			ID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlanOrders/20000000-0000-0000-0000-000000000002/savingsPlans/30000000-0000-0000-0000-000000000002"),
		// 			Tags: map[string]*string{
		// 				"key1": to.Ptr("value1"),
		// 				"key2": to.Ptr("value2"),
		// 			},
		// 			Properties: &armbilling.SavingsPlanModelProperties{
		// 				AppliedScopeProperties: &armbilling.AppliedScopeProperties{
		// 					DisplayName: to.Ptr("Azure subscription 1"),
		// 					SubscriptionID: to.Ptr("/subscriptions/10000000-0000-0000-0000-000000000000"),
		// 				},
		// 				AppliedScopeType: to.Ptr(armbilling.AppliedScopeTypeSingle),
		// 				BenefitStartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-10-14T21:18:55.296Z"); return t}()),
		// 				BillingAccountID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31"),
		// 				BillingPlan: to.Ptr(armbilling.BillingPlanP1M),
		// 				BillingProfileID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-BBBB-CCC-DDD"),
		// 				BillingScopeID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptions/10000000-0000-0000-0000-000000000000"),
		// 				Commitment: &armbilling.Commitment{
		// 					Amount: to.Ptr[float64](0.025),
		// 					CurrencyCode: to.Ptr("USD"),
		// 					Grain: to.Ptr(armbilling.CommitmentGrainHourly),
		// 				},
		// 				DisplayName: to.Ptr("SP3"),
		// 				DisplayProvisioningState: to.Ptr("Succeeded"),
		// 				EffectiveDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-07T23:54:43.823Z"); return t}()),
		// 				ExpiryDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2025-10-14T21:18:55.296Z"); return t}()),
		// 				ProductCode: to.Ptr("20000000-0000-0000-0000-000000000005"),
		// 				ProvisioningState: to.Ptr(armbilling.ProvisioningStateSucceeded),
		// 				PurchaseDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-10-14T21:16:57.234Z"); return t}()),
		// 				Renew: to.Ptr(true),
		// 				Term: to.Ptr(armbilling.SavingsPlanTermP3Y),
		// 				UserFriendlyAppliedScopeType: to.Ptr("Single"),
		// 				Utilization: &armbilling.Utilization{
		// 					Aggregates: []*armbilling.UtilizationAggregates{
		// 						{
		// 							Grain: to.Ptr[float32](1),
		// 							GrainUnit: to.Ptr("days"),
		// 							Value: to.Ptr[float32](66),
		// 							ValueUnit: to.Ptr("percentage"),
		// 						},
		// 						{
		// 							Grain: to.Ptr[float32](7),
		// 							GrainUnit: to.Ptr("days"),
		// 							Value: to.Ptr[float32](66),
		// 							ValueUnit: to.Ptr("percentage"),
		// 						},
		// 						{
		// 							Grain: to.Ptr[float32](30),
		// 							GrainUnit: to.Ptr("days"),
		// 							Value: to.Ptr[float32](65.52),
		// 							ValueUnit: to.Ptr("percentage"),
		// 					}},
		// 					Trend: to.Ptr("SAME"),
		// 				},
		// 			},
		// 			SKU: &armbilling.SKU{
		// 				Name: to.Ptr("Compute_Savings_Plan"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("30000000-0000-0000-0000-000000000003"),
		// 			Type: to.Ptr("microsoft.billing/billingAccounts/savingsPlanOrders/savingsPlans"),
		// 			ID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlanOrders/20000000-0000-0000-0000-000000000003/savingsPlans/30000000-0000-0000-0000-000000000003"),
		// 			Tags: map[string]*string{
		// 				"key1": to.Ptr("value1"),
		// 				"key2": to.Ptr("value2"),
		// 			},
		// 			Properties: &armbilling.SavingsPlanModelProperties{
		// 				AppliedScopeProperties: &armbilling.AppliedScopeProperties{
		// 					DisplayName: to.Ptr("testRG"),
		// 					ResourceGroupID: to.Ptr("/subscriptions/10000000-0000-0000-0000-000000000000/resourcegroups/testRG"),
		// 				},
		// 				AppliedScopeType: to.Ptr(armbilling.AppliedScopeTypeSingle),
		// 				BenefitStartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-08T00:00:06.363Z"); return t}()),
		// 				BillingAccountID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31"),
		// 				BillingPlan: to.Ptr(armbilling.BillingPlanP1M),
		// 				BillingProfileID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-BBBB-CCC-DDD"),
		// 				BillingScopeID: to.Ptr("/subscriptions/10000000-0000-0000-0000-000000000000"),
		// 				Commitment: &armbilling.Commitment{
		// 					Amount: to.Ptr[float64](0.001),
		// 					CurrencyCode: to.Ptr("USD"),
		// 					Grain: to.Ptr(armbilling.CommitmentGrainHourly),
		// 				},
		// 				DisplayName: to.Ptr("SP4"),
		// 				DisplayProvisioningState: to.Ptr("Succeeded"),
		// 				EffectiveDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-30T21:18:12.196Z"); return t}()),
		// 				ExpiryDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2025-11-08T00:00:06.363Z"); return t}()),
		// 				ProductCode: to.Ptr("20000000-0000-0000-0000-000000000005"),
		// 				ProvisioningState: to.Ptr(armbilling.ProvisioningStateSucceeded),
		// 				PurchaseDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-07T23:57:58.242Z"); return t}()),
		// 				Renew: to.Ptr(false),
		// 				Term: to.Ptr(armbilling.SavingsPlanTermP3Y),
		// 				UserFriendlyAppliedScopeType: to.Ptr("ResourceGroup"),
		// 				Utilization: &armbilling.Utilization{
		// 					Aggregates: []*armbilling.UtilizationAggregates{
		// 						{
		// 							Grain: to.Ptr[float32](1),
		// 							GrainUnit: to.Ptr("days"),
		// 							Value: to.Ptr[float32](100),
		// 							ValueUnit: to.Ptr("percentage"),
		// 						},
		// 						{
		// 							Grain: to.Ptr[float32](7),
		// 							GrainUnit: to.Ptr("days"),
		// 							Value: to.Ptr[float32](100),
		// 							ValueUnit: to.Ptr("percentage"),
		// 						},
		// 						{
		// 							Grain: to.Ptr[float32](30),
		// 							GrainUnit: to.Ptr("days"),
		// 							Value: to.Ptr[float32](100),
		// 							ValueUnit: to.Ptr("percentage"),
		// 					}},
		// 					Trend: to.Ptr("SAME"),
		// 				},
		// 			},
		// 			SKU: &armbilling.SKU{
		// 				Name: to.Ptr("Compute_Savings_Plan"),
		// 			},
		// 	}},
		// 	Summary: &armbilling.SavingsPlanSummaryCount{
		// 		CancelledCount: to.Ptr[float32](0),
		// 		ExpiredCount: to.Ptr[float32](0),
		// 		ExpiringCount: to.Ptr[float32](0),
		// 		FailedCount: to.Ptr[float32](0),
		// 		NoBenefitCount: to.Ptr[float32](0),
		// 		PendingCount: to.Ptr[float32](0),
		// 		ProcessingCount: to.Ptr[float32](0),
		// 		SucceededCount: to.Ptr[float32](3),
		// 		WarningCount: to.Ptr[float32](0),
		// 	},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { BillingManagementClient } = require("@azure/arm-billing");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to List savings plans by billing account.
 *
 * @summary List savings plans by billing account.
 * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/savingsPlansListByBillingAccount.json
 */
async function savingsPlansList() {
  const billingAccountName =
    "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31";
  const take = 3;
  const selectedState = "Succeeded";
  const refreshSummary = "true";
  const options = {
    take,
    selectedState,
    refreshSummary,
  };
  const credential = new DefaultAzureCredential();
  const client = new BillingManagementClient(credential);
  const resArray = new Array();
  for await (let item of client.savingsPlans.listByBillingAccount(billingAccountName, options)) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using Azure;
using Azure.ResourceManager;
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Billing.Models;
using Azure.ResourceManager.Billing;

// Generated from example definition: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/savingsPlansListByBillingAccount.json
// this example is just showing the usage of "SavingsPlans_ListByBillingAccount" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this BillingAccountResource created on azure
// for more information of creating BillingAccountResource, please refer to the document of BillingAccountResource
string billingAccountName = "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31";
ResourceIdentifier billingAccountResourceId = BillingAccountResource.CreateResourceIdentifier(billingAccountName);
BillingAccountResource billingAccount = client.GetBillingAccountResource(billingAccountResourceId);

// invoke the operation and iterate over the result
BillingAccountResourceGetByBillingAccountSavingsPlanOptions options = new BillingAccountResourceGetByBillingAccountSavingsPlanOptions { Take = 3, SelectedState = "Succeeded", RefreshSummary = "true" };
await foreach (BillingSavingsPlanModelResource item in billingAccount.GetByBillingAccountSavingsPlanAsync(options))
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    BillingSavingsPlanModelData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

応答のサンプル

状態コード:: 200

{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlanOrders/20000000-0000-0000-0000-000000000000/savingsPlans/30000000-0000-0000-0000-000000000000",
      "name": "30000000-0000-0000-0000-000000000000",
      "type": "microsoft.billing/billingAccounts/savingsPlanOrders/savingsPlans",
      "sku": {
        "name": "Compute_Savings_Plan"
      },
      "tags": {
        "key1": "value1",
        "key2": "value2"
      },
      "properties": {
        "billingScopeId": "/subscriptions/10000000-0000-0000-0000-000000000000",
        "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
        "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-BBBB-CCC-DDD",
        "billingPlan": "P1M",
        "productCode": "20000000-0000-0000-0000-000000000005",
        "commitment": {
          "grain": "Hourly",
          "currencyCode": "USD",
          "amount": 10
        },
        "renew": false,
        "appliedScopeType": "Shared",
        "displayName": "SP1",
        "provisioningState": "Succeeded",
        "term": "P1Y",
        "displayProvisioningState": "Succeeded",
        "userFriendlyAppliedScopeType": "Shared",
        "expiryDateTime": "2023-12-16T02:17:03.7396152Z",
        "purchaseDateTime": "2022-12-16T02:14:58.2304134Z",
        "benefitStartTime": "2022-12-16T02:17:03.7396152Z",
        "effectiveDateTime": "2022-12-16T02:17:04.9896661Z",
        "utilization": {
          "trend": "SAME",
          "aggregates": [
            {
              "grain": 1,
              "grainUnit": "days",
              "value": 0,
              "valueUnit": "percentage"
            },
            {
              "grain": 7,
              "grainUnit": "days",
              "value": 0,
              "valueUnit": "percentage"
            },
            {
              "grain": 30,
              "grainUnit": "days",
              "value": 0,
              "valueUnit": "percentage"
            }
          ]
        }
      }
    },
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlanOrders/20000000-0000-0000-0000-000000000001/savingsPlans/30000000-0000-0000-0000-000000000001",
      "name": "30000000-0000-0000-0000-000000000001",
      "type": "microsoft.billing/billingAccounts/savingsPlanOrders/savingsPlans",
      "sku": {
        "name": "Compute_Savings_Plan"
      },
      "tags": {
        "key1": "value1",
        "key2": "value2"
      },
      "properties": {
        "billingScopeId": "/subscriptions/10000000-0000-0000-0000-000000000000",
        "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
        "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-BBBB-CCC-DDD",
        "billingPlan": "P1M",
        "productCode": "20000000-0000-0000-0000-000000000005",
        "appliedScopeProperties": {
          "tenantId": "50000000-0000-0000-0000-000000000000",
          "managementGroupId": "/providers/Microsoft.Management/managementGroups/TestRg",
          "displayName": "TestRg"
        },
        "commitment": {
          "grain": "Hourly",
          "currencyCode": "USD",
          "amount": 10
        },
        "renew": false,
        "appliedScopeType": "ManagementGroup",
        "displayName": "SP2",
        "provisioningState": "Succeeded",
        "term": "P1Y",
        "displayProvisioningState": "Succeeded",
        "userFriendlyAppliedScopeType": "ManagementGroup",
        "expiryDateTime": "2023-12-16T02:22:22.7254795Z",
        "purchaseDateTime": "2022-12-16T02:20:23.4733076Z",
        "benefitStartTime": "2022-12-16T02:22:22.7254795Z",
        "effectiveDateTime": "2022-12-16T02:22:24.5536191Z",
        "utilization": {
          "trend": "SAME",
          "aggregates": [
            {
              "grain": 1,
              "grainUnit": "days",
              "value": 0,
              "valueUnit": "percentage"
            },
            {
              "grain": 7,
              "grainUnit": "days",
              "value": 0,
              "valueUnit": "percentage"
            },
            {
              "grain": 30,
              "grainUnit": "days",
              "value": 0,
              "valueUnit": "percentage"
            }
          ]
        }
      }
    },
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlanOrders/20000000-0000-0000-0000-000000000002/savingsPlans/30000000-0000-0000-0000-000000000002",
      "name": "30000000-0000-0000-0000-000000000002",
      "type": "microsoft.billing/billingAccounts/savingsPlanOrders/savingsPlans",
      "sku": {
        "name": "Compute_Savings_Plan"
      },
      "tags": {
        "key1": "value1",
        "key2": "value2"
      },
      "properties": {
        "billingScopeId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptions/10000000-0000-0000-0000-000000000000",
        "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
        "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-BBBB-CCC-DDD",
        "billingPlan": "P1M",
        "productCode": "20000000-0000-0000-0000-000000000005",
        "appliedScopeProperties": {
          "subscriptionId": "/subscriptions/10000000-0000-0000-0000-000000000000",
          "displayName": "Azure subscription 1"
        },
        "commitment": {
          "grain": "Hourly",
          "currencyCode": "USD",
          "amount": 0.025
        },
        "renew": true,
        "appliedScopeType": "Single",
        "displayName": "SP3",
        "provisioningState": "Succeeded",
        "term": "P3Y",
        "displayProvisioningState": "Succeeded",
        "userFriendlyAppliedScopeType": "Single",
        "expiryDateTime": "2025-10-14T21:18:55.2960613Z",
        "purchaseDateTime": "2022-10-14T21:16:57.2347688Z",
        "benefitStartTime": "2022-10-14T21:18:55.2960613Z",
        "effectiveDateTime": "2022-11-07T23:54:43.8233243Z",
        "utilization": {
          "trend": "SAME",
          "aggregates": [
            {
              "grain": 1,
              "grainUnit": "days",
              "value": 66,
              "valueUnit": "percentage"
            },
            {
              "grain": 7,
              "grainUnit": "days",
              "value": 66,
              "valueUnit": "percentage"
            },
            {
              "grain": 30,
              "grainUnit": "days",
              "value": 65.52,
              "valueUnit": "percentage"
            }
          ]
        }
      }
    },
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlanOrders/20000000-0000-0000-0000-000000000003/savingsPlans/30000000-0000-0000-0000-000000000003",
      "name": "30000000-0000-0000-0000-000000000003",
      "type": "microsoft.billing/billingAccounts/savingsPlanOrders/savingsPlans",
      "sku": {
        "name": "Compute_Savings_Plan"
      },
      "tags": {
        "key1": "value1",
        "key2": "value2"
      },
      "properties": {
        "billingScopeId": "/subscriptions/10000000-0000-0000-0000-000000000000",
        "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
        "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-BBBB-CCC-DDD",
        "billingPlan": "P1M",
        "productCode": "20000000-0000-0000-0000-000000000005",
        "appliedScopeProperties": {
          "resourceGroupId": "/subscriptions/10000000-0000-0000-0000-000000000000/resourcegroups/testRG",
          "displayName": "testRG"
        },
        "commitment": {
          "grain": "Hourly",
          "currencyCode": "USD",
          "amount": 0.001
        },
        "renew": false,
        "appliedScopeType": "Single",
        "displayName": "SP4",
        "provisioningState": "Succeeded",
        "term": "P3Y",
        "displayProvisioningState": "Succeeded",
        "userFriendlyAppliedScopeType": "ResourceGroup",
        "expiryDateTime": "2025-11-08T00:00:06.3636747Z",
        "purchaseDateTime": "2022-11-07T23:57:58.2428677Z",
        "benefitStartTime": "2022-11-08T00:00:06.3636747Z",
        "effectiveDateTime": "2022-11-30T21:18:12.1967323Z",
        "utilization": {
          "trend": "SAME",
          "aggregates": [
            {
              "grain": 1,
              "grainUnit": "days",
              "value": 100,
              "valueUnit": "percentage"
            },
            {
              "grain": 7,
              "grainUnit": "days",
              "value": 100,
              "valueUnit": "percentage"
            },
            {
              "grain": 30,
              "grainUnit": "days",
              "value": 100,
              "valueUnit": "percentage"
            }
          ]
        }
      }
    }
  ],
  "summary": {
    "noBenefitCount": 0,
    "warningCount": 0,
    "succeededCount": 3,
    "failedCount": 0,
    "expiringCount": 0,
    "expiredCount": 0,
    "pendingCount": 0,
    "cancelledCount": 0,
    "processingCount": 0
  }
}

定義

名前	説明
AppliedScopeProperties	適用されたスコープの種類に固有のプロパティ。該当しない場合は必須ではありません。
AppliedScopeType	適用されたスコープの種類。
BillingPlan	ISO 8601 形式の課金プランを表します。毎月の購入にのみ必要です。
Commitment	特典に対するコミットメント。
CommitmentGrain	コミットメントグレイン。
createdByType	リソースを作成した ID の種類。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
ExtendedStatusInfo	拡張状態情報
ProvisioningState	プロビジョニングの状態
PurchaseRequest	購入要求。
RenewProperties	更新に固有のプロパティ。
SavingsPlanModel	節約プラン
SavingsPlanModelListResult	節約計画の一覧
SavingsPlanSummaryCount	各状態の節約計画のロールアップ数の概要
SavingsPlanTerm	ISO 8601 形式の Savings プランの用語を表します。
Sku	このリソースに適用される SKU
systemData	リソースの作成と最後の変更に関連するメタデータ。
Utilization	節約プランの使用率
UtilizationAggregates	節約計画の使用率の集計値

AppliedScopeProperties

Object

適用されたスコープの種類に固有のプロパティ。該当しない場合は必須ではありません。

名前	型	説明
displayName	string	表示名
managementGroupId	string	特典が適用される管理グループの完全修飾識別子。
resourceGroupId	string	特典が適用されるリソースグループの完全修飾識別子。
subscriptionId	string	特典が適用されるサブスクリプションの完全修飾識別子。
tenantId	string	特典が適用される節約計画のテナント ID。

AppliedScopeType

列挙

適用されたスコープの種類。

値	説明
ManagementGroup
Shared
Single

BillingPlan

列挙

ISO 8601 形式の課金プランを表します。毎月の購入にのみ必要です。

値	説明
P1M

Commitment

Object

特典に対するコミットメント。

名前	型	説明
amount	number (double)
currencyCode	string	この購入レコードで使用される通貨の ISO 4217 3 文字の通貨コード。
grain	CommitmentGrain	コミットメントグレイン。

CommitmentGrain

列挙

コミットメントグレイン。

値	説明
Hourly

createdByType

列挙

リソースを作成した ID の種類。

値	説明
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラーメッセージ。
target	string	エラーターゲット。

ErrorResponse

Object

エラー応答

名前	型	説明
error	ErrorDetail	エラーオブジェクト。

ExtendedStatusInfo

Object

拡張状態情報

名前	型	説明
message	string	状態コードに関する詳細情報を示すメッセージ。
properties.subscriptionId	string	与信ラインチェックに失敗したサブスクリプション。
statusCode	string	追加情報を提供する状態コード。

ProvisioningState

列挙

プロビジョニングの状態

値	説明
Canceled
ConfirmedBilling
Created
Creating
Expired
Failed
PendingBilling
Succeeded

PurchaseRequest

Object

購入要求。

名前	型	規定値	説明
properties.appliedScopeProperties	AppliedScopeProperties		適用されたスコープの種類に固有のプロパティ。該当しない場合は必須ではありません。
properties.appliedScopeType	AppliedScopeType		適用されたスコープの種類。
properties.billingPlan	BillingPlan		ISO 8601 形式の課金プランを表します。毎月の購入にのみ必要です。
properties.billingScopeId	string		SavingsPlan の購入に対して課金されるサブスクリプション
properties.commitment	Commitment		特典に対するコミットメント。
properties.displayName	string		節約計画のフレンドリ名
properties.renew	boolean	False	これを true に設定すると、有効期限の日時に新しい特典が自動的に購入されます。
properties.term	SavingsPlanTerm		ISO 8601 形式の Savings プランの用語を表します。
sku	Sku		このリソースに適用される SKU

RenewProperties

Object

更新に固有のプロパティ。

名前	型	説明
purchaseProperties	PurchaseRequest	購入要求。

SavingsPlanModel

Object

節約プラン

名前	型	規定値	説明
id	string (arm-id)		リソースの完全修飾リソース ID。例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string		リソースの名前
properties.appliedScopeProperties	AppliedScopeProperties		適用されたスコープの種類に固有のプロパティ。該当しない場合は必須ではありません。
properties.appliedScopeType	AppliedScopeType		適用されたスコープの種類。
properties.benefitStartTime	string (date-time)		これは、節約計画の特典が開始されたときの DateTime です。
properties.billingAccountId	string		節約プランが適用される課金アカウントの完全修飾識別子。
properties.billingPlan	BillingPlan		ISO 8601 形式の課金プランを表します。毎月の購入にのみ必要です。
properties.billingProfileId	string		節約プランが適用される課金プロファイルの完全修飾識別子。フィールド主導または顧客主導のお客様にのみ表示されます。
properties.billingScopeId	string		SavingsPlan の購入に対して課金されるサブスクリプション
properties.commitment	Commitment		特典に対するコミットメント。
properties.customerId	string		節約プランが適用される顧客の完全修飾識別子。パートナー主導のお客様にのみ表示されます。
properties.displayName	string		表示名
properties.displayProvisioningState	string		表示用の節約計画のプロビジョニング状態 (成功など)
properties.effectiveDateTime	string (date-time)		このバージョンが有効になったときから始まる節約計画の DateTime。
properties.expiryDateTime	string (date-time)		これは、節約プランの有効期限が切れる日時です。
properties.extendedStatusInfo	ExtendedStatusInfo		拡張状態情報
properties.productCode	string		UPN を表します
properties.provisioningState	ProvisioningState		プロビジョニングの状態
properties.purchaseDateTime	string (date-time)		節約計画が購入された日時。
properties.renew	boolean	False	これを true に設定すると、有効期限の日時に新しい特典が自動的に購入されます。
properties.renewDestination	string		更新のために購入された SavingsPlan の SavingsPlan ID。
properties.renewProperties	RenewProperties		更新に固有のプロパティ。
properties.renewSource	string		この SavingsPlan の更新元となる SavingsPlan の SavingsPlan ID。
properties.term	SavingsPlanTerm		ISO 8601 形式の Savings プランの用語を表します。
properties.userFriendlyAppliedScopeType	string		表示する節約計画の適用スコープの種類 (共有など)
properties.utilization	Utilization		節約プランの使用率
sku	Sku		節約プラン SKU
systemData	systemData		createdBy と modifiedBy 情報を含む Azure Resource Manager メタデータ。
tags	object		リソースに関連付けられているメタデータのディクショナリ。リソースの種類によっては設定されない場合があります。キー/値の最大長は 256 文字でサポートされます。キー/値は、値を空にしたり、null にしたりしないでください。キーは <> % &\ を含むできませんか? /
type	string		リソースの種類。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

SavingsPlanModelListResult

Object

節約計画の一覧

名前	型	説明
nextLink	string	次のページを取得する URL。
summary	SavingsPlanSummaryCount	節約計画のロールアウトカウントの概要
value	SavingsPlanModel[]	節約プラン

SavingsPlanSummaryCount

Object

各状態の節約計画のロールアップ数の概要

名前	型	説明
cancelledCount	number	取り消された状態の節約計画の数
expiredCount	number	有効期限が切れた状態の節約プランの数
expiringCount	number	有効期限が切れている状態の節約プランの数
failedCount	number	失敗状態の節約プランの数
noBenefitCount	number	特典なし状態の節約計画の数
pendingCount	number	保留中の状態の節約プランの数
processingCount	number	処理状態の節約プランの数
succeededCount	number	成功状態の節約プランの数
warningCount	number	警告状態の節約計画の数

SavingsPlanTerm

列挙

ISO 8601 形式の Savings プランの用語を表します。

値	説明
P1Y
P3Y
P5Y

Sku

Object

このリソースに適用される SKU

名前	型	説明
name	string	適用する SKU の名前

systemData

Object

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string (date-time)	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string (date-time)	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

Utilization

Object

節約プランの使用率

名前	型	説明
aggregates	UtilizationAggregates[]	節約計画の使用率の集計の配列
trend	string	節約計画の使用率の傾向

UtilizationAggregates

Object

節約計画の使用率の集計値

名前	型	説明
grain	number	集計のグレイン
grainUnit	string	集計のグレイン単位
value	number	集計値
valueUnit	string	集計値の単位