Savings Plans - Get By Billing Account

Dienst:

Billing

API-Version:

2024-04-01

Erhalten Sie Einen Sparplan nach Abrechnungskonto.

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

Mit optionalen Parametern:

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
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})?)$	Die ID, die ein Abrechnungskonto eindeutig identifiziert.
savingsPlanId	path	True	string	ID des Sparplans
savingsPlanOrderId	path	True	string	Auftrags-ID des Sparplans
api-version	query	True	string	Die Version der API, die mit der Clientanforderung verwendet werden soll. Die aktuelle Version ist 2024-04-01.
expand	query		string	Kann verwendet werden, um die planInformation zu erweitern.

Antworten

Name	Typ	Beschreibung
200 OK	SavingsPlanModel	Die Anforderung ist abgeschlossen.
Other Status Codes	ErrorResponse	Unerwarteter Fehler.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

SavingsPlanGet

SavingsPlanGetExpandRenewProperties

SavingsPlanGet

Beispielanforderung

HTTP

GET https://management.azure.com/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?api-version=2024-04-01

Java

/**
 * Samples for SavingsPlans GetByBillingAccount.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/
     * savingsPlanGetByBillingAccount.json
     */
    /**
     * Sample code: SavingsPlanGet.
     * 
     * @param manager Entry point to BillingManager.
     */
    public static void savingsPlanGet(com.azure.resourcemanager.billing.BillingManager manager) {
        manager.savingsPlans().getByBillingAccountWithResponse(
            "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
            "20000000-0000-0000-0000-000000000000", "30000000-0000-0000-0000-000000000000", null,
            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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.billing import BillingManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-billing
# USAGE
    python savings_plan_get_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.get_by_billing_account(
        billing_account_name="00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
        savings_plan_order_id="20000000-0000-0000-0000-000000000000",
        savings_plan_id="30000000-0000-0000-0000-000000000000",
    )
    print(response)


# x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/savingsPlanGetByBillingAccount.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

Go

package armbilling_test

import (
	"context"
	"log"

	"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/savingsPlanGetByBillingAccount.json
func ExampleSavingsPlansClient_GetByBillingAccount_savingsPlanGet() {
	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)
	}
	res, err := clientFactory.NewSavingsPlansClient().GetByBillingAccount(ctx, "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", "20000000-0000-0000-0000-000000000000", "30000000-0000-0000-0000-000000000000", &armbilling.SavingsPlansClientGetByBillingAccountOptions{Expand: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.SavingsPlanModel = 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{
	// 		AppliedScopeProperties: &armbilling.AppliedScopeProperties{
	// 			DisplayName: to.Ptr("TestRg"),
	// 			ManagementGroupID: to.Ptr("/providers/Microsoft.Management/managementGroups/TestRg"),
	// 			TenantID: to.Ptr("70000000-0000-0000-0000-000000000000"),
	// 		},
	// 		AppliedScopeType: to.Ptr(armbilling.AppliedScopeTypeManagementGroup),
	// 		BenefitStartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-16T02:25:11.718Z"); 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/50000000-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("SP1"),
	// 		DisplayProvisioningState: to.Ptr("NoBenefit"),
	// 		EffectiveDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-12-16T01:35:36.290Z"); return t}()),
	// 		ExpiryDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2025-11-16T02:25:11.718Z"); 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-16T02:23:21.386Z"); return t}()),
	// 		Renew: to.Ptr(false),
	// 		Term: to.Ptr(armbilling.SavingsPlanTermP3Y),
	// 		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"),
	// 	},
	// }
}

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

JavaScript

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

/**
 * This sample demonstrates how to Get savings plan by billing account.
 *
 * @summary Get savings plan by billing account.
 * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/savingsPlanGetByBillingAccount.json
 */
async function savingsPlanGet() {
  const billingAccountName =
    "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31";
  const savingsPlanOrderId = "20000000-0000-0000-0000-000000000000";
  const savingsPlanId = "30000000-0000-0000-0000-000000000000";
  const credential = new DefaultAzureCredential();
  const client = new BillingManagementClient(credential);
  const result = await client.savingsPlans.getByBillingAccount(
    billingAccountName,
    savingsPlanOrderId,
    savingsPlanId,
  );
  console.log(result);
}

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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Billing;

// Generated from example definition: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/savingsPlanGetByBillingAccount.json
// this example is just showing the usage of "SavingsPlans_GetByBillingAccount" 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 SavingsPlanOrderModelResource created on azure
// for more information of creating SavingsPlanOrderModelResource, please refer to the document of SavingsPlanOrderModelResource
string billingAccountName = "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31";
string savingsPlanOrderId = "20000000-0000-0000-0000-000000000000";
ResourceIdentifier savingsPlanOrderModelResourceId = SavingsPlanOrderModelResource.CreateResourceIdentifier(billingAccountName, savingsPlanOrderId);
SavingsPlanOrderModelResource savingsPlanOrderModel = client.GetSavingsPlanOrderModelResource(savingsPlanOrderModelResourceId);

// get the collection of this BillingSavingsPlanModelResource
BillingSavingsPlanModelCollection collection = savingsPlanOrderModel.GetBillingSavingsPlanModels();

// invoke the operation
string savingsPlanId = "30000000-0000-0000-0000-000000000000";
NullableResponse<BillingSavingsPlanModelResource> response = await collection.GetIfExistsAsync(savingsPlanId);
BillingSavingsPlanModelResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine("Succeeded with null as result");
}
else
{
    // the variable result 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 = result.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

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

Beispiel für eine Antwort

Statuscode:

200

{
  "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/50000000-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": "70000000-0000-0000-0000-000000000000",
      "managementGroupId": "/providers/Microsoft.Management/managementGroups/TestRg",
      "displayName": "TestRg"
    },
    "commitment": {
      "grain": "Hourly",
      "currencyCode": "USD",
      "amount": 0.001
    },
    "renew": false,
    "appliedScopeType": "ManagementGroup",
    "displayName": "SP1",
    "provisioningState": "Succeeded",
    "term": "P3Y",
    "displayProvisioningState": "NoBenefit",
    "userFriendlyAppliedScopeType": "ManagementGroup",
    "expiryDateTime": "2025-11-16T02:25:11.7183866Z",
    "purchaseDateTime": "2022-11-16T02:23:21.3864783Z",
    "benefitStartTime": "2022-11-16T02:25:11.7183866Z",
    "effectiveDateTime": "2022-12-16T01:35:36.2909462Z",
    "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"
        }
      ]
    }
  }
}

SavingsPlanGetExpandRenewProperties

Beispielanforderung

HTTP

GET https://management.azure.com/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?api-version=2024-04-01

Java

/**
 * Samples for SavingsPlans GetByBillingAccount.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/
     * savingsPlanGetExpandRenewPropertiesByBillingAccount.json
     */
    /**
     * Sample code: SavingsPlanGetExpandRenewProperties.
     * 
     * @param manager Entry point to BillingManager.
     */
    public static void savingsPlanGetExpandRenewProperties(com.azure.resourcemanager.billing.BillingManager manager) {
        manager.savingsPlans().getByBillingAccountWithResponse(
            "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
            "20000000-0000-0000-0000-000000000000", "30000000-0000-0000-0000-000000000000", null,
            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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.billing import BillingManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-billing
# USAGE
    python savings_plan_get_expand_renew_properties_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.get_by_billing_account(
        billing_account_name="00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
        savings_plan_order_id="20000000-0000-0000-0000-000000000000",
        savings_plan_id="30000000-0000-0000-0000-000000000000",
    )
    print(response)


# x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/savingsPlanGetExpandRenewPropertiesByBillingAccount.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

Go

package armbilling_test

import (
	"context"
	"log"

	"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/savingsPlanGetExpandRenewPropertiesByBillingAccount.json
func ExampleSavingsPlansClient_GetByBillingAccount_savingsPlanGetExpandRenewProperties() {
	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)
	}
	res, err := clientFactory.NewSavingsPlansClient().GetByBillingAccount(ctx, "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", "20000000-0000-0000-0000-000000000000", "30000000-0000-0000-0000-000000000000", &armbilling.SavingsPlansClientGetByBillingAccountOptions{Expand: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.SavingsPlanModel = 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{
	// 		AppliedScopeProperties: &armbilling.AppliedScopeProperties{
	// 			DisplayName: to.Ptr("TestRg"),
	// 			ManagementGroupID: to.Ptr("/providers/Microsoft.Management/managementGroups/TestRg"),
	// 			TenantID: to.Ptr("70000000-0000-0000-0000-000000000000"),
	// 		},
	// 		AppliedScopeType: to.Ptr(armbilling.AppliedScopeTypeManagementGroup),
	// 		BenefitStartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-16T02:25:11.718Z"); 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/50000000-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("SP1"),
	// 		DisplayProvisioningState: to.Ptr("NoBenefit"),
	// 		EffectiveDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-12-16T01:35:36.290Z"); return t}()),
	// 		ExpiryDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2025-11-16T02:25:11.718Z"); 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-16T02:23:21.386Z"); return t}()),
	// 		Renew: to.Ptr(false),
	// 		RenewProperties: &armbilling.RenewProperties{
	// 			PurchaseProperties: &armbilling.PurchaseRequest{
	// 				Properties: &armbilling.PurchaseRequestProperties{
	// 					AppliedScopeProperties: &armbilling.AppliedScopeProperties{
	// 						ManagementGroupID: to.Ptr("/providers/Microsoft.Management/managementGroups/TestRg"),
	// 						TenantID: to.Ptr("70000000-0000-0000-0000-000000000000"),
	// 					},
	// 					AppliedScopeType: to.Ptr(armbilling.AppliedScopeTypeManagementGroup),
	// 					BillingPlan: to.Ptr(armbilling.BillingPlan("Monthly")),
	// 					BillingScopeID: to.Ptr("/subscriptions/50000000-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("SP1_renewed"),
	// 					Term: to.Ptr(armbilling.SavingsPlanTermP3Y),
	// 				},
	// 				SKU: &armbilling.SKU{
	// 					Name: to.Ptr("Compute_Savings_Plan"),
	// 				},
	// 			},
	// 		},
	// 		Term: to.Ptr(armbilling.SavingsPlanTermP3Y),
	// 		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"),
	// 	},
	// }
}

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

JavaScript

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

/**
 * This sample demonstrates how to Get savings plan by billing account.
 *
 * @summary Get savings plan by billing account.
 * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/savingsPlanGetExpandRenewPropertiesByBillingAccount.json
 */
async function savingsPlanGetExpandRenewProperties() {
  const billingAccountName =
    "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31";
  const savingsPlanOrderId = "20000000-0000-0000-0000-000000000000";
  const savingsPlanId = "30000000-0000-0000-0000-000000000000";
  const credential = new DefaultAzureCredential();
  const client = new BillingManagementClient(credential);
  const result = await client.savingsPlans.getByBillingAccount(
    billingAccountName,
    savingsPlanOrderId,
    savingsPlanId,
  );
  console.log(result);
}

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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Billing;

// Generated from example definition: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/savingsPlanGetExpandRenewPropertiesByBillingAccount.json
// this example is just showing the usage of "SavingsPlans_GetByBillingAccount" 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 SavingsPlanOrderModelResource created on azure
// for more information of creating SavingsPlanOrderModelResource, please refer to the document of SavingsPlanOrderModelResource
string billingAccountName = "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31";
string savingsPlanOrderId = "20000000-0000-0000-0000-000000000000";
ResourceIdentifier savingsPlanOrderModelResourceId = SavingsPlanOrderModelResource.CreateResourceIdentifier(billingAccountName, savingsPlanOrderId);
SavingsPlanOrderModelResource savingsPlanOrderModel = client.GetSavingsPlanOrderModelResource(savingsPlanOrderModelResourceId);

// get the collection of this BillingSavingsPlanModelResource
BillingSavingsPlanModelCollection collection = savingsPlanOrderModel.GetBillingSavingsPlanModels();

// invoke the operation
string savingsPlanId = "30000000-0000-0000-0000-000000000000";
NullableResponse<BillingSavingsPlanModelResource> response = await collection.GetIfExistsAsync(savingsPlanId);
BillingSavingsPlanModelResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine("Succeeded with null as result");
}
else
{
    // the variable result 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 = result.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

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

Beispiel für eine Antwort

Statuscode:

200

{
  "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/50000000-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": "70000000-0000-0000-0000-000000000000",
      "managementGroupId": "/providers/Microsoft.Management/managementGroups/TestRg",
      "displayName": "TestRg"
    },
    "commitment": {
      "grain": "Hourly",
      "currencyCode": "USD",
      "amount": 0.001
    },
    "renew": false,
    "appliedScopeType": "ManagementGroup",
    "displayName": "SP1",
    "provisioningState": "Succeeded",
    "term": "P3Y",
    "displayProvisioningState": "NoBenefit",
    "userFriendlyAppliedScopeType": "ManagementGroup",
    "expiryDateTime": "2025-11-16T02:25:11.7183866Z",
    "purchaseDateTime": "2022-11-16T02:23:21.3864783Z",
    "benefitStartTime": "2022-11-16T02:25:11.7183866Z",
    "effectiveDateTime": "2022-12-16T01:35:36.2909462Z",
    "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"
        }
      ]
    },
    "renewProperties": {
      "purchaseProperties": {
        "sku": {
          "name": "Compute_Savings_Plan"
        },
        "properties": {
          "billingScopeId": "/subscriptions/50000000-0000-0000-0000-000000000000",
          "term": "P3Y",
          "billingPlan": "Monthly",
          "displayName": "SP1_renewed",
          "appliedScopeType": "ManagementGroup",
          "appliedScopeProperties": {
            "tenantId": "70000000-0000-0000-0000-000000000000",
            "managementGroupId": "/providers/Microsoft.Management/managementGroups/TestRg"
          },
          "commitment": {
            "grain": "Hourly",
            "currencyCode": "USD",
            "amount": 0.001
          }
        }
      }
    }
  }
}

Definitionen

Name	Beschreibung
AppliedScopeProperties	Eigenschaften, die für den angewendeten Bereichstyp spezifisch sind. Nicht erforderlich, falls nicht zutreffend.
AppliedScopeType	Typ des angewendeten Bereichs.
BillingPlan	Stellt den Abrechnungsplan im ISO 8601-Format dar. Nur für monatliche Einkäufe erforderlich.
Commitment	Verpflichtung zum Nutzen.
CommitmentGrain	Bekenntniskorn.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
ExtendedStatusInfo	Erweiterte Statusinformationen
ProvisioningState	Bereitstellungsstatus
PurchaseRequest	Kaufanfrage.
RenewProperties	Eigenschaften, die für die Verlängerung spezifisch sind.
SavingsPlanModel	Sparplan
SavingsPlanTerm	Represents the Savings plan term in ISO 8601 format.
Sku	Die SKU, die für diese Ressource angewendet werden soll
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
Utilization	Nutzung des Sparplans
UtilizationAggregates	Die Aggregatwerte der Nutzung des Sparplans

AppliedScopeProperties

Objekt

Eigenschaften, die für den angewendeten Bereichstyp spezifisch sind. Nicht erforderlich, falls nicht zutreffend.

Name	Typ	Beschreibung
displayName	string	Anzeigename
managementGroupId	string	Vollqualifizierter Bezeichner der Verwaltungsgruppe, in der der Vorteil angewendet wird.
resourceGroupId	string	Vollqualifizierter Bezeichner der Ressourcengruppe, auf die der Vorteil angewendet wird.
subscriptionId	string	Vollqualifizierter Bezeichner des Abonnements, in dem der Vorteil angewendet wird.
tenantId	string	Mandanten-ID, bei der der Sparplan angewendet wird.

AppliedScopeType

Enumeration

Typ des angewendeten Bereichs.

Wert	Beschreibung
ManagementGroup
Shared
Single

BillingPlan

Enumeration

Stellt den Abrechnungsplan im ISO 8601-Format dar. Nur für monatliche Einkäufe erforderlich.

Wert	Beschreibung
P1M

Commitment

Objekt

Verpflichtung zum Nutzen.

Name	Typ	Beschreibung
amount	number (double)
currencyCode	string	Der ISO 4217-3-Buchstaben-Währungscode für die währung, die von diesem Einkaufsdatensatz verwendet wird.
grain	CommitmentGrain	Bekenntniskorn.

CommitmentGrain

Enumeration

Bekenntniskorn.

Wert	Beschreibung
Hourly

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

ExtendedStatusInfo

Objekt

Erweiterte Statusinformationen

Name	Typ	Beschreibung
message	string	Die Meldung, die detaillierte Informationen zum Statuscode enthält.
properties.subscriptionId	string	Das Abonnement, bei dem die Kreditlinienüberprüfung fehlgeschlagen ist.
statusCode	string	Statuscode, der zusätzliche Informationen bereitstellt.

ProvisioningState

Enumeration

Bereitstellungsstatus

Wert	Beschreibung
Canceled
ConfirmedBilling
Created
Creating
Expired
Failed
PendingBilling
Succeeded

PurchaseRequest

Objekt

Kaufanfrage.

Name	Typ	Standardwert	Beschreibung
properties.appliedScopeProperties	AppliedScopeProperties		Eigenschaften, die für den angewendeten Bereichstyp spezifisch sind. Nicht erforderlich, falls nicht zutreffend.
properties.appliedScopeType	AppliedScopeType		Typ des angewendeten Bereichs.
properties.billingPlan	BillingPlan		Stellt den Abrechnungsplan im ISO 8601-Format dar. Nur für monatliche Einkäufe erforderlich.
properties.billingScopeId	string		Abonnement, das für den Kauf von SavingsPlan in Rechnung gestellt wird
properties.commitment	Commitment		Verpflichtung zum Nutzen.
properties.displayName	string		Anzeigename des Sparplans
properties.renew	boolean	False	Wenn Sie diesen Wert auf "true" festlegen, wird automatisch ein neuer Vorteil für die Ablaufdatumszeit erworben.
properties.term	SavingsPlanTerm		Represents the Savings plan term in ISO 8601 format.
sku	Sku		Die SKU, die für diese Ressource angewendet werden soll

RenewProperties

Objekt

Eigenschaften, die für die Verlängerung spezifisch sind.

Name	Typ	Beschreibung
purchaseProperties	PurchaseRequest	Kaufanfrage.

SavingsPlanModel

Objekt

Sparplan

Name	Typ	Standardwert	Beschreibung
id	string (arm-id)		Vollqualifizierte Ressourcen-ID für die Ressource. Z. B. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string		Der Name der Ressource
properties.appliedScopeProperties	AppliedScopeProperties		Eigenschaften, die für den angewendeten Bereichstyp spezifisch sind. Nicht erforderlich, falls nicht zutreffend.
properties.appliedScopeType	AppliedScopeType		Typ des angewendeten Bereichs.
properties.benefitStartTime	string (date-time)		Dies ist dateTime, wenn der Sparplanvorteil beginnt.
properties.billingAccountId	string		Vollqualifizierter Bezeichner des Abrechnungskontos, auf das der Sparplan angewendet wird.
properties.billingPlan	BillingPlan		Stellt den Abrechnungsplan im ISO 8601-Format dar. Nur für monatliche Einkäufe erforderlich.
properties.billingProfileId	string		Vollqualifizierter Bezeichner des Abrechnungsprofils, in dem der Sparplan angewendet wird. Nur für kundengeführte Kunden mit Feldführung oder Kunden vorhanden.
properties.billingScopeId	string		Abonnement, das für den Kauf von SavingsPlan in Rechnung gestellt wird
properties.commitment	Commitment		Verpflichtung zum Nutzen.
properties.customerId	string		Vollqualifizierter Bezeichner des Kunden, auf den der Sparplan angewendet wird. Nur für partnergeführte Kunden vorhanden.
properties.displayName	string		Anzeigename
properties.displayProvisioningState	string		Der Bereitstellungsstatus des Sparplans für die Anzeige, z. B. erfolgreich
properties.effectiveDateTime	string (date-time)		DateTime des Sparplans ab dem Zeitpunkt, an dem diese Version wirksam ist.
properties.expiryDateTime	string (date-time)		Dies ist der Zeitpunkt, zu dem der Sparplan abläuft.
properties.extendedStatusInfo	ExtendedStatusInfo		Erweiterte Statusinformationen
properties.productCode	string		Represents UPN
properties.provisioningState	ProvisioningState		Bereitstellungsstatus
properties.purchaseDateTime	string (date-time)		Datum, zu dem der Sparplan erworben wurde.
properties.renew	boolean	False	Wenn Sie diesen Wert auf "true" festlegen, wird automatisch ein neuer Vorteil für die Ablaufdatumszeit erworben.
properties.renewDestination	string		SavingsPlan ID des Sparplans, der aufgrund der Verlängerung erworben wird.
properties.renewProperties	RenewProperties		Eigenschaften, die für die Verlängerung spezifisch sind.
properties.renewSource	string		SavingsPlan ID des Sparplans, aus dem dieser Sparplan erneuert wird.
properties.term	SavingsPlanTerm		Represents the Savings plan term in ISO 8601 format.
properties.userFriendlyAppliedScopeType	string		Der angewendete Bereichstyp des Sparplans für die Anzeige, z. B. Freigegeben
properties.utilization	Utilization		Nutzung des Sparplans
sku	Sku		Sparplan-SKU
systemData	systemData		Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten.
tags	object		Wörterbuch der Metadaten, die der Ressource zugeordnet sind. Möglicherweise wird sie nicht für alle Ressourcentypen aufgefüllt. Maximale Schlüssel-/Wertlänge unterstützt von 256 Zeichen. Schlüssel/Wert dürfen keinen leeren Wert oder null sein. Schlüssel können nicht <> % & \ enthalten? /
type	string		Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

SavingsPlanTerm

Enumeration

Represents the Savings plan term in ISO 8601 format.

Wert	Beschreibung
P1Y
P3Y
P5Y

Sku

Objekt

Die SKU, die für diese Ressource angewendet werden soll

Name	Typ	Beschreibung
name	string	Name der anzuwendenden SKU

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

Utilization

Objekt

Nutzung des Sparplans

Name	Typ	Beschreibung
aggregates	UtilizationAggregates[]	Das Array von Aggregaten der Nutzung eines Sparplans
trend	string	Der Trend für die Nutzung eines Sparplans

UtilizationAggregates

Objekt

Die Aggregatwerte der Nutzung des Sparplans

Name	Typ	Beschreibung
grain	number	Das Korn des Aggregats
grainUnit	string	Die Korneinheit des Aggregats
value	number	Der Aggregatwert
valueUnit	string	Die Aggregatwerteinheit