Savings Plan Order Alias - Create

Référence

Service:: Billing Benefits

Version d'API:: 2022-11-01

Créez un plan d’épargne. En savoir plus sur les autorisations nécessaires à https://go.microsoft.com/fwlink/?linkid=2215851

PUT https://management.azure.com/providers/Microsoft.BillingBenefits/savingsPlanOrderAliases/{savingsPlanOrderAliasName}?api-version=2022-11-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
savingsPlanOrderAliasName	path	True	string pattern: ^[a-zA-Z0-9_\-\.]+$	Nom de l’alias de commande du plan d’épargne
api-version	query	True	string	Version api à utiliser par le service

Corps de la demande

Nom	Obligatoire	Type	Description
sku	True	Sku	Référence SKU du plan d’épargne
kind		string	Type de fournisseur de ressources
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 d'affichage
properties.renew		boolean	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.

Réponses

Nom	Type	Description
200 OK	SavingsPlanOrderAliasModel	La ressource a été créée.
201 Created	SavingsPlanOrderAliasModel	La demande est en cours de traitement. En-têtes Azure-AsyncOperation: string Retry-After: integer
Other Status Codes	ErrorResponse	Réponse d’erreur décrivant pourquoi l’opération a échoué.

Nom

Type

Description

200 OK

SavingsPlanOrderAliasModel

La ressource a été créée.

201 Created

SavingsPlanOrderAliasModel

La demande est en cours de traitement.

En-têtes

Azure-AsyncOperation: string
Retry-After: integer

Other Status Codes

ErrorResponse

Réponse d’erreur décrivant pourquoi l’opération a échoué.

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

SavingsPlanOrderAliasCreate

SavingsPlanOrderAliasCreateSingleScope

SavingsPlanOrderAliasCreate

Exemple de requête

PUT https://management.azure.com/providers/Microsoft.BillingBenefits/savingsPlanOrderAliases/spAlias123?api-version=2022-11-01

{
  "sku": {
    "name": "Compute_Savings_Plan"
  },
  "properties": {
    "billingScopeId": "/subscriptions/30000000-0000-0000-0000-000000000000",
    "term": "P3Y",
    "appliedScopeType": "Shared",
    "appliedScopeProperties": null,
    "displayName": "Compute_SavingsPlan_10-28-2022_16-38",
    "billingPlan": "P1M",
    "commitment": {
      "grain": "Hourly",
      "currencyCode": "USD",
      "amount": 0.001
    }
  }
}


import com.azure.resourcemanager.billingbenefits.fluent.models.SavingsPlanOrderAliasModelInner;
import com.azure.resourcemanager.billingbenefits.models.AppliedScopeType;
import com.azure.resourcemanager.billingbenefits.models.BillingPlan;
import com.azure.resourcemanager.billingbenefits.models.Commitment;
import com.azure.resourcemanager.billingbenefits.models.CommitmentGrain;
import com.azure.resourcemanager.billingbenefits.models.Sku;
import com.azure.resourcemanager.billingbenefits.models.Term;

/**
 * Samples for SavingsPlanOrderAlias Create.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/billingbenefits/resource-manager/Microsoft.BillingBenefits/stable/2022-11-01/examples/
     * SavingsPlanOrderAliasCreate.json
     */
    /**
     * Sample code: SavingsPlanOrderAliasCreate.
     * 
     * @param manager Entry point to BillingBenefitsManager.
     */
    public static void
        savingsPlanOrderAliasCreate(com.azure.resourcemanager.billingbenefits.BillingBenefitsManager manager) {
        manager.savingsPlanOrderAlias().create("spAlias123",
            new SavingsPlanOrderAliasModelInner().withSku(new Sku().withName("Compute_Savings_Plan"))
                .withDisplayName("Compute_SavingsPlan_10-28-2022_16-38")
                .withBillingScopeId("/subscriptions/30000000-0000-0000-0000-000000000000").withTerm(Term.P3Y)
                .withBillingPlan(BillingPlan.P1M).withAppliedScopeType(AppliedScopeType.SHARED)
                .withCommitment(new Commitment().withCurrencyCode("fakeTokenPlaceholder").withAmount(0.001D)
                    .withGrain(CommitmentGrain.HOURLY)),
            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_order_alias_create.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_order_alias.begin_create(
        savings_plan_order_alias_name="spAlias123",
        body={
            "properties": {
                "appliedScopeProperties": None,
                "appliedScopeType": "Shared",
                "billingPlan": "P1M",
                "billingScopeId": "/subscriptions/30000000-0000-0000-0000-000000000000",
                "commitment": {"amount": 0.001, "currencyCode": "USD", "grain": "Hourly"},
                "displayName": "Compute_SavingsPlan_10-28-2022_16-38",
                "term": "P3Y",
            },
            "sku": {"name": "Compute_Savings_Plan"},
        },
    ).result()
    print(response)


# x-ms-original-file: specification/billingbenefits/resource-manager/Microsoft.BillingBenefits/stable/2022-11-01/examples/SavingsPlanOrderAliasCreate.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/SavingsPlanOrderAliasCreate.json
func ExampleSavingsPlanOrderAliasClient_BeginCreate_savingsPlanOrderAliasCreate() {
	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)
	}
	poller, err := clientFactory.NewSavingsPlanOrderAliasClient().BeginCreate(ctx, "spAlias123", armbillingbenefits.SavingsPlanOrderAliasModel{
		Properties: &armbillingbenefits.SavingsPlanOrderAliasProperties{
			AppliedScopeType: to.Ptr(armbillingbenefits.AppliedScopeTypeShared),
			BillingPlan:      to.Ptr(armbillingbenefits.BillingPlanP1M),
			BillingScopeID:   to.Ptr("/subscriptions/30000000-0000-0000-0000-000000000000"),
			Commitment: &armbillingbenefits.Commitment{
				Amount:       to.Ptr[float64](0.001),
				CurrencyCode: to.Ptr("USD"),
				Grain:        to.Ptr(armbillingbenefits.CommitmentGrainHourly),
			},
			DisplayName: to.Ptr("Compute_SavingsPlan_10-28-2022_16-38"),
			Term:        to.Ptr(armbillingbenefits.TermP3Y),
		},
		SKU: &armbillingbenefits.SKU{
			Name: to.Ptr("Compute_Savings_Plan"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %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.SavingsPlanOrderAliasModel = armbillingbenefits.SavingsPlanOrderAliasModel{
	// 	Name: to.Ptr("SavingsPlan_1667000324595"),
	// 	Type: to.Ptr("Microsoft.BillingBenefits/savingsPlanOrderAliases"),
	// 	ID: to.Ptr("/providers/microsoft.billingbenefits/savingsPlanOrderAliases/SavingsPlan_1667000324595"),
	// 	Properties: &armbillingbenefits.SavingsPlanOrderAliasProperties{
	// 		AppliedScopeType: to.Ptr(armbillingbenefits.AppliedScopeTypeShared),
	// 		BillingPlan: to.Ptr(armbillingbenefits.BillingPlanP1M),
	// 		BillingScopeID: to.Ptr("/subscriptions/30000000-0000-0000-0000-000000000000"),
	// 		Commitment: &armbillingbenefits.Commitment{
	// 			Amount: to.Ptr[float64](0.001),
	// 			CurrencyCode: to.Ptr("USD"),
	// 			Grain: to.Ptr(armbillingbenefits.CommitmentGrainHourly),
	// 		},
	// 		DisplayName: to.Ptr("Compute_SavingsPlan_10-28-2022_16-38"),
	// 		ProvisioningState: to.Ptr(armbillingbenefits.ProvisioningStateSucceeded),
	// 		SavingsPlanOrderID: to.Ptr("/providers/Microsoft.BillingBenefits/savingsPlanOrders/30000000-0000-0000-0000-000000000023"),
	// 		Term: to.Ptr(armbillingbenefits.TermP3Y),
	// 	},
	// 	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 Create a savings plan. Learn more about permissions needed at https://go.microsoft.com/fwlink/?linkid=2215851
 *
 * @summary Create a savings plan. Learn more about permissions needed at https://go.microsoft.com/fwlink/?linkid=2215851
 * x-ms-original-file: specification/billingbenefits/resource-manager/Microsoft.BillingBenefits/stable/2022-11-01/examples/SavingsPlanOrderAliasCreate.json
 */
async function savingsPlanOrderAliasCreate() {
  const savingsPlanOrderAliasName = "spAlias123";
  const body = {
    appliedScopeProperties: {},
    appliedScopeType: "Shared",
    billingPlan: "P1M",
    billingScopeId: "/subscriptions/30000000-0000-0000-0000-000000000000",
    commitment: { amount: 0.001, currencyCode: "USD", grain: "Hourly" },
    displayName: "Compute_SavingsPlan_10-28-2022_16-38",
    sku: { name: "Compute_Savings_Plan" },
    term: "P3Y",
  };
  const credential = new DefaultAzureCredential();
  const client = new BillingBenefitsRP(credential);
  const result = await client.savingsPlanOrderAlias.beginCreateAndWait(
    savingsPlanOrderAliasName,
    body
  );
  console.log(result);
}

savingsPlanOrderAliasCreate().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:: 201

Azure-AsyncOperation: https://management.azure.com/Microsoft.BillingBenefits/operationResults/4e2ffff7-b331-4fcb-ab11-b5fa49368188?api-version=2021-07-01-privatepreview
Retry-After: 5

{
  "id": "/providers/microsoft.billingbenefits/savingsPlanOrderAliases/SavingsPlan_1667000324595",
  "name": "SavingsPlan_1667000324595",
  "type": "Microsoft.BillingBenefits/savingsPlanOrderAliases",
  "kind": null,
  "sku": {
    "name": "Compute_Savings_Plan"
  },
  "properties": {
    "savingsPlanOrderId": "/providers/Microsoft.BillingBenefits/savingsPlanOrders/30000000-0000-0000-0000-000000000023",
    "billingScopeId": "/subscriptions/30000000-0000-0000-0000-000000000000",
    "billingPlan": "P1M",
    "appliedScopeProperties": null,
    "commitment": {
      "grain": "Hourly",
      "currencyCode": "USD",
      "amount": 0.001
    },
    "appliedScopeType": "Shared",
    "displayName": "Compute_SavingsPlan_10-28-2022_16-38",
    "provisioningState": "Created",
    "term": "P3Y"
  }
}

Code d’état:: 200

{
  "id": "/providers/microsoft.billingbenefits/savingsPlanOrderAliases/SavingsPlan_1667000324595",
  "name": "SavingsPlan_1667000324595",
  "type": "Microsoft.BillingBenefits/savingsPlanOrderAliases",
  "kind": null,
  "sku": {
    "name": "Compute_Savings_Plan"
  },
  "properties": {
    "savingsPlanOrderId": "/providers/Microsoft.BillingBenefits/savingsPlanOrders/30000000-0000-0000-0000-000000000023",
    "billingScopeId": "/subscriptions/30000000-0000-0000-0000-000000000000",
    "billingPlan": "P1M",
    "appliedScopeProperties": null,
    "commitment": {
      "grain": "Hourly",
      "currencyCode": "USD",
      "amount": 0.001
    },
    "appliedScopeType": "Shared",
    "displayName": "Compute_SavingsPlan_10-28-2022_16-38",
    "provisioningState": "Created",
    "term": "P3Y"
  }
}

SavingsPlanOrderAliasCreateSingleScope

Exemple de requête

PUT https://management.azure.com/providers/Microsoft.BillingBenefits/savingsPlanOrderAliases/spAlias123?api-version=2022-11-01

{
  "sku": {
    "name": "Compute_Savings_Plan"
  },
  "properties": {
    "billingScopeId": "/providers/Microsoft.Billing/billingAccounts/1234567/billingSubscriptions/30000000-0000-0000-0000-000000000000",
    "appliedScopeType": "Single",
    "appliedScopeProperties": {
      "subscriptionId": "/subscriptions/30000000-0000-0000-0000-000000000000"
    },
    "term": "P3Y",
    "displayName": "Compute_SavingsPlan_10-28-2022_16-38",
    "billingPlan": "P1M",
    "commitment": {
      "grain": "Hourly",
      "currencyCode": "USD",
      "amount": 0.001
    }
  }
}


import com.azure.resourcemanager.billingbenefits.fluent.models.SavingsPlanOrderAliasModelInner;
import com.azure.resourcemanager.billingbenefits.models.AppliedScopeProperties;
import com.azure.resourcemanager.billingbenefits.models.AppliedScopeType;
import com.azure.resourcemanager.billingbenefits.models.BillingPlan;
import com.azure.resourcemanager.billingbenefits.models.Commitment;
import com.azure.resourcemanager.billingbenefits.models.CommitmentGrain;
import com.azure.resourcemanager.billingbenefits.models.Sku;
import com.azure.resourcemanager.billingbenefits.models.Term;

/**
 * Samples for SavingsPlanOrderAlias Create.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/billingbenefits/resource-manager/Microsoft.BillingBenefits/stable/2022-11-01/examples/
     * SavingsPlanOrderAliasCreateSingleScope.json
     */
    /**
     * Sample code: SavingsPlanOrderAliasCreateSingleScope.
     * 
     * @param manager Entry point to BillingBenefitsManager.
     */
    public static void savingsPlanOrderAliasCreateSingleScope(
        com.azure.resourcemanager.billingbenefits.BillingBenefitsManager manager) {
        manager.savingsPlanOrderAlias().create("spAlias123", new SavingsPlanOrderAliasModelInner()
            .withSku(new Sku().withName("Compute_Savings_Plan")).withDisplayName("Compute_SavingsPlan_10-28-2022_16-38")
            .withBillingScopeId(
                "/providers/Microsoft.Billing/billingAccounts/1234567/billingSubscriptions/30000000-0000-0000-0000-000000000000")
            .withTerm(Term.P3Y).withBillingPlan(BillingPlan.P1M).withAppliedScopeType(AppliedScopeType.SINGLE)
            .withAppliedScopeProperties(
                new AppliedScopeProperties().withSubscriptionId("/subscriptions/30000000-0000-0000-0000-000000000000"))
            .withCommitment(new Commitment().withCurrencyCode("fakeTokenPlaceholder").withAmount(0.001D)
                .withGrain(CommitmentGrain.HOURLY)),
            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_order_alias_create_single_scope.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_order_alias.begin_create(
        savings_plan_order_alias_name="spAlias123",
        body={
            "properties": {
                "appliedScopeProperties": {"subscriptionId": "/subscriptions/30000000-0000-0000-0000-000000000000"},
                "appliedScopeType": "Single",
                "billingPlan": "P1M",
                "billingScopeId": "/providers/Microsoft.Billing/billingAccounts/1234567/billingSubscriptions/30000000-0000-0000-0000-000000000000",
                "commitment": {"amount": 0.001, "currencyCode": "USD", "grain": "Hourly"},
                "displayName": "Compute_SavingsPlan_10-28-2022_16-38",
                "term": "P3Y",
            },
            "sku": {"name": "Compute_Savings_Plan"},
        },
    ).result()
    print(response)


# x-ms-original-file: specification/billingbenefits/resource-manager/Microsoft.BillingBenefits/stable/2022-11-01/examples/SavingsPlanOrderAliasCreateSingleScope.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/SavingsPlanOrderAliasCreateSingleScope.json
func ExampleSavingsPlanOrderAliasClient_BeginCreate_savingsPlanOrderAliasCreateSingleScope() {
	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)
	}
	poller, err := clientFactory.NewSavingsPlanOrderAliasClient().BeginCreate(ctx, "spAlias123", armbillingbenefits.SavingsPlanOrderAliasModel{
		Properties: &armbillingbenefits.SavingsPlanOrderAliasProperties{
			AppliedScopeProperties: &armbillingbenefits.AppliedScopeProperties{
				SubscriptionID: to.Ptr("/subscriptions/30000000-0000-0000-0000-000000000000"),
			},
			AppliedScopeType: to.Ptr(armbillingbenefits.AppliedScopeTypeSingle),
			BillingPlan:      to.Ptr(armbillingbenefits.BillingPlanP1M),
			BillingScopeID:   to.Ptr("/providers/Microsoft.Billing/billingAccounts/1234567/billingSubscriptions/30000000-0000-0000-0000-000000000000"),
			Commitment: &armbillingbenefits.Commitment{
				Amount:       to.Ptr[float64](0.001),
				CurrencyCode: to.Ptr("USD"),
				Grain:        to.Ptr(armbillingbenefits.CommitmentGrainHourly),
			},
			DisplayName: to.Ptr("Compute_SavingsPlan_10-28-2022_16-38"),
			Term:        to.Ptr(armbillingbenefits.TermP3Y),
		},
		SKU: &armbillingbenefits.SKU{
			Name: to.Ptr("Compute_Savings_Plan"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %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.SavingsPlanOrderAliasModel = armbillingbenefits.SavingsPlanOrderAliasModel{
	// 	Name: to.Ptr("SavingsPlan_1667000324595"),
	// 	Type: to.Ptr("Microsoft.BillingBenefits/savingsPlanOrderAliases"),
	// 	ID: to.Ptr("/providers/microsoft.billingbenefits/savingsPlanOrderAliases/SavingsPlan_1667000324595"),
	// 	Properties: &armbillingbenefits.SavingsPlanOrderAliasProperties{
	// 		AppliedScopeProperties: &armbillingbenefits.AppliedScopeProperties{
	// 			SubscriptionID: to.Ptr("/subscriptions/30000000-0000-0000-0000-000000000000"),
	// 		},
	// 		AppliedScopeType: to.Ptr(armbillingbenefits.AppliedScopeTypeSingle),
	// 		BillingPlan: to.Ptr(armbillingbenefits.BillingPlanP1M),
	// 		BillingScopeID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/1234567/billingSubscriptions/30000000-0000-0000-0000-000000000000"),
	// 		Commitment: &armbillingbenefits.Commitment{
	// 			Amount: to.Ptr[float64](0.001),
	// 			CurrencyCode: to.Ptr("USD"),
	// 			Grain: to.Ptr(armbillingbenefits.CommitmentGrainHourly),
	// 		},
	// 		DisplayName: to.Ptr("Compute_SavingsPlan_10-28-2022_16-38"),
	// 		ProvisioningState: to.Ptr(armbillingbenefits.ProvisioningStateSucceeded),
	// 		SavingsPlanOrderID: to.Ptr("/providers/Microsoft.BillingBenefits/savingsPlanOrders/30000000-0000-0000-0000-000000000023"),
	// 		Term: to.Ptr(armbillingbenefits.TermP3Y),
	// 	},
	// 	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 Create a savings plan. Learn more about permissions needed at https://go.microsoft.com/fwlink/?linkid=2215851
 *
 * @summary Create a savings plan. Learn more about permissions needed at https://go.microsoft.com/fwlink/?linkid=2215851
 * x-ms-original-file: specification/billingbenefits/resource-manager/Microsoft.BillingBenefits/stable/2022-11-01/examples/SavingsPlanOrderAliasCreateSingleScope.json
 */
async function savingsPlanOrderAliasCreateSingleScope() {
  const savingsPlanOrderAliasName = "spAlias123";
  const body = {
    appliedScopeProperties: {
      subscriptionId: "/subscriptions/30000000-0000-0000-0000-000000000000",
    },
    appliedScopeType: "Single",
    billingPlan: "P1M",
    billingScopeId:
      "/providers/Microsoft.Billing/billingAccounts/1234567/billingSubscriptions/30000000-0000-0000-0000-000000000000",
    commitment: { amount: 0.001, currencyCode: "USD", grain: "Hourly" },
    displayName: "Compute_SavingsPlan_10-28-2022_16-38",
    sku: { name: "Compute_Savings_Plan" },
    term: "P3Y",
  };
  const credential = new DefaultAzureCredential();
  const client = new BillingBenefitsRP(credential);
  const result = await client.savingsPlanOrderAlias.beginCreateAndWait(
    savingsPlanOrderAliasName,
    body
  );
  console.log(result);
}

savingsPlanOrderAliasCreateSingleScope().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:: 201

Azure-AsyncOperation: https://management.azure.com/Microsoft.BillingBenefits/operationResults/4e2ffff7-b331-4fcb-ab11-b5fa49368188?api-version=2021-07-01-privatepreview
Retry-After: 5

{
  "id": "/providers/microsoft.billingbenefits/savingsPlanOrderAliases/SavingsPlan_1667000324595",
  "name": "SavingsPlan_1667000324595",
  "type": "Microsoft.BillingBenefits/savingsPlanOrderAliases",
  "kind": null,
  "sku": {
    "name": "Compute_Savings_Plan"
  },
  "properties": {
    "savingsPlanOrderId": "/providers/Microsoft.BillingBenefits/savingsPlanOrders/30000000-0000-0000-0000-000000000023",
    "billingPlan": "P1M",
    "billingScopeId": "/providers/Microsoft.Billing/billingAccounts/1234567/billingSubscriptions/30000000-0000-0000-0000-000000000000",
    "appliedScopeType": "Single",
    "appliedScopeProperties": {
      "subscriptionId": "/subscriptions/30000000-0000-0000-0000-000000000000"
    },
    "commitment": {
      "grain": "Hourly",
      "currencyCode": "USD",
      "amount": 0.001
    },
    "displayName": "Compute_SavingsPlan_10-28-2022_16-38",
    "provisioningState": "Created",
    "term": "P3Y"
  }
}

Code d’état:: 200

{
  "id": "/providers/microsoft.billingbenefits/savingsPlanOrderAliases/SavingsPlan_1667000324595",
  "name": "SavingsPlan_1667000324595",
  "type": "Microsoft.BillingBenefits/savingsPlanOrderAliases",
  "kind": null,
  "sku": {
    "name": "Compute_Savings_Plan"
  },
  "properties": {
    "savingsPlanOrderId": "/providers/Microsoft.BillingBenefits/savingsPlanOrders/30000000-0000-0000-0000-000000000023",
    "billingPlan": "P1M",
    "billingScopeId": "/providers/Microsoft.Billing/billingAccounts/1234567/billingSubscriptions/30000000-0000-0000-0000-000000000000",
    "appliedScopeType": "Single",
    "appliedScopeProperties": {
      "subscriptionId": "/subscriptions/30000000-0000-0000-0000-000000000000"
    },
    "commitment": {
      "grain": "Hourly",
      "currencyCode": "USD",
      "amount": 0.001
    },
    "displayName": "Compute_SavingsPlan_10-28-2022_16-38",
    "provisioningState": "Created",
    "term": "P3Y"
  }
}

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
ProvisioningState	État d’approvisionnement
SavingsPlanOrderAliasModel	Alias d’ordre de 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.

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.

ProvisioningState

Énumération

État d’approvisionnement

Valeur	Description
Cancelled
ConfirmedBilling
Created
Creating
Expired
Failed
PendingBilling
Succeeded

SavingsPlanOrderAliasModel

Object

Alias d’ordre de 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}
kind	string		Type de fournisseur de ressources
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.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 d'affichage
properties.provisioningState	ProvisioningState		État d’approvisionnement
properties.renew	boolean	False	La définition de cette valeur sur true achète automatiquement un nouvel avantage à la date d’expiration.
properties.savingsPlanOrderId	string		Identificateur du plan d’épargne créé
properties.term	Term		Représente le terme d’avantage au format ISO 8601.
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

Partager via

Savings Plan Order Alias - Create

Paramètres URI

Corps de la demande

Réponses

Sécurité

azure_auth

Étendues

Exemples

SavingsPlanOrderAliasCreate

Exemple de requête

Exemple de réponse

SavingsPlanOrderAliasCreateSingleScope

Exemple de requête

Exemple de réponse

Définitions

AppliedScopeProperties

AppliedScopeType

BillingPlan

Commitment

CommitmentGrain

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ProvisioningState

SavingsPlanOrderAliasModel

Sku

systemData

Term

Ressources supplémentaires