Savings Plan - Get

Référence

Service:: Billing Benefits

Version d'API:: 2022-11-01

Bénéficiez d’un plan d’épargne.

GET https://management.azure.com/providers/Microsoft.BillingBenefits/savingsPlanOrders/{savingsPlanOrderId}/savingsPlans/{savingsPlanId}?api-version=2022-11-01

Avec des paramètres facultatifs:

GET https://management.azure.com/providers/Microsoft.BillingBenefits/savingsPlanOrders/{savingsPlanOrderId}/savingsPlans/{savingsPlanId}?api-version=2022-11-01&$expand={$expand}

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
savingsPlanId	path	True	string	ID du plan d’épargne
savingsPlanOrderId	path	True	string	ID de commande du plan d’épargne
api-version	query	True	string	Version api à utiliser par le service
$expand	query		string	Peut être utilisé pour développer les informations détaillées de certaines propriétés.

Réponses

Nom	Type	Description
200 OK	SavingsPlanModel	La demande est terminée.
Other Status Codes	ErrorResponse	Erreur inattendue.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

SavingsPlanItemGet

SavingsPlanItemWithExpandedRenewPropertiesGet

SavingsPlanItemGet

Exemple de requête

GET https://management.azure.com/providers/Microsoft.BillingBenefits/savingsPlanOrders/20000000-0000-0000-0000-000000000000/savingsPlans/30000000-0000-0000-0000-000000000000?api-version=2022-11-01


/**
 * Samples for SavingsPlan Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/billingbenefits/resource-manager/Microsoft.BillingBenefits/stable/2022-11-01/examples/
     * SavingsPlanItemGet.json
     */
    /**
     * Sample code: SavingsPlanItemGet.
     * 
     * @param manager Entry point to BillingBenefitsManager.
     */
    public static void savingsPlanItemGet(com.azure.resourcemanager.billingbenefits.BillingBenefitsManager manager) {
        manager.savingsPlans().getWithResponse("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

from azure.identity import DefaultAzureCredential
from azure.mgmt.billingbenefits import BillingBenefitsRP

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-billingbenefits
# USAGE
    python savings_plan_item_get.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 = BillingBenefitsRP(
        credential=DefaultAzureCredential(),
    )

    response = client.savings_plan.get(
        savings_plan_order_id="20000000-0000-0000-0000-000000000000",
        savings_plan_id="30000000-0000-0000-0000-000000000000",
    )
    print(response)


# x-ms-original-file: specification/billingbenefits/resource-manager/Microsoft.BillingBenefits/stable/2022-11-01/examples/SavingsPlanItemGet.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 armbillingbenefits_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/billingbenefits/armbillingbenefits/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f790e624d0d080b89d962a3bd19c65bc6a6b2f5e/specification/billingbenefits/resource-manager/Microsoft.BillingBenefits/stable/2022-11-01/examples/SavingsPlanItemGet.json
func ExampleSavingsPlanClient_Get_savingsPlanItemGet() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armbillingbenefits.NewClientFactory(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewSavingsPlanClient().Get(ctx, "20000000-0000-0000-0000-000000000000", "30000000-0000-0000-0000-000000000000", &armbillingbenefits.SavingsPlanClientGetOptions{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 = armbillingbenefits.SavingsPlanModel{
	// 	Name: to.Ptr("20000000-0000-0000-0000-000000000000/30000000-0000-0000-0000-000000000000"),
	// 	Type: to.Ptr("Microsoft.BillingBenefits/savingsPlanOrders/savingsPlans"),
	// 	ID: to.Ptr("/providers/microsoft.billingbenefits/savingsPlanOrders/20000000-0000-0000-0000-000000000000/savingsPlans/30000000-0000-0000-0000-000000000000"),
	// 	Properties: &armbillingbenefits.SavingsPlanModelProperties{
	// 		AppliedScopeType: to.Ptr(armbillingbenefits.AppliedScopeTypeShared),
	// 		BillingAccountID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/20000000-1000-0000-0000-000000000000:20000000-0000-3000-0000-000000000000_2019-05-31"),
	// 		BillingPlan: to.Ptr(armbillingbenefits.BillingPlanP1M),
	// 		BillingProfileID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/20000000-1000-0000-0000-000000000000:20000000-0000-3000-0000-000000000000_2019-05-31/billingProfiles/KPSV-DWNE-BG7-TGB"),
	// 		BillingScopeID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/20000000-1000-0000-0000-000000000009"),
	// 		Commitment: &armbillingbenefits.Commitment{
	// 			Amount: to.Ptr[float64](0.001),
	// 			CurrencyCode: to.Ptr("USD"),
	// 			Grain: to.Ptr(armbillingbenefits.CommitmentGrainHourly),
	// 		},
	// 		DisplayName: to.Ptr("Compute_SavingsPlan_patch_rename2"),
	// 		DisplayProvisioningState: to.Ptr("Succeeded"),
	// 		EffectiveDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-10-21T18:15:42.409Z"); return t}()),
	// 		ExpiryDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2025-10-18T21:16:13.185Z"); return t}()),
	// 		ProvisioningState: to.Ptr(armbillingbenefits.ProvisioningStateSucceeded),
	// 		PurchaseDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-10-18T21:14:26.827Z"); return t}()),
	// 		Renew: to.Ptr(true),
	// 		Term: to.Ptr(armbillingbenefits.TermP3Y),
	// 		UserFriendlyAppliedScopeType: to.Ptr("Shared"),
	// 		Utilization: &armbillingbenefits.Utilization{
	// 			Aggregates: []*armbillingbenefits.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](84),
	// 					ValueUnit: to.Ptr("percentage"),
	// 				},
	// 				{
	// 					Grain: to.Ptr[float32](30),
	// 					GrainUnit: to.Ptr("days"),
	// 					Value: to.Ptr[float32](83.87),
	// 					ValueUnit: to.Ptr("percentage"),
	// 			}},
	// 			Trend: to.Ptr(""),
	// 		},
	// 	},
	// 	SKU: &armbillingbenefits.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

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

/**
 * This sample demonstrates how to Get savings plan.
 *
 * @summary Get savings plan.
 * x-ms-original-file: specification/billingbenefits/resource-manager/Microsoft.BillingBenefits/stable/2022-11-01/examples/SavingsPlanItemGet.json
 */
async function savingsPlanItemGet() {
  const savingsPlanOrderId = "20000000-0000-0000-0000-000000000000";
  const savingsPlanId = "30000000-0000-0000-0000-000000000000";
  const credential = new DefaultAzureCredential();
  const client = new BillingBenefitsRP(credential);
  const result = await client.savingsPlan.get(savingsPlanOrderId, savingsPlanId);
  console.log(result);
}

savingsPlanItemGet().catch(console.error);

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

Exemple de réponse

Code d’état:: 200

{
  "id": "/providers/microsoft.billingbenefits/savingsPlanOrders/20000000-0000-0000-0000-000000000000/savingsPlans/30000000-0000-0000-0000-000000000000",
  "name": "20000000-0000-0000-0000-000000000000/30000000-0000-0000-0000-000000000000",
  "type": "Microsoft.BillingBenefits/savingsPlanOrders/savingsPlans",
  "sku": {
    "name": "Compute_Savings_Plan"
  },
  "properties": {
    "billingScopeId": "/providers/Microsoft.Billing/billingAccounts/20000000-1000-0000-0000-000000000009",
    "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/20000000-1000-0000-0000-000000000000:20000000-0000-3000-0000-000000000000_2019-05-31/billingProfiles/KPSV-DWNE-BG7-TGB",
    "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/20000000-1000-0000-0000-000000000000:20000000-0000-3000-0000-000000000000_2019-05-31",
    "billingPlan": "P1M",
    "commitment": {
      "grain": "Hourly",
      "currencyCode": "USD",
      "amount": 0.001
    },
    "renew": true,
    "appliedScopeType": "Shared",
    "displayName": "Compute_SavingsPlan_patch_rename2",
    "provisioningState": "Succeeded",
    "term": "P3Y",
    "displayProvisioningState": "Succeeded",
    "userFriendlyAppliedScopeType": "Shared",
    "expiryDateTime": "2025-10-18T21:16:13.1854959Z",
    "purchaseDateTime": "2022-10-18T21:14:26.8279361Z",
    "effectiveDateTime": "2022-10-21T18:15:42.4098626Z",
    "utilization": {
      "trend": "",
      "aggregates": [
        {
          "grain": 1,
          "grainUnit": "days",
          "value": 100,
          "valueUnit": "percentage"
        },
        {
          "grain": 7,
          "grainUnit": "days",
          "value": 84,
          "valueUnit": "percentage"
        },
        {
          "grain": 30,
          "grainUnit": "days",
          "value": 83.87,
          "valueUnit": "percentage"
        }
      ]
    }
  }
}

SavingsPlanItemWithExpandedRenewPropertiesGet

Exemple de requête

GET https://management.azure.com/providers/Microsoft.BillingBenefits/savingsPlanOrders/20000000-0000-0000-0000-000000000000/savingsPlans/30000000-0000-0000-0000-000000000000?api-version=2022-11-01&$expand=renewProperties


/**
 * Samples for SavingsPlan Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/billingbenefits/resource-manager/Microsoft.BillingBenefits/stable/2022-11-01/examples/
     * SavingsPlanItemExpandedGet.json
     */
    /**
     * Sample code: SavingsPlanItemWithExpandedRenewPropertiesGet.
     * 
     * @param manager Entry point to BillingBenefitsManager.
     */
    public static void savingsPlanItemWithExpandedRenewPropertiesGet(
        com.azure.resourcemanager.billingbenefits.BillingBenefitsManager manager) {
        manager.savingsPlans().getWithResponse("20000000-0000-0000-0000-000000000000",
            "30000000-0000-0000-0000-000000000000", "renewProperties", 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.billingbenefits import BillingBenefitsRP

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-billingbenefits
# USAGE
    python savings_plan_item_expanded_get.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 = BillingBenefitsRP(
        credential=DefaultAzureCredential(),
    )

    response = client.savings_plan.get(
        savings_plan_order_id="20000000-0000-0000-0000-000000000000",
        savings_plan_id="30000000-0000-0000-0000-000000000000",
    )
    print(response)


# x-ms-original-file: specification/billingbenefits/resource-manager/Microsoft.BillingBenefits/stable/2022-11-01/examples/SavingsPlanItemExpandedGet.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 armbillingbenefits_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/billingbenefits/armbillingbenefits/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f790e624d0d080b89d962a3bd19c65bc6a6b2f5e/specification/billingbenefits/resource-manager/Microsoft.BillingBenefits/stable/2022-11-01/examples/SavingsPlanItemExpandedGet.json
func ExampleSavingsPlanClient_Get_savingsPlanItemWithExpandedRenewPropertiesGet() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armbillingbenefits.NewClientFactory(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewSavingsPlanClient().Get(ctx, "20000000-0000-0000-0000-000000000000", "30000000-0000-0000-0000-000000000000", &armbillingbenefits.SavingsPlanClientGetOptions{Expand: to.Ptr("renewProperties")})
	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 = armbillingbenefits.SavingsPlanModel{
	// 	Name: to.Ptr("20000000-0000-0000-0000-000000000000/30000000-0000-0000-0000-000000000000"),
	// 	Type: to.Ptr("Microsoft.BillingBenefits/savingsPlanOrders/savingsPlans"),
	// 	ID: to.Ptr("/providers/microsoft.billingbenefits/savingsPlanOrders/20000000-0000-0000-0000-000000000000/savingsPlans/30000000-0000-0000-0000-000000000000"),
	// 	Properties: &armbillingbenefits.SavingsPlanModelProperties{
	// 		AppliedScopeType: to.Ptr(armbillingbenefits.AppliedScopeTypeShared),
	// 		BillingAccountID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/20000000-1000-0000-0000-000000000000:20000000-0000-3000-0000-000000000000_2019-05-31"),
	// 		BillingPlan: to.Ptr(armbillingbenefits.BillingPlanP1M),
	// 		BillingProfileID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/20000000-1000-0000-0000-000000000000:20000000-0000-3000-0000-000000000000_2019-05-31/billingProfiles/KPSV-DWNE-BG7-TGB"),
	// 		BillingScopeID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/20000000-1000-0000-0000-000000000009"),
	// 		Commitment: &armbillingbenefits.Commitment{
	// 			Amount: to.Ptr[float64](0.001),
	// 			CurrencyCode: to.Ptr("USD"),
	// 			Grain: to.Ptr(armbillingbenefits.CommitmentGrainHourly),
	// 		},
	// 		DisplayName: to.Ptr("Compute_SavingsPlan_patch_rename2"),
	// 		DisplayProvisioningState: to.Ptr("Succeeded"),
	// 		EffectiveDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-10-21T18:15:42.409Z"); return t}()),
	// 		ExpiryDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2025-10-18T21:16:13.185Z"); return t}()),
	// 		ProvisioningState: to.Ptr(armbillingbenefits.ProvisioningStateSucceeded),
	// 		PurchaseDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-10-18T21:14:26.827Z"); return t}()),
	// 		Renew: to.Ptr(true),
	// 		RenewProperties: &armbillingbenefits.RenewProperties{
	// 			PurchaseProperties: &armbillingbenefits.PurchaseRequest{
	// 				Properties: &armbillingbenefits.PurchaseRequestProperties{
	// 					AppliedScopeType: to.Ptr(armbillingbenefits.AppliedScopeTypeShared),
	// 					BillingPlan: to.Ptr(armbillingbenefits.BillingPlan("Upfront")),
	// 					BillingScopeID: to.Ptr("/subscriptions/eef82110-c91b-4395-9420-fcfcbefc5a47"),
	// 					Commitment: &armbillingbenefits.Commitment{
	// 						Amount: to.Ptr[float64](0.001),
	// 						CurrencyCode: to.Ptr("USD"),
	// 						Grain: to.Ptr(armbillingbenefits.CommitmentGrainHourly),
	// 					},
	// 					DisplayName: to.Ptr("Compute_SavingsPlan_patch_rename2_renewed"),
	// 					Term: to.Ptr(armbillingbenefits.TermP1Y),
	// 				},
	// 				SKU: &armbillingbenefits.SKU{
	// 					Name: to.Ptr("Compute_Savings_Plan"),
	// 				},
	// 			},
	// 		},
	// 		Term: to.Ptr(armbillingbenefits.TermP3Y),
	// 		UserFriendlyAppliedScopeType: to.Ptr("Shared"),
	// 		Utilization: &armbillingbenefits.Utilization{
	// 			Aggregates: []*armbillingbenefits.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](84),
	// 					ValueUnit: to.Ptr("percentage"),
	// 				},
	// 				{
	// 					Grain: to.Ptr[float32](30),
	// 					GrainUnit: to.Ptr("days"),
	// 					Value: to.Ptr[float32](83.87),
	// 					ValueUnit: to.Ptr("percentage"),
	// 			}},
	// 			Trend: to.Ptr(""),
	// 		},
	// 	},
	// 	SKU: &armbillingbenefits.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

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

/**
 * This sample demonstrates how to Get savings plan.
 *
 * @summary Get savings plan.
 * x-ms-original-file: specification/billingbenefits/resource-manager/Microsoft.BillingBenefits/stable/2022-11-01/examples/SavingsPlanItemExpandedGet.json
 */
async function savingsPlanItemWithExpandedRenewPropertiesGet() {
  const savingsPlanOrderId = "20000000-0000-0000-0000-000000000000";
  const savingsPlanId = "30000000-0000-0000-0000-000000000000";
  const expand = "renewProperties";
  const options = { expand };
  const credential = new DefaultAzureCredential();
  const client = new BillingBenefitsRP(credential);
  const result = await client.savingsPlan.get(savingsPlanOrderId, savingsPlanId, options);
  console.log(result);
}

savingsPlanItemWithExpandedRenewPropertiesGet().catch(console.error);

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

Exemple de réponse

Code d’état:: 200

{
  "id": "/providers/microsoft.billingbenefits/savingsPlanOrders/20000000-0000-0000-0000-000000000000/savingsPlans/30000000-0000-0000-0000-000000000000",
  "name": "20000000-0000-0000-0000-000000000000/30000000-0000-0000-0000-000000000000",
  "type": "Microsoft.BillingBenefits/savingsPlanOrders/savingsPlans",
  "sku": {
    "name": "Compute_Savings_Plan"
  },
  "properties": {
    "billingScopeId": "/providers/Microsoft.Billing/billingAccounts/20000000-1000-0000-0000-000000000009",
    "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/20000000-1000-0000-0000-000000000000:20000000-0000-3000-0000-000000000000_2019-05-31/billingProfiles/KPSV-DWNE-BG7-TGB",
    "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/20000000-1000-0000-0000-000000000000:20000000-0000-3000-0000-000000000000_2019-05-31",
    "billingPlan": "P1M",
    "commitment": {
      "grain": "Hourly",
      "currencyCode": "USD",
      "amount": 0.001
    },
    "renew": true,
    "appliedScopeType": "Shared",
    "displayName": "Compute_SavingsPlan_patch_rename2",
    "provisioningState": "Succeeded",
    "term": "P3Y",
    "displayProvisioningState": "Succeeded",
    "userFriendlyAppliedScopeType": "Shared",
    "expiryDateTime": "2025-10-18T21:16:13.1854959Z",
    "purchaseDateTime": "2022-10-18T21:14:26.8279361Z",
    "effectiveDateTime": "2022-10-21T18:15:42.4098626Z",
    "utilization": {
      "trend": "",
      "aggregates": [
        {
          "grain": 1,
          "grainUnit": "days",
          "value": 100,
          "valueUnit": "percentage"
        },
        {
          "grain": 7,
          "grainUnit": "days",
          "value": 84,
          "valueUnit": "percentage"
        },
        {
          "grain": 30,
          "grainUnit": "days",
          "value": 83.87,
          "valueUnit": "percentage"
        }
      ]
    },
    "renewProperties": {
      "purchaseProperties": {
        "sku": {
          "name": "Compute_Savings_Plan"
        },
        "properties": {
          "billingScopeId": "/subscriptions/eef82110-c91b-4395-9420-fcfcbefc5a47",
          "term": "P1Y",
          "billingPlan": "Upfront",
          "displayName": "Compute_SavingsPlan_patch_rename2_renewed",
          "appliedScopeType": "Shared",
          "commitment": {
            "grain": "Hourly",
            "currencyCode": "USD",
            "amount": 0.001
          }
        }
      }
    }
  }
}

Définitions

Nom	Description
AppliedScopeProperties	Propriétés spécifiques au type d’étendue appliqué. Non obligatoire s’il n’est pas applicable.
AppliedScopeType	Type de l’étendue appliquée.
BillingPlan	Représente le plan de facturation au format ISO 8601. Obligatoire uniquement pour les plans de facturation mensuels.
Commitment	Engagement envers l’avantage.
CommitmentGrain	Grain d’engagement.
createdByType	Type d’identité qui a créé la ressource.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
ExtendedStatusInfo
ProvisioningState	État d’approvisionnement
PurchaseRequest
RenewProperties
SavingsPlanModel	Plan d’épargne
Sku	Référence SKU à appliquer pour cette ressource
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.
Term	Représente le terme d’avantage au format ISO 8601.
Utilization	Utilisation du plan d’épargne
UtilizationAggregates	Valeurs agrégées de l’utilisation du plan d’épargne

AppliedScopeProperties

Object

Propriétés spécifiques au type d’étendue appliqué. Non obligatoire s’il n’est pas applicable.

Nom	Type	Description
displayName	string	Nom d'affichage
managementGroupId	string	Identificateur complet du groupe d’administration où l’avantage doit être appliqué.
resourceGroupId	string	Identificateur complet du groupe de ressources.
subscriptionId	string	Identificateur complet de l’abonnement.
tenantId	string	ID de locataire où l’avantage est appliqué.

AppliedScopeType

Énumération

Type de l’étendue appliquée.

Valeur	Description
ManagementGroup
Shared
Single

BillingPlan

Énumération

Représente le plan de facturation au format ISO 8601. Obligatoire uniquement pour les plans de facturation mensuels.

Valeur	Description
P1M

Commitment

Object

Engagement envers l’avantage.

Nom	Type	Description
amount	number (double)
currencyCode	string	Code monétaire iso 4217 3 lettres pour la devise utilisée par cet enregistrement d’achat.
grain	CommitmentGrain	Grain d’engagement.

CommitmentGrain

Énumération

Grain d’engagement.

Valeur	Description
Hourly

createdByType

Énumération

Type d’identité qui a créé la ressource.

Valeur	Description
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Object

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorDetail

Object

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Object

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

ExtendedStatusInfo

Object

Nom	Type	Description
message	string	Message fournissant des informations détaillées sur le code d’état.
statusCode	string	Code d’état fournissant des informations supplémentaires.

ProvisioningState

Énumération

État d’approvisionnement

Valeur	Description
Cancelled
ConfirmedBilling
Created
Creating
Expired
Failed
PendingBilling
Succeeded

PurchaseRequest

Object

Nom	Type	Valeur par défaut	Description
properties.appliedScopeProperties	AppliedScopeProperties		Propriétés spécifiques au type d’étendue appliqué. Non obligatoire s’il n’est pas applicable.
properties.appliedScopeType	AppliedScopeType		Type de l’étendue appliquée.
properties.billingPlan	BillingPlan		Représente le plan de facturation au format ISO 8601. Obligatoire uniquement pour les plans de facturation mensuels.
properties.billingScopeId	string		Abonnement qui sera facturé pour l’achat de l’avantage
properties.commitment	Commitment		Engagement envers l’avantage.
properties.displayName	string		Nom convivial du plan d’épargne
properties.effectiveDateTime	string (date-time)		DateTime du plan d’épargne commence à offrir des avantages.
properties.renew	boolean	False	La définition de cette valeur sur true achète automatiquement un nouvel avantage à la date d’expiration.
properties.term	Term		Représente le terme d’avantage au format ISO 8601.
sku	Sku		Référence SKU à appliquer pour cette ressource

RenewProperties

Object

Nom	Type	Description
purchaseProperties	PurchaseRequest

SavingsPlanModel

Object

Plan d’épargne

Nom	Type	Valeur par défaut	Description
id	string		ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string		Nom de la ressource
properties.appliedScopeProperties	AppliedScopeProperties		Propriétés spécifiques au type d’étendue appliqué. Non obligatoire s’il n’est pas applicable.
properties.appliedScopeType	AppliedScopeType		Type de l’étendue appliquée.
properties.benefitStartTime	string (date-time)		Il s’agit de DateTime lorsque l’avantage du plan d’épargne a commencé.
properties.billingAccountId	string		Identificateur complet du compte de facturation où le plan d’épargne est appliqué. Présente uniquement pour les clients contrat Entreprise.
properties.billingPlan	BillingPlan		Représente le plan de facturation au format ISO 8601. Obligatoire uniquement pour les plans de facturation mensuels.
properties.billingProfileId	string		Identificateur complet du profil de facturation dans lequel le plan d’épargne est appliqué. Présente uniquement pour les clients dirigés par les champs ou les clients dirigés par le client.
properties.billingScopeId	string		Abonnement qui sera facturé pour l’achat de l’avantage
properties.commitment	Commitment		Engagement envers l’avantage.
properties.customerId	string		Identificateur complet du client dans lequel le plan d’épargne est appliqué. Présente uniquement pour les clients dirigés par un partenaire.
properties.displayName	string		Nom d'affichage
properties.displayProvisioningState	string		État d’approvisionnement du plan d’épargne pour l’affichage, par exemple Réussi
properties.effectiveDateTime	string (date-time)		DateTime du plan d’épargne commence à offrir des avantages.
properties.expiryDateTime	string (date-time)		Date d’expiration
properties.extendedStatusInfo	ExtendedStatusInfo
properties.provisioningState	ProvisioningState		État d’approvisionnement
properties.purchaseDateTime	string (date-time)		Date à laquelle le plan d’épargne a été acheté
properties.renew	boolean	False	La définition de cette valeur sur true achète automatiquement un nouvel avantage à la date d’expiration.
properties.renewDestination	string		SavingsPlan Id of the SavingsPlan qui est acheté en raison du renouvellement.
properties.renewProperties	RenewProperties
properties.renewSource	string		SavingsPlan Id of the SavingsPlan from the SavingsPlan from this SavingsPlan is renewed.
properties.term	Term		Représente le terme d’avantage au format ISO 8601.
properties.userFriendlyAppliedScopeType	string		Type d’étendue appliqué du plan d’épargne pour l’affichage, par exemple Partagé
properties.utilization	Utilization		Utilisation du plan d’épargne
sku	Sku		Référence SKU du plan d’épargne
systemData	systemData		Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy.
type	string		Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

Sku

Object

Référence SKU à appliquer pour cette ressource

Nom	Type	Description
name	string	Nom de la référence SKU à appliquer

systemData

Object

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string (date-time)	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string (date-time)	Horodatage de la dernière modification de ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType	createdByType	Type d’identité qui a modifié la ressource pour la dernière fois.

Term

Énumération

Représente le terme d’avantage au format ISO 8601.

Valeur	Description
P1Y
P3Y
P5Y

Utilization

Object

Utilisation du plan d’épargne

Nom	Type	Description
aggregates	UtilizationAggregates[]	Tableau d’agrégats de l’utilisation d’un plan d’épargne
trend	string	Nombre de jours de tendance pour un plan d’épargne

UtilizationAggregates

Object

Valeurs agrégées de l’utilisation du plan d’épargne

Nom	Type	Description
grain	number	Grain de l’agrégat
grainUnit	string	Unité de grain de l’agrégat
value	number	Valeur d’agrégation
valueUnit	string	Unité de valeur d’agrégation

Partager via

Savings Plan - Get

Paramètres URI

Réponses

Sécurité

azure_auth

Étendues

Exemples

SavingsPlanItemGet

Exemple de requête

Exemple de réponse

SavingsPlanItemWithExpandedRenewPropertiesGet

Exemple de requête

Exemple de réponse

Définitions

AppliedScopeProperties

AppliedScopeType

BillingPlan

Commitment

CommitmentGrain

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ExtendedStatusInfo

ProvisioningState

PurchaseRequest

RenewProperties

SavingsPlanModel

Sku

systemData

Term

Utilization

UtilizationAggregates