Savings Plan Order - List

Référence

Service:: Billing Benefits

Version d'API:: 2022-11-01

Répertoriez toutes les commandes de plan d’épargne.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
api-version	query	True	string	Version api à utiliser par le service

Réponses

Nom	Type	Description
200 OK	SavingsPlanOrderModelList	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

SavingsPlanOrderList

Exemple de requête

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


/**
 * Samples for SavingsPlanOrder List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/billingbenefits/resource-manager/Microsoft.BillingBenefits/stable/2022-11-01/examples/
     * SavingsPlanOrderList.json
     */
    /**
     * Sample code: SavingsPlanOrderList.
     * 
     * @param manager Entry point to BillingBenefitsManager.
     */
    public static void savingsPlanOrderList(com.azure.resourcemanager.billingbenefits.BillingBenefitsManager manager) {
        manager.savingsPlanOrders().list(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_list.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.list()
    for item in response:
        print(item)


# x-ms-original-file: specification/billingbenefits/resource-manager/Microsoft.BillingBenefits/stable/2022-11-01/examples/SavingsPlanOrderList.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/SavingsPlanOrderList.json
func ExampleSavingsPlanOrderClient_NewListPager() {
	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)
	}
	pager := clientFactory.NewSavingsPlanOrderClient().NewListPager(nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.SavingsPlanOrderModelList = armbillingbenefits.SavingsPlanOrderModelList{
		// 	Value: []*armbillingbenefits.SavingsPlanOrderModel{
		// 		{
		// 			Name: to.Ptr("20000000-0000-0000-0000-000000000000"),
		// 			Type: to.Ptr("Microsoft.BillingBenefits/savingsPlanOrders"),
		// 			ID: to.Ptr("/providers/microsoft.billingbenefits/savingsPlanOrders/20000000-0000-0000-0000-000000000000"),
		// 			Properties: &armbillingbenefits.SavingsPlanOrderModelProperties{
		// 				BillingAccountID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/20000000-1000-0000-0000-000000000004:20000000-0000-3000-0000-000000000000_2019-05-31"),
		// 				BillingPlan: to.Ptr(armbillingbenefits.BillingPlanP1M),
		// 				BillingProfileID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/20000000-1000-0000-0000-000000000004:20000000-0000-3000-0000-000000000000_2019-05-31/billingProfiles/KPSV-DWNE-BG7-TGB"),
		// 				BillingScopeID: to.Ptr("20000000-0000-0000-0000-000000000005"),
		// 				DisplayName: to.Ptr("Compute_SavingsPlan_10-28-2022_16-38"),
		// 				ExpiryDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2025-10-28T23:40:30.602Z"); return t}()),
		// 				ProvisioningState: to.Ptr(armbillingbenefits.ProvisioningStateSucceeded),
		// 				SavingsPlans: []*string{
		// 					to.Ptr("/providers/Microsoft.BillingBenefits/savingsPlanOrders/20000000-0000-0000-0000-000000000000/savingsPlans/20000000-0000-0000-0000-000000000001")},
		// 					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 List all Savings plan orders.
 *
 * @summary List all Savings plan orders.
 * x-ms-original-file: specification/billingbenefits/resource-manager/Microsoft.BillingBenefits/stable/2022-11-01/examples/SavingsPlanOrderList.json
 */
async function savingsPlanOrderList() {
  const credential = new DefaultAzureCredential();
  const client = new BillingBenefitsRP(credential);
  const resArray = new Array();
  for await (let item of client.savingsPlanOrder.list()) {
    resArray.push(item);
  }
  console.log(resArray);
}

savingsPlanOrderList().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

{
  "value": [
    {
      "id": "/providers/microsoft.billingbenefits/savingsPlanOrders/20000000-0000-0000-0000-000000000000",
      "name": "20000000-0000-0000-0000-000000000000",
      "type": "Microsoft.BillingBenefits/savingsPlanOrders",
      "properties": {
        "billingScopeId": "20000000-0000-0000-0000-000000000005",
        "savingsPlans": [
          "/providers/Microsoft.BillingBenefits/savingsPlanOrders/20000000-0000-0000-0000-000000000000/savingsPlans/20000000-0000-0000-0000-000000000001"
        ],
        "billingPlan": "P1M",
        "term": "P3Y",
        "displayName": "Compute_SavingsPlan_10-28-2022_16-38",
        "provisioningState": "Succeeded",
        "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/20000000-1000-0000-0000-000000000004:20000000-0000-3000-0000-000000000000_2019-05-31/billingProfiles/KPSV-DWNE-BG7-TGB",
        "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/20000000-1000-0000-0000-000000000004:20000000-0000-3000-0000-000000000000_2019-05-31",
        "expiryDateTime": "2025-10-28T23:40:30.6028303Z"
      },
      "sku": {
        "name": "Compute_Savings_Plan"
      }
    }
  ]
}

Définitions

Nom	Description
BillingPlan	Représente le plan de facturation au format ISO 8601. Obligatoire uniquement pour les plans de facturation mensuels.
BillingPlanInformation	Informations décrivant le type de plan de facturation de ce plan d’épargne.
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
PaymentDetail	Informations sur le paiement lié à une commande de plan d’épargne.
PaymentStatus	Décrit si le paiement est terminé, échoué, annulé ou planifié à l’avenir.
Price
ProvisioningState	État d’approvisionnement
SavingsPlanOrderModel	Ordre de plan d’épargne
SavingsPlanOrderModelList
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.

BillingPlan

Énumération

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

Valeur	Description
P1M

BillingPlanInformation

Object

Informations décrivant le type de plan de facturation de ce plan d’épargne.

Nom	Type	Description
nextPaymentDueDate	string (date)	Pour les plans de facturation périodiques, indique la date à laquelle le prochain paiement sera traité. Null lorsque le total est remboursé.
pricingCurrencyTotal	Price	Montant de l’argent à payer pour la commande. L’impôt n’est pas inclus.
startDate	string (date)	Date à laquelle le plan de facturation a commencé.
transactions	PaymentDetail[]	Informations sur le paiement lié à une commande de plan d’épargne.

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.

PaymentDetail

Object

Informations sur le paiement lié à une commande de plan d’épargne.

Nom	Type	Description
billingAccount	string	Compte de facturation
billingCurrencyTotal	Price	Montant facturé dans la devise de facturation. Taxe non incluse. Est null pour les paiements futurs
dueDate	string (date)	Date à laquelle le paiement doit être effectué.
extendedStatusInfo	ExtendedStatusInfo
paymentDate	string (date)	Date à laquelle la transaction est terminée. Est null lorsqu’il est planifié.
pricingCurrencyTotal	Price	Montant de la devise de tarification. Taxe non incluse.
status	PaymentStatus	Décrit si le paiement est terminé, échoué, annulé ou planifié à l’avenir.

PaymentStatus

Énumération

Décrit si le paiement est terminé, échoué, annulé ou planifié à l’avenir.

Valeur	Description
Cancelled
Failed
Scheduled
Succeeded

Price

Object

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.

ProvisioningState

Énumération

État d’approvisionnement

Valeur	Description
Cancelled
ConfirmedBilling
Created
Creating
Expired
Failed
PendingBilling
Succeeded

SavingsPlanOrderModel

Object

Ordre de plan d’épargne

Nom	Type	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.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.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.expiryDateTime	string (date-time)	Date d’expiration
properties.extendedStatusInfo	ExtendedStatusInfo
properties.planInformation	BillingPlanInformation	Informations décrivant le type de plan de facturation de ce plan d’épargne.
properties.provisioningState	ProvisioningState	État d’approvisionnement
properties.savingsPlans	string[]	Identificateur du plan d’épargne
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 »

SavingsPlanOrderModelList

Object

Nom	Type	Description
nextLink	string	URL pour obtenir la page suivante.
value	SavingsPlanOrderModel[]	Ordre de plan d’épargne

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

Paramètres URI

Réponses

Sécurité

azure_auth

Étendues

Exemples

SavingsPlanOrderList

Exemple de requête

Exemple de réponse

Définitions

BillingPlan

BillingPlanInformation

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ExtendedStatusInfo

PaymentDetail

PaymentStatus

Price

ProvisioningState

SavingsPlanOrderModel

SavingsPlanOrderModelList

Sku

systemData

Term