Savings Plans - Get By Billing Account

Serviço:

Billing

Versão da API:

2024-04-01

Obtenha o plano de poupança por conta de cobrança.

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

Com parâmetros opcionais:

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
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})?)$	A ID que identifica exclusivamente uma conta de cobrança.
savingsPlanId	path	True	string	ID do plano de poupança
savingsPlanOrderId	path	True	string	ID do pedido do plano de poupança
api-version	query	True	string	A versão da API a ser usada com a solicitação do cliente. A versão atual é 2024-04-01.
expand	query		string	Pode ser usado para expandir o planInformation.

Respostas

Nome	Tipo	Description
200 OK	SavingsPlanModel	A solicitação foi concluída.
Other Status Codes	ErrorResponse	Erro inesperado.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

SavingsPlanGet

SavingsPlanGetExpandRenewProperties

SavingsPlanGet

Solicitação de exemplo

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

Resposta de exemplo

Código de status:

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

Solicitação de exemplo

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

Resposta de exemplo

Código de status:

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
          }
        }
      }
    }
  }
}

Definições

Nome	Description
AppliedScopeProperties	Propriedades específicas para o tipo de escopo aplicado. Não é necessário se não for aplicável.
AppliedScopeType	Tipo do Escopo Aplicado.
BillingPlan	Representa o plano de cobrança no formato ISO 8601. Necessário apenas para compras mensais.
Commitment	Compromisso com o benefício.
CommitmentGrain	Grãos de compromisso.
createdByType	O tipo de identidade que criou o recurso.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
ExtendedStatusInfo	Informações de status estendido
ProvisioningState	Estado de provisionamento
PurchaseRequest	Solicitação de compra.
RenewProperties	Propriedades específicas para renovação.
SavingsPlanModel	Plano de poupança
SavingsPlanTerm	Representa o termo do plano de poupança no formato ISO 8601.
Sku	A SKU a ser aplicada a esse recurso
systemData	Metadados relativos à criação e última modificação do recurso.
Utilization	Utilização do plano de poupança
UtilizationAggregates	Os valores agregados da utilização do plano de poupança

AppliedScopeProperties

Objeto

Propriedades específicas para o tipo de escopo aplicado. Não é necessário se não for aplicável.

Nome	Tipo	Description
displayName	string	Nome de exibição
managementGroupId	string	Identificador totalmente qualificado do grupo de gerenciamento em que o benefício é aplicado.
resourceGroupId	string	Identificador totalmente qualificado do grupo de recursos em que o benefício é aplicado.
subscriptionId	string	Identificador totalmente qualificado da assinatura em que o benefício é aplicado.
tenantId	string	ID do locatário em que o plano de poupança onde o benefício é aplicado.

AppliedScopeType

Enumeração

Tipo do Escopo Aplicado.

Valor	Description
ManagementGroup
Shared
Single

BillingPlan

Enumeração

Representa o plano de cobrança no formato ISO 8601. Necessário apenas para compras mensais.

Valor	Description
P1M

Commitment

Objeto

Compromisso com o benefício.

Nome	Tipo	Description
amount	number (double)
currencyCode	string	O código de moeda iso 4217 de 3 letras para a moeda usada por este registro de compra.
grain	CommitmentGrain	Grãos de compromisso.

CommitmentGrain

Enumeração

Grãos de compromisso.

Valor	Description
Hourly

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

ExtendedStatusInfo

Objeto

Informações de status estendido

Nome	Tipo	Description
message	string	A mensagem que dá informações detalhadas sobre o código de status.
properties.subscriptionId	string	A assinatura que falhou na verificação de linha de crédito.
statusCode	string	Código de status fornecendo informações adicionais.

ProvisioningState

Enumeração

Estado de provisionamento

Valor	Description
Canceled
ConfirmedBilling
Created
Creating
Expired
Failed
PendingBilling
Succeeded

PurchaseRequest

Objeto

Solicitação de compra.

Nome	Tipo	Valor padrão	Description
properties.appliedScopeProperties	AppliedScopeProperties		Propriedades específicas para o tipo de escopo aplicado. Não é necessário se não for aplicável.
properties.appliedScopeType	AppliedScopeType		Tipo do Escopo Aplicado.
properties.billingPlan	BillingPlan		Representa o plano de cobrança no formato ISO 8601. Necessário apenas para compras mensais.
properties.billingScopeId	string		Assinatura que será cobrada pela compra da SavingsPlan
properties.commitment	Commitment		Compromisso com o benefício.
properties.displayName	string		Nome amigável do plano de poupança
properties.renew	boolean	False	Definir isso como true comprará automaticamente um novo benefício na hora da data de validade.
properties.term	SavingsPlanTerm		Representa o termo do plano de poupança no formato ISO 8601.
sku	Sku		A SKU a ser aplicada a esse recurso

RenewProperties

Objeto

Propriedades específicas para renovação.

Nome	Tipo	Description
purchaseProperties	PurchaseRequest	Solicitação de compra.

SavingsPlanModel

Objeto

Plano de poupança

Nome	Tipo	Valor padrão	Description
id	string (arm-id)		ID de recurso totalmente qualificada para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string		O nome do recurso
properties.appliedScopeProperties	AppliedScopeProperties		Propriedades específicas para o tipo de escopo aplicado. Não é necessário se não for aplicável.
properties.appliedScopeType	AppliedScopeType		Tipo do Escopo Aplicado.
properties.benefitStartTime	string (date-time)		Este é o DateTime quando o benefício do plano de poupança é iniciado.
properties.billingAccountId	string		Identificador totalmente qualificado da conta de cobrança em que o plano de poupança é aplicado.
properties.billingPlan	BillingPlan		Representa o plano de cobrança no formato ISO 8601. Necessário apenas para compras mensais.
properties.billingProfileId	string		Identificador totalmente qualificado do perfil de cobrança em que o plano de poupança é aplicado. Apresentar somente para clientes liderados por campo ou liderados pelo cliente.
properties.billingScopeId	string		Assinatura que será cobrada pela compra da SavingsPlan
properties.commitment	Commitment		Compromisso com o benefício.
properties.customerId	string		Identificador totalmente qualificado do cliente em que o plano de poupança é aplicado. Apresentar somente para clientes liderados por parceiros.
properties.displayName	string		Nome de exibição
properties.displayProvisioningState	string		O estado de provisionamento do plano de poupança para exibição, por exemplo, êxito
properties.effectiveDateTime	string (date-time)		DateTime do plano de economia a partir de quando essa versão é efetivada.
properties.expiryDateTime	string (date-time)		Esta é a data e hora em que o plano de poupança expirará.
properties.extendedStatusInfo	ExtendedStatusInfo		Informações de status estendido
properties.productCode	string		Representa UPN
properties.provisioningState	ProvisioningState		Estado de provisionamento
properties.purchaseDateTime	string (date-time)		Data e hora em que o plano de poupança foi comprado.
properties.renew	boolean	False	Definir isso como true comprará automaticamente um novo benefício na hora da data de validade.
properties.renewDestination	string		ID da SavingsPlan que é comprada por causa da renovação.
properties.renewProperties	RenewProperties		Propriedades específicas para renovação.
properties.renewSource	string		ID da SavingsPlan da qual este SavingsPlan é renovado.
properties.term	SavingsPlanTerm		Representa o termo do plano de poupança no formato ISO 8601.
properties.userFriendlyAppliedScopeType	string		O tipo de escopo aplicado do plano de economia para exibição, por exemplo, Compartilhado
properties.utilization	Utilization		Utilização do plano de poupança
sku	Sku		SKU do plano de poupança
systemData	systemData		Metadados do Azure Resource Manager que contêm informações createdBy e modifiedBy.
tags	object		Dicionário de metadados associados ao recurso. Ele pode não ser preenchido para todos os tipos de recursos. Comprimento máximo de chave/valor com suporte de 256 caracteres. Chaves/valor não devem esvaziar valor nem nulo. As chaves não podem conter <> % & \ ? /
type	string		O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

SavingsPlanTerm

Enumeração

Representa o termo do plano de poupança no formato ISO 8601.

Valor	Description
P1Y
P3Y
P5Y

Sku

Objeto

A SKU a ser aplicada a esse recurso

Nome	Tipo	Description
name	string	Nome da SKU a ser aplicada

systemData

Objeto

Metadados relativos à criação e última modificação do recurso.

Nome	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

Utilization

Objeto

Utilização do plano de poupança

Nome	Tipo	Description
aggregates	UtilizationAggregates[]	A matriz de agregações da utilização de um plano de poupança
trend	string	A tendência de utilização de um plano de poupança

UtilizationAggregates

Objeto

Os valores agregados da utilização do plano de poupança

Nome	Tipo	Description
grain	number	O grão da agregação
grainUnit	string	A unidade de grãos da agregação
value	number	O valor agregado
valueUnit	string	A unidade de valor agregado