Reservation Order - Purchase

Référence

Service:: Reserved VM Instances

Version d'API:: 2022-11-01

Achetez et créez ReservationOrder une ressource sous l’URI spécifié.

PUT https://management.azure.com/providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}?api-version=2022-11-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
reservationOrderId	path	True	string	ID d’ordre de la réservation
api-version	query	True	string	Version prise en charge.

Corps de la demande

Nom	Type	Description
location	string	Région Azure où réside la ressource réservée.
properties.appliedScopeProperties	AppliedScopeProperties	Propriétés spécifiques au type d’étendue appliqué. Non obligatoire s’il n’est pas applicable. Requis et doivent fournir tenantId et managementGroupId si AppliedScopeType est ManagementGroup
properties.appliedScopeType	AppliedScopeType	Type de l’étendue appliquée.
properties.appliedScopes	string[]	Liste des abonnements auxquels l’avantage sera appliqué. Ne spécifiez pas si AppliedScopeType est Partagé. Cette propriété sera déconseillée et remplacée par appliedScopeProperties à la place pour Single AppliedScopeType.
properties.billingPlan	ReservationBillingPlan	Représentez les plans de facturation.
properties.billingScopeId	string	Abonnement qui sera facturé pour l’achat d’une réservation ou d’un plan d’économies
properties.displayName	string	Nom convivial de la réservation
properties.quantity	integer	Quantité des références SKU qui font partie de la réservation.
properties.renew	boolean	La définition de cette valeur sur true permet d’acheter automatiquement une nouvelle réservation à la date d’expiration.
properties.reservedResourceProperties	ReservedResourceProperties	Propriétés spécifiques à chaque type de ressource réservé. Non obligatoire s’il n’est pas applicable.
properties.reservedResourceType	ReservedResourceType	Type de la ressource réservée.
properties.reviewDateTime	string	Il s’agit de la date et de l’heure à laquelle l’avantage hybride Azure doit être examiné.
properties.term	ReservationTerm	Représente le terme de réservation.
sku	SkuName	Nom de la référence sku

Réponses

Nom

Type

Description

200 OK

ReservationOrderResponse

La ressource a été créée

202 Accepted

ReservationOrderResponse

La demande est acceptée et est en cours de traitement. Le lien du résultat de l’opération se trouve dans l’en-tête d’emplacement.

En-têtes

Location: string
Retry-After: integer

Other Status Codes

Erreur inattendue

Exemples

Purchase

Exemple de requête

PUT https://management.azure.com/providers/Microsoft.Capacity/reservationOrders/a075419f-44cc-497f-b68a-14ee811d48b9?api-version=2022-11-01

{
  "sku": {
    "name": "standard_D1"
  },
  "location": "westus",
  "properties": {
    "reservedResourceType": "VirtualMachines",
    "billingScopeId": "/subscriptions/ed3a1871-612d-abcd-a849-c2542a68be83",
    "term": "P1Y",
    "billingPlan": "Monthly",
    "quantity": 1,
    "displayName": "TestReservationOrder",
    "appliedScopes": null,
    "appliedScopeType": "Shared",
    "reservedResourceProperties": {
      "instanceFlexibility": "On"
    },
    "renew": false
  }
}

import com.azure.resourcemanager.reservations.models.AppliedScopeType;
import com.azure.resourcemanager.reservations.models.InstanceFlexibility;
import com.azure.resourcemanager.reservations.models.PurchaseRequest;
import com.azure.resourcemanager.reservations.models.PurchaseRequestPropertiesReservedResourceProperties;
import com.azure.resourcemanager.reservations.models.ReservationBillingPlan;
import com.azure.resourcemanager.reservations.models.ReservationTerm;
import com.azure.resourcemanager.reservations.models.ReservedResourceType;
import com.azure.resourcemanager.reservations.models.SkuName;

/** Samples for ReservationOrder Purchase. */
public final class Main {
    /*
     * x-ms-original-file: specification/reservations/resource-manager/Microsoft.Capacity/stable/2022-11-01/examples/PurchaseReservationOrder.json
     */
    /**
     * Sample code: Purchase.
     *
     * @param manager Entry point to ReservationsManager.
     */
    public static void purchase(com.azure.resourcemanager.reservations.ReservationsManager manager) {
        manager
            .reservationOrders()
            .purchase(
                "a075419f-44cc-497f-b68a-14ee811d48b9",
                new PurchaseRequest()
                    .withSku(new SkuName().withName("standard_D1"))
                    .withLocation("westus")
                    .withReservedResourceType(ReservedResourceType.VIRTUAL_MACHINES)
                    .withBillingScopeId("/subscriptions/ed3a1871-612d-abcd-a849-c2542a68be83")
                    .withTerm(ReservationTerm.P1Y)
                    .withBillingPlan(ReservationBillingPlan.MONTHLY)
                    .withQuantity(1)
                    .withDisplayName("TestReservationOrder")
                    .withAppliedScopeType(AppliedScopeType.SHARED)
                    .withRenew(false)
                    .withReservedResourceProperties(
                        new PurchaseRequestPropertiesReservedResourceProperties()
                            .withInstanceFlexibility(InstanceFlexibility.ON)),
                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.reservations import AzureReservationAPI

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

    response = client.reservation_order.begin_purchase(
        reservation_order_id="a075419f-44cc-497f-b68a-14ee811d48b9",
        body={
            "location": "westus",
            "properties": {
                "appliedScopeType": "Shared",
                "appliedScopes": None,
                "billingPlan": "Monthly",
                "billingScopeId": "/subscriptions/ed3a1871-612d-abcd-a849-c2542a68be83",
                "displayName": "TestReservationOrder",
                "quantity": 1,
                "renew": False,
                "reservedResourceProperties": {"instanceFlexibility": "On"},
                "reservedResourceType": "VirtualMachines",
                "term": "P1Y",
            },
            "sku": {"name": "standard_D1"},
        },
    ).result()
    print(response)


# x-ms-original-file: specification/reservations/resource-manager/Microsoft.Capacity/stable/2022-11-01/examples/PurchaseReservationOrder.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 armreservations_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/reservations/armreservations/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1e7b408f3323e7f5424745718fe62c7a043a2337/specification/reservations/resource-manager/Microsoft.Capacity/stable/2022-11-01/examples/PurchaseReservationOrder.json
func ExampleReservationOrderClient_BeginPurchase() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armreservations.NewClientFactory(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewReservationOrderClient().BeginPurchase(ctx, "a075419f-44cc-497f-b68a-14ee811d48b9", armreservations.PurchaseRequest{
		Location: to.Ptr("westus"),
		Properties: &armreservations.PurchaseRequestProperties{
			AppliedScopeType: to.Ptr(armreservations.AppliedScopeTypeShared),
			BillingPlan:      to.Ptr(armreservations.ReservationBillingPlanMonthly),
			BillingScopeID:   to.Ptr("/subscriptions/ed3a1871-612d-abcd-a849-c2542a68be83"),
			DisplayName:      to.Ptr("TestReservationOrder"),
			Quantity:         to.Ptr[int32](1),
			Renew:            to.Ptr(false),
			ReservedResourceProperties: &armreservations.PurchaseRequestPropertiesReservedResourceProperties{
				InstanceFlexibility: to.Ptr(armreservations.InstanceFlexibilityOn),
			},
			ReservedResourceType: to.Ptr(armreservations.ReservedResourceTypeVirtualMachines),
			Term:                 to.Ptr(armreservations.ReservationTermP1Y),
		},
		SKU: &armreservations.SKUName{
			Name: to.Ptr("standard_D1"),
		},
	}, 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.ReservationOrderResponse = armreservations.ReservationOrderResponse{
	// 	Name: to.Ptr("1f14354c-dc12-4c8d-8090-6f295a3a34aa"),
	// 	Type: to.Ptr("Microsoft.Capacity/reservationOrders"),
	// 	Etag: to.Ptr[int32](7),
	// 	ID: to.Ptr("/providers/microsoft.capacity/reservationOrders/1f14354c-dc12-4c8d-8090-6f295a3a34aa"),
	// 	Properties: &armreservations.ReservationOrderProperties{
	// 		BillingPlan: to.Ptr(armreservations.ReservationBillingPlanMonthly),
	// 		CreatedDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-08-30T03:51:49.808Z"); return t}()),
	// 		DisplayName: to.Ptr("cabri"),
	// 		ExpiryDate: to.Ptr(func() time.Time { t, _ := time.Parse("2006-01-02", "2018-08-30"); return t}()),
	// 		ExpiryDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-08-30T03:51:49.808Z"); return t}()),
	// 		OriginalQuantity: to.Ptr[int32](7),
	// 		ProvisioningState: to.Ptr(armreservations.ProvisioningStateSucceeded),
	// 		RequestDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-08-30T03:49:19.025Z"); return t}()),
	// 		Reservations: []*armreservations.ReservationResponse{
	// 			{
	// 				ID: to.Ptr("/providers/microsoft.capacity/reservationOrders/1f14354c-dc12-4c8d-8090-6f295a3a34aa/reservations/c8c926bd-fc5d-4e29-9d43-b68340ac23a6"),
	// 		}},
	// 		Term: to.Ptr(armreservations.ReservationTermP1Y),
	// 	},
	// }
}

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

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

/**
 * This sample demonstrates how to Purchase `ReservationOrder` and create resource under the specified URI.
 *
 * @summary Purchase `ReservationOrder` and create resource under the specified URI.
 * x-ms-original-file: specification/reservations/resource-manager/Microsoft.Capacity/stable/2022-11-01/examples/PurchaseReservationOrder.json
 */
async function purchase() {
  const reservationOrderId = "a075419f-44cc-497f-b68a-14ee811d48b9";
  const body = {
    appliedScopeType: "Shared",
    appliedScopes: [],
    billingPlan: "Monthly",
    billingScopeId: "/subscriptions/ed3a1871-612d-abcd-a849-c2542a68be83",
    displayName: "TestReservationOrder",
    location: "westus",
    quantity: 1,
    renew: false,
    reservedResourceProperties: { instanceFlexibility: "On" },
    reservedResourceType: "VirtualMachines",
    sku: { name: "standard_D1" },
    term: "P1Y",
  };
  const credential = new DefaultAzureCredential();
  const client = new AzureReservationAPI(credential);
  const result = await client.reservationOrder.beginPurchaseAndWait(reservationOrderId, body);
  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

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Reservations;
using Azure.ResourceManager.Reservations.Models;

// Generated from example definition: specification/reservations/resource-manager/Microsoft.Capacity/stable/2022-11-01/examples/PurchaseReservationOrder.json
// this example is just showing the usage of "ReservationOrder_Purchase" 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 TenantResource created on azure
// for more information of creating TenantResource, please refer to the document of TenantResource
var tenantResource = client.GetTenants().GetAllAsync().GetAsyncEnumerator().Current;

// get the collection of this ReservationOrderResource
ReservationOrderCollection collection = tenantResource.GetReservationOrders();

// invoke the operation
Guid reservationOrderId = Guid.Parse("a075419f-44cc-497f-b68a-14ee811d48b9");
ReservationPurchaseContent content = new ReservationPurchaseContent()
{
    SkuName = "standard_D1",
    Location = new AzureLocation("westus"),
    ReservedResourceType = ReservedResourceType.VirtualMachines,
    BillingScopeId = new ResourceIdentifier("/subscriptions/ed3a1871-612d-abcd-a849-c2542a68be83"),
    Term = ReservationTerm.P1Y,
    BillingPlan = ReservationBillingPlan.Monthly,
    Quantity = 1,
    DisplayName = "TestReservationOrder",
    AppliedScopeType = AppliedScopeType.Shared,
    AppliedScopes =
    {
    },
    IsRenewEnabled = false,
    ReservedResourceInstanceFlexibility = InstanceFlexibility.On,
};
ArmOperation<ReservationOrderResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, reservationOrderId, content);
ReservationOrderResource result = lro.Value;

// 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
ReservationOrderData 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

Exemple de réponse

Code d’état:: 200

{
  "id": "/providers/microsoft.capacity/reservationOrders/1f14354c-dc12-4c8d-8090-6f295a3a34aa",
  "type": "Microsoft.Capacity/reservationOrders",
  "name": "1f14354c-dc12-4c8d-8090-6f295a3a34aa",
  "etag": 7,
  "properties": {
    "displayName": "cabri",
    "requestDateTime": "2017-08-30T03:49:19.0252126Z",
    "createdDateTime": "2017-08-30T03:51:49.8083758Z",
    "expiryDate": "2018-08-30",
    "expiryDateTime": "2018-08-30T03:51:49.8083758Z",
    "term": "P1Y",
    "billingPlan": "Monthly",
    "provisioningState": "Succeeded",
    "reservations": [
      {
        "id": "/providers/microsoft.capacity/reservationOrders/1f14354c-dc12-4c8d-8090-6f295a3a34aa/reservations/c8c926bd-fc5d-4e29-9d43-b68340ac23a6"
      }
    ],
    "originalQuantity": 7
  }
}

Code d’état:: 202

Location: https://management.azure.com/providers/microsoft.capacity/reservationOrders/1f14354c-dc12-4c8d-8090-6f295a3a34aa?api-version=2022-11-01
Retry-After: 120

{
  "id": "/providers/microsoft.capacity/reservationOrders/1f14354c-dc12-4c8d-8090-6f295a3a34aa",
  "type": "Microsoft.Capacity/reservationOrders",
  "name": "1f14354c-dc12-4c8d-8090-6f295a3a34aa",
  "etag": 7,
  "properties": {
    "displayName": "cabri",
    "billingPlan": "Monthly",
    "requestDateTime": "2017-08-30T03:49:19.0252126Z",
    "createdDateTime": "2017-08-30T03:51:49.8083758Z",
    "expiryDate": "2018-08-30",
    "expiryDateTime": "2018-08-30T03:51:49.8083758Z",
    "term": "P1Y",
    "provisioningState": "Succeeded",
    "reservations": [
      {
        "id": "/providers/microsoft.capacity/reservationOrders/1f14354c-dc12-4c8d-8090-6f295a3a34aa/reservations/c8c926bd-fc5d-4e29-9d43-b68340ac23a6"
      }
    ],
    "originalQuantity": 7
  }
}

Définitions

Nom	Description
AppliedScopeProperties	Propriétés spécifiques au type d’étendue appliqué. Non obligatoire s’il n’est pas applicable. Requis et doivent fournir tenantId et managementGroupId si AppliedScopeType est ManagementGroup
AppliedScopeType	Type de l’étendue appliquée.
BillingCurrencyTotal	Devise et montant que le client sera facturé dans la devise locale du client pour l’achat de renouvellement. La taxe n’est pas incluse.
createdByType	Type d’identité qui a créé la ressource.
Error	Informations sur l'erreur
ErrorResponseCode	Code d’erreur décrivant la raison pour laquelle le service n’est pas en mesure de traiter la requête entrante
ExtendedErrorInfo	Informations d’erreur étendues, notamment le code d’erreur et le message d’erreur
ExtendedStatusInfo
InstanceFlexibility	L’activation de cette option applique la remise de réservation à d’autres machines virtuelles du même groupe de taille de machine virtuelle. Spécifiez uniquement pour le type de ressource réservée VirtualMachines.
Kind	Type de fournisseur de ressources à réserver.
PaymentDetail	Informations sur le paiement lié à une commande de réservation.
PaymentStatus	Indique si le paiement est terminé, a échoué, annulé ou planifié à l’avenir.
Price	Informations de tarification contenant le montant et le code monétaire
PricingCurrencyTotal	Montant utilisé par Microsoft pour l’enregistrement. Utilisé pendant le remboursement pour le calcul de la limite de remboursement. La taxe n’est pas incluse. Ce prix est verrouillé 30 jours avant l’expiration.
ProvisioningState	Représente l’état actuel de la réservation.
PurchaseRequest	Demande d’achat de réservation
RenewPropertiesResponse	Propriétés de renouvellement d’une réservation.
ReservationBillingPlan	Représentez les plans de facturation.
ReservationMergeProperties	Propriétés de la fusion de réservations
ReservationOrderBillingPlanInformation	Informations décrivant le type de plan de facturation pour cette réservation.
ReservationOrderResponse	Détails d’une commande de réservation retournée.
ReservationResponse	Définition de la réservation.
ReservationSplitProperties	Propriétés du fractionnement de réservation
ReservationsProperties	Propriétés des réservations
ReservationStatusCode
ReservationSwapProperties	Propriétés de l’échange de réservation
ReservationTerm	Représente le terme de réservation.
ReservationUtilizationAggregates	Valeurs agrégées de l’utilisation des réservations
ReservedResourceProperties	Propriétés spécifiques à chaque type de ressource réservé. Non obligatoire s’il n’est pas applicable.
ReservedResourceType	Type de la ressource réservée.
SkuName	Nom de la référence sku
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.
Utilization	Utilisation des réservations

AppliedScopeProperties

Propriétés spécifiques au type d’étendue appliqué. Non obligatoire s’il n’est pas applicable. Requis et doivent fournir tenantId et managementGroupId si AppliedScopeType est ManagementGroup

Nom	Type	Description
displayName	string	Nom d’affichage
managementGroupId	string	Identificateur complet du groupe d’administration dans lequel 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 dans lequel le plan d’économies doit appliquer l’avantage.

AppliedScopeType

Type de l’étendue appliquée.

Nom	Type	Description
ManagementGroup	string
Shared	string
Single	string

BillingCurrencyTotal

Devise et montant que le client sera facturé dans la devise locale du client pour l’achat de renouvellement. La taxe n’est pas incluse.

Nom	Type	Description
amount	number
currencyCode	string	Code de devise ISO 4217 à 3 lettres pour la devise utilisée par cet enregistrement d’achat.

createdByType

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

Nom	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

Error

Informations sur l'erreur

Nom	Type	Description
error	ExtendedErrorInfo	Informations d’erreur étendues, notamment le code d’erreur et le message d’erreur

ErrorResponseCode

Code d’erreur décrivant la raison pour laquelle le service n’est pas en mesure de traiter la requête entrante

Nom	Type	Description
ActivateQuoteFailed	string
AppliedScopesNotAssociatedWithCommerceAccount	string
AppliedScopesSameAsExisting	string
AuthorizationFailed	string
BadRequest	string
BillingCustomerInputError	string
BillingError	string
BillingPaymentInstrumentHardError	string
BillingPaymentInstrumentSoftError	string
BillingScopeIdCannotBeChanged	string
BillingTransientError	string
CalculatePriceFailed	string
CapacityUpdateScopesFailed	string
ClientCertificateThumbprintNotSet	string
CreateQuoteFailed	string
Forbidden	string
FulfillmentConfigurationError	string
FulfillmentError	string
FulfillmentOutOfStockError	string
FulfillmentTransientError	string
HttpMethodNotSupported	string
InternalServerError	string
InvalidAccessToken	string
InvalidFulfillmentRequestParameters	string
InvalidHealthCheckType	string
InvalidLocationId	string
InvalidRefundQuantity	string
InvalidRequestContent	string
InvalidRequestUri	string
InvalidReservationId	string
InvalidReservationOrderId	string
InvalidSingleAppliedScopesCount	string
InvalidSubscriptionId	string
InvalidTenantId	string
MissingAppliedScopesForSingle	string
MissingTenantId	string
NoValidReservationsToReRate	string
NonsupportedAccountId	string
NotSpecified	string
NotSupportedCountry	string
OperationCannotBePerformedInCurrentState	string
OperationFailed	string
PatchValuesSameAsExisting	string
PaymentInstrumentNotFound	string
PurchaseError	string
ReRateOnlyAllowedForEA	string
RefundLimitExceeded	string
ReservationIdNotInReservationOrder	string
ReservationOrderCreationFailed	string
ReservationOrderIdAlreadyExists	string
ReservationOrderNotEnabled	string
ReservationOrderNotFound	string
RiskCheckFailed	string
RoleAssignmentCreationFailed	string
SelfServiceRefundNotSupported	string
ServerTimeout	string
UnauthenticatedRequestsThrottled	string
UnsupportedReservationTerm	string

ExtendedErrorInfo

Informations d’erreur étendues, notamment le code d’erreur et le message d’erreur

Nom	Type	Description
code	ErrorResponseCode	Code d’erreur décrivant la raison pour laquelle le service n’est pas en mesure de traiter la requête entrante
message	string

ExtendedStatusInfo

Nom	Type	Description
message	string	Message fournissant des informations détaillées sur le code status.
statusCode	ReservationStatusCode

InstanceFlexibility

L’activation de cette option applique la remise de réservation à d’autres machines virtuelles du même groupe de taille de machine virtuelle. Spécifiez uniquement pour le type de ressource réservée VirtualMachines.

Nom	Type	Description
Off	string
On	string

Kind

Type de fournisseur de ressources à réserver.

Nom	Type	Description
Microsoft.Compute	string

PaymentDetail

Informations sur le paiement lié à une commande de réservation.

Nom	Type	Description
billingAccount	string	Affiche le compte facturé pour ce paiement.
billingCurrencyTotal	Price	Montant facturé dans la devise de facturation. Taxe non incluse. Est null pour les paiements futurs
dueDate	string	Date à laquelle le paiement doit être effectué.
extendedStatusInfo	ExtendedStatusInfo
paymentDate	string	Date à laquelle la transaction est terminée. A la valeur Null lorsqu’elle est planifiée.
pricingCurrencyTotal	Price	Montant dans la devise de tarification. Taxe non incluse.
status	PaymentStatus	Indique si le paiement est terminé, a échoué, annulé ou planifié à l’avenir.

PaymentStatus

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

Nom	Type	Description
Cancelled	string
Failed	string
Scheduled	string
Succeeded	string

Price

Informations de tarification contenant le montant et le code monétaire

Nom	Type	Description
amount	number
currencyCode	string	Code de devise ISO 4217 à 3 lettres pour la devise utilisée par cet enregistrement d’achat.

PricingCurrencyTotal

Montant utilisé par Microsoft pour l’enregistrement. Utilisé pendant le remboursement pour le calcul de la limite de remboursement. La taxe n’est pas incluse. Ce prix est verrouillé 30 jours avant l’expiration.

Nom	Type	Description
amount	number
currencyCode	string	Code de devise ISO 4217 à 3 lettres pour la devise utilisée par cet enregistrement d’achat.

ProvisioningState

Représente l’état actuel de la réservation.

Nom	Type	Description
BillingFailed	string
Cancelled	string
ConfirmedBilling	string
ConfirmedResourceHold	string
Created	string
Creating	string
Expired	string
Failed	string
Merged	string
PendingBilling	string
PendingResourceHold	string
Split	string
Succeeded	string

PurchaseRequest

Demande d’achat de réservation

Nom	Type	Valeur par défaut	Description
location	string		Région Azure où réside la ressource réservée.
properties.appliedScopeProperties	AppliedScopeProperties		Propriétés spécifiques au type d’étendue appliqué. Non obligatoire s’il n’est pas applicable. Requis et doivent fournir tenantId et managementGroupId si AppliedScopeType est ManagementGroup
properties.appliedScopeType	AppliedScopeType		Type de l’étendue appliquée.
properties.appliedScopes	string[]		Liste des abonnements auxquels l’avantage sera appliqué. Ne spécifiez pas si AppliedScopeType est Partagé. Cette propriété sera déconseillée et remplacée par appliedScopeProperties à la place pour Single AppliedScopeType.
properties.billingPlan	ReservationBillingPlan		Représentez les plans de facturation.
properties.billingScopeId	string		Abonnement qui sera facturé pour l’achat d’une réservation ou d’un plan d’économies
properties.displayName	string		Nom convivial de la réservation
properties.quantity	integer		Quantité des références SKU qui font partie de la réservation.
properties.renew	boolean	False	La définition de cette valeur sur true permet d’acheter automatiquement une nouvelle réservation à la date d’expiration.
properties.reservedResourceProperties	ReservedResourceProperties		Propriétés spécifiques à chaque type de ressource réservé. Non obligatoire s’il n’est pas applicable.
properties.reservedResourceType	ReservedResourceType		Type de la ressource réservée.
properties.reviewDateTime	string		Il s’agit de la date et de l’heure à laquelle l’avantage hybride Azure doit être examiné.
properties.term	ReservationTerm		Représente le terme de réservation.
sku	SkuName		Nom de la référence sku

RenewPropertiesResponse

Propriétés de renouvellement d’une réservation.

Nom	Type	Description
billingCurrencyTotal	BillingCurrencyTotal	Devise et montant que le client sera facturé dans la devise locale du client pour l’achat de renouvellement. La taxe n’est pas incluse.
pricingCurrencyTotal	PricingCurrencyTotal	Montant utilisé par Microsoft pour l’enregistrement. Utilisé pendant le remboursement pour le calcul de la limite de remboursement. La taxe n’est pas incluse. Ce prix est verrouillé 30 jours avant l’expiration.
purchaseProperties	PurchaseRequest	Demande d’achat de réservation

ReservationBillingPlan

Représentez les plans de facturation.

Nom	Type	Description
Monthly	string
Upfront	string

ReservationMergeProperties

Propriétés de la fusion de réservations

Nom	Type	Description
mergeDestination	string	ID de ressource de réservation créé en raison de la fusion. Le format de l’ID de ressource est /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}
mergeSources	string[]	ID de ressource de la réservation source fusionnée pour former cette réservation. Le format de l’ID de ressource est /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}

ReservationOrderBillingPlanInformation

Informations décrivant le type de plan de facturation pour cette réservation.

Nom	Type	Description
nextPaymentDueDate	string	Pour les plans de facturation périodiques, indique la date à laquelle le prochain paiement sera traité. Null lorsque total est payé.
pricingCurrencyTotal	Price	Montant d’argent à payer pour la Commande. La taxe n’est pas incluse.
startDate	string	Date de début du plan de facturation.
transactions	PaymentDetail[]	Informations sur le paiement lié à une commande de réservation.

ReservationOrderResponse

Détails d’une commande de réservation retournée.

Nom	Type	Description
etag	integer
id	string	Identificateur de la réservation
name	string	Nom de la réservation
properties.benefitStartTime	string	Il s’agit du DateTime au démarrage de l’avantage de réservation.
properties.billingPlan	ReservationBillingPlan	Représentez les plans de facturation.
properties.createdDateTime	string	Il s’agit du DateTime lors de la création de la réservation.
properties.displayName	string	Nom convivial permettant à l’utilisateur d’identifier facilement la réservation.
properties.expiryDate	string	Il s’agit de la date d’expiration de la réservation.
properties.expiryDateTime	string	Il s’agit de la date et de l’heure d’expiration de la réservation.
properties.originalQuantity	integer	Quantité totale des références SKU achetées dans la réservation.
properties.planInformation	ReservationOrderBillingPlanInformation	Informations décrivant le type de plan de facturation pour cette réservation.
properties.provisioningState	ProvisioningState	État actuel de la réservation.
properties.requestDateTime	string	Il s’agit de la DateTime à laquelle la réservation a été initialement demandée pour l’achat.
properties.reservations	ReservationResponse[]	Définition de la réservation.
properties.reviewDateTime	string	Il s’agit de la date et de l’heure à laquelle le Azure Hybrid Benefit doit être examiné.
properties.term	ReservationTerm	Représente le terme de réservation.
systemData	systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.
type	string	Type de ressource. « Microsoft.Capacity/reservations »

ReservationResponse

Définition de la réservation.

Nom	Type	Description
etag	integer
id	string	ID de ressource complet pour la ressource. Par exemple, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} »
kind	Kind	Type de fournisseur de ressources à réserver.
location	string	Région Azure où réside la ressource réservée.
name	string	nom de la ressource.
properties	ReservationsProperties	Propriétés associées à cette réservation
sku	SkuName	Informations de référence SKU associées à cette réservation
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 »

ReservationSplitProperties

Propriétés du fractionnement de réservation

Nom	Type	Description
splitDestinations	string[]	Liste des ID de ressource de destination créés en raison du fractionnement. Le format de l’ID de ressource est /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}
splitSource	string	ID de ressource de la réservation à partir de laquelle il est fractionné. Le format de l’ID de ressource est /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}

ReservationsProperties

Propriétés des réservations

Nom	Type	Valeur par défaut	Description
appliedScopeProperties	AppliedScopeProperties		Propriétés spécifiques au type d’étendue appliqué. Non obligatoire s’il n’est pas applicable. Requis et doivent fournir tenantId et managementGroupId si AppliedScopeType est ManagementGroup
appliedScopeType	AppliedScopeType		Type d’étendue appliqué
appliedScopes	string[]		Liste des étendues appliquées
archived	boolean		Indique si la réservation est archivée
benefitStartTime	string		Il s’agit du DateTime au démarrage de l’avantage de réservation.
billingPlan	ReservationBillingPlan		Options de plan de facturation disponibles pour cette référence SKU.
billingScopeId	string		Abonnement qui sera facturé pour l’achat d’une réservation ou d’un plan d’économies
capabilities	string		Fonctionnalités de la réservation
displayName	string		Nom convivial permettant à l’utilisateur d’identifier facilement la réservation
displayProvisioningState	string		État d’approvisionnement de la réservation pour l’affichage, par exemple Réussi
effectiveDateTime	string		DateTime de la réservation commençant à partir de la date d’entrée en vigueur de cette version.
expiryDate	string		Il s’agit de la date d’expiration de la réservation.
expiryDateTime	string		Il s’agit de la date et de l’heure d’expiration de la réservation.
extendedStatusInfo	ExtendedStatusInfo		Message fournissant des informations détaillées sur le code status.
instanceFlexibility	InstanceFlexibility		Autorise l’application d’une remise de réservation sur plusieurs références SKU au sein du même groupe d’ajustement automatique. Toutes les références SKU ne prennent pas en charge instance flexibilité de taille.
lastUpdatedDateTime	string		DateTime de la dernière mise à jour de la réservation.
mergeProperties	ReservationMergeProperties		Propriétés de la fusion de réservations
provisioningState	ProvisioningState		État actuel de la réservation.
provisioningSubState	string		Sous-état d’approvisionnement de la réservation, par exemple Succeeded
purchaseDate	string		Il s’agit de la date à laquelle la réservation a été achetée.
purchaseDateTime	string		Il s’agit de la date et de l’heure d’achat de la réservation.
quantity	integer		Quantité des références SKU qui font partie de la réservation.
renew	boolean	False	La définition de cette valeur sur true permet d’acheter automatiquement une nouvelle réservation à la date d’expiration.
renewDestination	string		ID de réservation de la réservation achetée en raison d’un renouvellement. Le format de l’ID de ressource est /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}.
renewProperties	RenewPropertiesResponse		Propriétés de renouvellement d’une réservation.
renewSource	string		ID de réservation de la réservation à partir de laquelle cette réservation est renouvelée. Le format de l’ID de ressource est /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}.
reservedResourceType	ReservedResourceType		Type de la ressource réservée.
reviewDateTime	string		Il s’agit de la date et de l’heure à laquelle le Azure Hybrid Benefit doit être examiné.
skuDescription	string		Description de la référence SKU en anglais.
splitProperties	ReservationSplitProperties		Propriétés du fractionnement de réservation
swapProperties	ReservationSwapProperties		Propriétés de l’échange de réservation
term	ReservationTerm		Représente le terme de réservation.
userFriendlyAppliedScopeType	string		Type d’étendue appliqué de la réservation pour l’affichage, par exemple Partagé
userFriendlyRenewState	string		État de renouvellement de la réservation pour l’affichage, par exemple Activé
utilization	Utilization		Utilisation des réservations

ReservationStatusCode

Nom	Type	Description
Active	string
Expired	string
Merged	string
None	string
PaymentInstrumentError	string
Pending	string
Processing	string
PurchaseError	string
Split	string
Succeeded	string

ReservationSwapProperties

Propriétés de l’échange de réservation

Nom	Type	Description
swapDestination	string	ID de ressource de réservation vers lequel la ressource d’origine est permutée. Le format de l’ID de ressource est /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}
swapSource	string	ID de ressource de la réservation source qui est permutée. Le format de l’ID de ressource est /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}

ReservationTerm

Représente le terme de réservation.

Nom	Type	Description
P1Y	string
P3Y	string
P5Y	string

ReservationUtilizationAggregates

Valeurs agrégées de l’utilisation des réservations

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

ReservedResourceProperties

Propriétés spécifiques à chaque type de ressource réservé. Non obligatoire s’il n’est pas applicable.

Nom	Type	Description
instanceFlexibility	InstanceFlexibility	L’activation de cette option applique la remise de réservation à d’autres machines virtuelles du même groupe de taille de machine virtuelle. Spécifiez uniquement pour le type de ressource réservée VirtualMachines.

ReservedResourceType

Type de la ressource réservée.

Nom	Type	Description
AVS	string
AppService	string
AzureDataExplorer	string
AzureFiles	string
BlockBlob	string
CosmosDb	string
DataFactory	string
Databricks	string
DedicatedHost	string
ManagedDisk	string
MariaDb	string
MySql	string
NetAppStorage	string
PostgreSql	string
RedHat	string
RedHatOsa	string
RedisCache	string
SapHana	string
SqlAzureHybridBenefit	string
SqlDataWarehouse	string
SqlDatabases	string
SqlEdge	string
SuseLinux	string
VMwareCloudSimple	string
VirtualMachineSoftware	string
VirtualMachines	string

SkuName

Nom de la référence sku

Nom	Type	Description
name	string

systemData

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

Nom	Type	Description
createdAt	string	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	Horodatage de la dernière modification de la 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.

Utilization

Utilisation des réservations

Nom	Type	Description
aggregates	ReservationUtilizationAggregates[]	Tableau des agrégats de l’utilisation d’une réservation
trend	string	tendance d’utilisation des 7 derniers jours pour une réservation