Reservation Order - Purchase

Service:

Reserved VM Instances

API Version:

2022-11-01

Compre ReservationOrder y cree un recurso en el URI especificado.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
reservationOrderId	path	True	string	Id. de pedido de la reserva
api-version	query	True	string	Versión admitida.

Cuerpo de la solicitud

Nombre	Tipo	Description
location	string	Región de Azure donde reside el recurso reservado.
properties.appliedScopeProperties	AppliedScopeProperties	Propiedades específicas del tipo de ámbito aplicado. No es necesario si no es aplicable. Obligatorio y debe proporcionar tenantId y managementGroupId si AppliedScopeType es ManagementGroup
properties.appliedScopeType	AppliedScopeType	Tipo del ámbito aplicado.
properties.appliedScopes	string[]	Lista de las suscripciones a las que se aplicará la ventaja. No especifique si AppliedScopeType es Shared. Esta propiedad quedará en desuso y se reemplazará por appliedScopeProperties en su lugar para Single AppliedScopeType.
properties.billingPlan	ReservationBillingPlan	Representa los planes de facturación.
properties.billingScopeId	string	Suscripción que se cobrará por la reserva de compra o el plan de ahorro
properties.displayName	string	Nombre descriptivo de la reserva
properties.quantity	integer	Cantidad de las sku que forman parte de la reserva.
properties.renew	boolean	Si se establece en true, se adquirirá automáticamente una nueva reserva en la fecha de expiración.
properties.reservedResourceProperties	ReservedResourceProperties	Propiedades específicas de cada tipo de recurso reservado. No es necesario si no es aplicable.
properties.reservedResourceType	ReservedResourceType	Tipo del recurso que se va a reservar.
properties.reviewDateTime	string	Esta es la fecha y hora en que se debe revisar la ventaja híbrida de Azure.
properties.term	ReservationTerm	Representa el plazo de reserva.
sku	SkuName	Nombre de la SKU

Respuestas

Nombre	Tipo	Description
200 OK	ReservationOrderResponse	Se ha creado el recurso.
202 Accepted	ReservationOrderResponse	La solicitud se acepta y se está procesando. El vínculo de resultado de la operación está en el encabezado de ubicación. Headers Location: string Retry-After: integer
Other Status Codes	Error	Error inesperado

Ejemplos

Purchase

Sample Request

HTTP

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

Java

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

Python

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

Go

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

JavaScript

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

dotnet

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

Sample Response

Status code:

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

Status code:

202

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

Response Body

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

Definiciones

Nombre	Description
AppliedScopeProperties	Propiedades específicas del tipo de ámbito aplicado. No es necesario si no es aplicable. Obligatorio y debe proporcionar tenantId y managementGroupId si AppliedScopeType es ManagementGroup
AppliedScopeType	Tipo del ámbito aplicado.
BillingCurrencyTotal	Moneda y cantidad que el cliente se cobrará en la moneda local del cliente para la compra de renovación. No se incluye el impuesto.
createdByType	Tipo de identidad que creó el recurso.
Error	Información de error
ErrorResponseCode	Código de error que describe el motivo por el que el servicio no puede procesar la solicitud entrante
ExtendedErrorInfo	Información de error extendida, incluido el código de error y el mensaje de error
ExtendedStatusInfo
InstanceFlexibility	Al activar esto, se aplicará el descuento por reserva a otras máquinas virtuales del mismo grupo de tamaño de máquina virtual. Especifique solo para el tipo de recurso reservado VirtualMachines.
Kind	Tipo de proveedor de recursos que se va a reservar.
PaymentDetail	Información sobre el pago relacionado con un pedido de reserva.
PaymentStatus	Describe si el pago está completado, con errores, cancelados o programados en el futuro.
Price	Información de precios que contiene la cantidad y el código de moneda
PricingCurrencyTotal	Cantidad que Microsoft usa para el registro. Se usa durante el reembolso para calcular el límite de reembolso. No se incluye el impuesto. Este precio está bloqueado 30 días antes de la expiración.
ProvisioningState	Representa el estado actual de la reserva.
PurchaseRequest	Solicitud de compra de reserva
RenewPropertiesResponse	Propiedades de renovación de una reserva.
ReservationBillingPlan	Representa los planes de facturación.
ReservationMergeProperties	Propiedades de la combinación de reservas
ReservationOrderBillingPlanInformation	Información que describe el tipo de plan de facturación de esta reserva.
ReservationOrderResponse	Detalles de un pedido de reserva que se devuelve.
ReservationResponse	Definición de la reserva.
ReservationSplitProperties	Propiedades de división de reserva
ReservationsProperties	Propiedades de las reservas
ReservationStatusCode
ReservationSwapProperties	Propiedades del intercambio de reservas
ReservationTerm	Representa el término de la reserva.
ReservationUtilizationAggregates	Valores agregados del uso de reserva
ReservedResourceProperties	Propiedades específicas de cada tipo de recurso reservado. No es necesario si no es aplicable.
ReservedResourceType	Tipo del recurso que se está reservando.
SkuName	El nombre de la SKU
systemData	Metadatos relacionados con la creación y la última modificación del recurso.
Utilization	Uso de las reservas

AppliedScopeProperties

Propiedades específicas del tipo de ámbito aplicado. No es necesario si no es aplicable. Obligatorio y debe proporcionar tenantId y managementGroupId si AppliedScopeType es ManagementGroup

Nombre	Tipo	Description
displayName	string	Nombre para mostrar
managementGroupId	string	Identificador completo del grupo de administración en el que se debe aplicar la ventaja.
resourceGroupId	string	Identificador completo del grupo de recursos.
subscriptionId	string	Identificador completo de la suscripción.
tenantId	string	Identificador de inquilino en el que el plan de ahorro debe aplicar la ventaja.

AppliedScopeType

Tipo del ámbito aplicado.

Nombre	Tipo	Description
ManagementGroup	string
Shared	string
Single	string

BillingCurrencyTotal

Moneda y cantidad que el cliente se cobrará en la moneda local del cliente para la compra de renovación. No se incluye el impuesto.

Nombre	Tipo	Description
amount	number
currencyCode	string	El código de moneda iso 4217 de 3 letras para la moneda utilizada por este registro de compra.

createdByType

Tipo de identidad que creó el recurso.

Nombre	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

Error

Información de error

Nombre	Tipo	Description
error	ExtendedErrorInfo	Información de error extendida, incluido el código de error y el mensaje de error

ErrorResponseCode

Código de error que describe el motivo por el que el servicio no puede procesar la solicitud entrante

Nombre	Tipo	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

Información de error extendida, incluido el código de error y el mensaje de error

Nombre	Tipo	Description
code	ErrorResponseCode	Código de error que describe el motivo por el que el servicio no puede procesar la solicitud entrante
message	string

ExtendedStatusInfo

Nombre	Tipo	Description
message	string	Mensaje que proporciona información detallada sobre el código de estado.
statusCode	ReservationStatusCode

InstanceFlexibility

Al activar esto, se aplicará el descuento por reserva a otras máquinas virtuales del mismo grupo de tamaño de máquina virtual. Especifique solo para el tipo de recurso reservado VirtualMachines.

Nombre	Tipo	Description
Off	string
On	string

Kind

Tipo de proveedor de recursos que se va a reservar.

Nombre	Tipo	Description
Microsoft.Compute	string

PaymentDetail

Información sobre el pago relacionado con un pedido de reserva.

Nombre	Tipo	Description
billingAccount	string	Muestra la cuenta que se cobra por este pago.
billingCurrencyTotal	Price	Importe cargado en la moneda de facturación. Impuestos no incluidos. Es null para pagos futuros
dueDate	string	Fecha en que es necesario realizar el pago.
extendedStatusInfo	ExtendedStatusInfo
paymentDate	string	Fecha en la que se completa la transacción. Es null cuando está programado.
pricingCurrencyTotal	Price	Importe en la moneda de precios. Impuestos no incluidos.
status	PaymentStatus	Describe si el pago está completado, con errores, cancelados o programados en el futuro.

PaymentStatus

Describe si el pago está completado, con errores, cancelados o programados en el futuro.

Nombre	Tipo	Description
Cancelled	string
Failed	string
Scheduled	string
Succeeded	string

Price

Información de precios que contiene la cantidad y el código de moneda

Nombre	Tipo	Description
amount	number
currencyCode	string	El código de moneda iso 4217 de 3 letras para la moneda utilizada por este registro de compra.

PricingCurrencyTotal

Cantidad que Microsoft usa para el registro. Se usa durante el reembolso para calcular el límite de reembolso. No se incluye el impuesto. Este precio está bloqueado 30 días antes de la expiración.

Nombre	Tipo	Description
amount	number
currencyCode	string	El código de moneda iso 4217 de 3 letras para la moneda utilizada por este registro de compra.

ProvisioningState

Representa el estado actual de la reserva.

Nombre	Tipo	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

Solicitud de compra de reserva

Nombre	Tipo	Valor predeterminado	Description
location	string		Región de Azure donde reside el recurso reservado.
properties.appliedScopeProperties	AppliedScopeProperties		Propiedades específicas del tipo de ámbito aplicado. No es necesario si no es aplicable. Obligatorio y debe proporcionar tenantId y managementGroupId si AppliedScopeType es ManagementGroup
properties.appliedScopeType	AppliedScopeType		Tipo del ámbito aplicado.
properties.appliedScopes	string[]		Lista de las suscripciones a las que se aplicará la ventaja. No especifique si AppliedScopeType es Shared. Esta propiedad quedará en desuso y se reemplazará por appliedScopeProperties en su lugar para Single AppliedScopeType.
properties.billingPlan	ReservationBillingPlan		Representa los planes de facturación.
properties.billingScopeId	string		Suscripción que se cobrará por la reserva de compra o el plan de ahorro
properties.displayName	string		Nombre descriptivo de la reserva
properties.quantity	integer		Cantidad de las sku que forman parte de la reserva.
properties.renew	boolean	False	Si se establece en true, se adquirirá automáticamente una nueva reserva en la fecha de expiración.
properties.reservedResourceProperties	ReservedResourceProperties		Propiedades específicas de cada tipo de recurso reservado. No es necesario si no es aplicable.
properties.reservedResourceType	ReservedResourceType		Tipo del recurso que se está reservando.
properties.reviewDateTime	string		Esta es la fecha y hora en que se debe revisar la ventaja híbrida de Azure.
properties.term	ReservationTerm		Representa el término de la reserva.
sku	SkuName		El nombre de la SKU

RenewPropertiesResponse

Propiedades de renovación de una reserva.

Nombre	Tipo	Description
billingCurrencyTotal	BillingCurrencyTotal	Moneda y cantidad que el cliente se cobrará en la moneda local del cliente para la compra de renovación. No se incluye el impuesto.
pricingCurrencyTotal	PricingCurrencyTotal	Cantidad que Microsoft usa para el registro. Se usa durante el reembolso para calcular el límite de reembolso. No se incluye el impuesto. Este precio está bloqueado 30 días antes de la expiración.
purchaseProperties	PurchaseRequest	Solicitud de compra de reserva

ReservationBillingPlan

Representa los planes de facturación.

Nombre	Tipo	Description
Monthly	string
Upfront	string

ReservationMergeProperties

Propiedades de la combinación de reservas

Nombre	Tipo	Description
mergeDestination	string	Identificador de recurso de reserva Creado debido a la combinación. El formato del identificador de recurso es /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}
mergeSources	string[]	Identificadores de recursos de la reserva de origen combinadas para formar esta reserva. El formato del identificador de recurso es /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}

ReservationOrderBillingPlanInformation

Información que describe el tipo de plan de facturación de esta reserva.

Nombre	Tipo	Description
nextPaymentDueDate	string	En el caso de los planes de facturación periódicos, indica la fecha en que se procesará el siguiente pago. Null cuando se paga el total.
pricingCurrencyTotal	Price	Cantidad de dinero que se va a pagar por el Pedido. No se incluye el impuesto.
startDate	string	Fecha en que se inició el plan de facturación.
transactions	PaymentDetail[]	Información sobre el pago relacionado con un pedido de reserva.

ReservationOrderResponse

Detalles de un pedido de reserva que se devuelve.

Nombre	Tipo	Description
etag	integer
id	string	Identificador de la reserva
name	string	Nombre de la reserva
properties.benefitStartTime	string	Esta es la fecha y hora en que se inició la ventaja de reserva.
properties.billingPlan	ReservationBillingPlan	Representa los planes de facturación.
properties.createdDateTime	string	Esta es la fecha y hora en que se creó la reserva.
properties.displayName	string	Nombre descriptivo para que el usuario identifique fácilmente la reserva.
properties.expiryDate	string	Esta es la fecha en que expirará la reserva.
properties.expiryDateTime	string	Esta es la fecha y hora en que expirará la reserva.
properties.originalQuantity	integer	Cantidad total de las sku adquiridas en la reserva.
properties.planInformation	ReservationOrderBillingPlanInformation	Información que describe el tipo de plan de facturación de esta reserva.
properties.provisioningState	ProvisioningState	Estado actual de la reserva.
properties.requestDateTime	string	Esta es la fecha y hora en que se solicitó inicialmente la reserva para la compra.
properties.reservations	ReservationResponse[]	Definición de la reserva.
properties.reviewDateTime	string	Esta es la fecha y hora en que se debe revisar el Ventaja híbrida de Azure.
properties.term	ReservationTerm	Representa el término de la reserva.
systemData	systemData	Metadatos relacionados con la creación y la última modificación del recurso.
type	string	Tipo de recurso. "Microsoft.Capacity/reservations"

ReservationResponse

Definición de la reserva.

Nombre	Tipo	Description
etag	integer
id	string	Identificador de recurso completo del recurso. Por ejemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind	Kind	Tipo de proveedor de recursos que se va a reservar.
location	string	Región de Azure donde reside el recurso reservado.
name	string	Nombre del recurso.
properties	ReservationsProperties	Propiedades asociadas a esta reserva
sku	SkuName	Información de SKU asociada a esta reserva
systemData	systemData	Metadatos de Azure Resource Manager que contienen información sobre los valores de createdBy y modifiedBy.
type	string	Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

ReservationSplitProperties

Propiedades de división de reserva

Nombre	Tipo	Description
splitDestinations	string[]	Lista de identificadores de recursos de destino que se crean debido a la división. El formato del identificador de recurso es /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}
splitSource	string	Identificador de recurso de la reserva desde la que se divide. El formato del identificador de recurso es /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}

ReservationsProperties

Propiedades de las reservas

Nombre	Tipo	Valor predeterminado	Description
appliedScopeProperties	AppliedScopeProperties		Propiedades específicas del tipo de ámbito aplicado. No es necesario si no es aplicable. Obligatorio y necesario proporcionar tenantId y managementGroupId si AppliedScopeType es ManagementGroup
appliedScopeType	AppliedScopeType		Tipo de ámbito aplicado
appliedScopes	string[]		Lista de ámbitos aplicados
archived	boolean		Indica si la reserva está archivada.
benefitStartTime	string		Esta es la fecha y hora en que se inició la ventaja de reserva.
billingPlan	ReservationBillingPlan		Las opciones del plan de facturación disponibles para esta SKU.
billingScopeId	string		Suscripción que se cobrará por la reserva de compra o el plan de ahorro
capabilities	string		Funcionalidades de la reserva
displayName	string		Nombre descriptivo para que el usuario identifique fácilmente la reserva
displayProvisioningState	string		Estado de aprovisionamiento de la reserva para mostrar, por ejemplo, Correcto.
effectiveDateTime	string		Fecha y hora de la reserva a partir de la cual esta versión es efectiva.
expiryDate	string		Esta es la fecha en que expirará la reserva.
expiryDateTime	string		Esta es la fecha y hora en que expirará la reserva.
extendedStatusInfo	ExtendedStatusInfo		Mensaje que proporciona información detallada sobre el código de estado.
instanceFlexibility	InstanceFlexibility		Permite aplicar el descuento por reserva entre sku dentro del mismo grupo de ajuste automático. No todas las sku admiten flexibilidad de tamaño de instancia.
lastUpdatedDateTime	string		DateTime de la última vez que se actualizó la reserva.
mergeProperties	ReservationMergeProperties		Propiedades de la combinación de reservas
provisioningState	ProvisioningState		Estado actual de la reserva.
provisioningSubState	string		El subestamento de aprovisionamiento de la reserva, por ejemplo, Correcto
purchaseDate	string		Esta es la fecha en que se compró la reserva.
purchaseDateTime	string		Esta es la fecha y hora en que se compró la reserva.
quantity	integer		Cantidad de las sku que forman parte de la reserva.
renew	boolean	False	Si se establece en true, se adquirirá automáticamente una nueva reserva en la fecha de expiración.
renewDestination	string		Id. de reserva de la reserva que se compra debido a la renovación. El formato del identificador de recurso es /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}.
renewProperties	RenewPropertiesResponse		Propiedades de renovación de una reserva.
renewSource	string		Id. de reserva de la reserva desde la que se renueva esta reserva. El formato del identificador de recurso es /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}.
reservedResourceType	ReservedResourceType		Tipo del recurso que se va a reservar.
reviewDateTime	string		Esta es la fecha y hora en que se debe revisar el Ventaja híbrida de Azure.
skuDescription	string		Descripción de la SKU en inglés.
splitProperties	ReservationSplitProperties		Propiedades de división de reserva
swapProperties	ReservationSwapProperties		Propiedades del intercambio de reservas
term	ReservationTerm		Representa el plazo de reserva.
userFriendlyAppliedScopeType	string		Tipo de ámbito aplicado de la reserva para mostrar, por ejemplo, Compartido.
userFriendlyRenewState	string		Estado de renovación de la reserva para mostrar, por ejemplo, Activado
utilization	Utilization		Uso de las reservas

ReservationStatusCode

Nombre	Tipo	Description
Active	string
Expired	string
Merged	string
None	string
PaymentInstrumentError	string
Pending	string
Processing	string
PurchaseError	string
Split	string
Succeeded	string

ReservationSwapProperties

Propiedades del intercambio de reservas

Nombre	Tipo	Description
swapDestination	string	Identificador de recurso de reserva al que se intercambia el recurso original. El formato del identificador de recurso es /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}
swapSource	string	Identificador de recurso de la reserva de origen que se intercambia. El formato del identificador de recurso es /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}

ReservationTerm

Representa el término de la reserva.

Nombre	Tipo	Description
P1Y	string
P3Y	string
P5Y	string

ReservationUtilizationAggregates

Valores agregados del uso de reserva

Nombre	Tipo	Description
grain	number	El grano del agregado
grainUnit	string	Unidad de grano del agregado
value	number	Valor agregado
valueUnit	string	Unidad de valor agregado

ReservedResourceProperties

Propiedades específicas de cada tipo de recurso reservado. No es necesario si no es aplicable.

Nombre	Tipo	Description
instanceFlexibility	InstanceFlexibility	Al activar esto, se aplicará el descuento por reserva a otras máquinas virtuales del mismo grupo de tamaño de máquina virtual. Especifique solo para el tipo de recurso reservado VirtualMachines.

ReservedResourceType

Tipo del recurso que se está reservando.

Nombre	Tipo	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

El nombre de la SKU

Nombre	Tipo	Description
name	string

systemData

Metadatos relacionados con la creación y la última modificación del recurso.

Nombre	Tipo	Description
createdAt	string	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.

Utilization

Uso de las reservas

Nombre	Tipo	Description
aggregates	ReservationUtilizationAggregates[]	Matriz de agregados del uso de una reserva
trend	string	tendencia de uso de los últimos 7 días para una reserva