Reservation Order - Purchase

Service:

Reserved VM Instances

API Version:

2022-11-01

Compre ReservationOrder e crie recursos sob o URI especificado.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
reservationOrderId	path	True	string	ID do pedido da reserva
api-version	query	True	string	Versão compatível.

Corpo da solicitação

Nome	Tipo	Description
location	string	A região do Azure em que o recurso reservado reside.
properties.appliedScopeProperties	AppliedScopeProperties	Propriedades específicas para o tipo de escopo aplicado. Não é necessário se não for aplicável. Obrigatório e precisa fornecer tenantId e managementGroupId se AppliedScopeType for ManagementGroup
properties.appliedScopeType	AppliedScopeType	Tipo do Escopo Aplicado.
properties.appliedScopes	string[]	Lista das assinaturas que o benefício será aplicado. Não especifique se AppliedScopeType é Compartilhado. Essa propriedade será preterida e substituída por appliedScopeProperties em vez de Single AppliedScopeType.
properties.billingPlan	ReservationBillingPlan	Represente os planos de cobrança.
properties.billingScopeId	string	Assinatura que será cobrada para comprar reserva ou plano de economia
properties.displayName	string	Nome amigável da reserva
properties.quantity	integer	Quantidade dos skus que fazem parte da reserva.
properties.renew	boolean	Definir isso como true comprará automaticamente uma nova reserva na data de validade.
properties.reservedResourceProperties	ReservedResourceProperties	Propriedades específicas para cada tipo de recurso reservado. Não é necessário se não for aplicável.
properties.reservedResourceType	ReservedResourceType	O tipo do recurso que está sendo reservado.
properties.reviewDateTime	string	Essa é a data e hora em que o benefício híbrido do Azure precisa ser revisado.
properties.term	ReservationTerm	Represente o termo de reserva.
sku	SkuName	O nome do sku

Respostas

Nome	Tipo	Description
200 OK	ReservationOrderResponse	O recurso foi criado
202 Accepted	ReservationOrderResponse	A solicitação é aceita e está sendo processada. O link de resultado da operação está no cabeçalho do local. Headers Location: string Retry-After: integer
Other Status Codes	Error	Erro inesperado

Exemplos

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

Definições

Nome	Description
AppliedScopeProperties	Propriedades específicas para o tipo de escopo aplicado. Não é necessário se não for aplicável. Obrigatório e precisa fornecer tenantId e managementGroupId se AppliedScopeType for ManagementGroup
AppliedScopeType	Tipo do Escopo Aplicado.
BillingCurrencyTotal	Conversor de Moedas e o valor que o cliente será cobrado na moeda local do cliente para compra de renovação. O imposto não está incluído.
createdByType	O tipo de identidade que criou o recurso.
Error	Informações de erro
ErrorResponseCode	Código de erro que descreve o motivo pelo qual o serviço não é capaz de processar a solicitação de entrada
ExtendedErrorInfo	Informações de erro estendidas, incluindo código de erro e mensagem de erro
ExtendedStatusInfo
InstanceFlexibility	Ativar isso aplicará o desconto de reserva a outras VMs no mesmo grupo de tamanho de VM. Especifique apenas para o tipo de recurso reservado VirtualMachines.
Kind	Tipo de provedor de recursos a ser reservado.
PaymentDetail	Informações sobre o pagamento relacionado a um pedido de reserva.
PaymentStatus	Descreve se o pagamento foi concluído, falhou, foi cancelado ou agendado no futuro.
Price	Informações de preços que contêm o valor e o código de moeda
PricingCurrencyTotal	Valor que a Microsoft usa para registro. Usado durante o reembolso para calcular o limite de reembolso. O imposto não está incluído. Esse preço é bloqueado 30 dias antes da expiração.
ProvisioningState	Represente o estado atual da Reserva.
PurchaseRequest	A solicitação de compra de reserva
RenewPropertiesResponse	As propriedades de renovação de uma reserva.
ReservationBillingPlan	Represente os planos de cobrança.
ReservationMergeProperties	Propriedades da mesclagem de reserva
ReservationOrderBillingPlanInformation	Informações que descrevem o tipo de plano de cobrança para essa reserva.
ReservationOrderResponse	Detalhes de um pedido de reserva sendo retornado.
ReservationResponse	A definição da reserva.
ReservationSplitProperties	Propriedades da divisão de reserva
ReservationsProperties	As propriedades das reservas
ReservationStatusCode
ReservationSwapProperties	Propriedades da troca de reserva
ReservationTerm	Represente o termo de reserva.
ReservationUtilizationAggregates	Os valores agregados da utilização da reserva
ReservedResourceProperties	Propriedades específicas para cada tipo de recurso reservado. Não é necessário se não for aplicável.
ReservedResourceType	O tipo do recurso que está sendo reservado.
SkuName	O nome do sku
systemData	Metadados relativos à criação e à última modificação do recurso.
Utilization	Utilização da reserva

AppliedScopeProperties

Propriedades específicas para o tipo de escopo aplicado. Não é necessário se não for aplicável. Obrigatório e precisa fornecer tenantId e managementGroupId se AppliedScopeType for ManagementGroup

Nome	Tipo	Description
displayName	string	Nome de exibição
managementGroupId	string	Identificador totalmente qualificado do grupo de gerenciamento em que o benefício deve ser aplicado.
resourceGroupId	string	Identificador totalmente qualificado do grupo de recursos.
subscriptionId	string	Identificador totalmente qualificado da assinatura.
tenantId	string	ID do locatário em que o plano de economia deve aplicar benefício.

AppliedScopeType

Tipo do Escopo Aplicado.

Nome	Tipo	Description
ManagementGroup	string
Shared	string
Single	string

BillingCurrencyTotal

Conversor de Moedas e o valor que o cliente será cobrado na moeda local do cliente para compra de renovação. O imposto não está incluído.

Nome	Tipo	Description
amount	number
currencyCode	string	O código de moeda iso 4217 de 3 letras para a moeda usada por este registro de compra.

createdByType

O tipo de identidade que criou o recurso.

Nome	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

Error

Informações de erro

Nome	Tipo	Description
error	ExtendedErrorInfo	Informações de erro estendidas, incluindo código de erro e mensagem de erro

ErrorResponseCode

Código de erro que descreve o motivo pelo qual o serviço não é capaz de processar a solicitação de entrada

Nome	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

Informações de erro estendidas, incluindo código de erro e mensagem de erro

Nome	Tipo	Description
code	ErrorResponseCode	Código de erro que descreve o motivo pelo qual o serviço não é capaz de processar a solicitação de entrada
message	string

ExtendedStatusInfo

Nome	Tipo	Description
message	string	A mensagem que fornece informações detalhadas sobre o código status.
statusCode	ReservationStatusCode

InstanceFlexibility

Ativar isso aplicará o desconto de reserva a outras VMs no mesmo grupo de tamanho de VM. Especifique apenas para o tipo de recurso reservado VirtualMachines.

Nome	Tipo	Description
Off	string
On	string

Kind

Tipo de provedor de recursos a ser reservado.

Nome	Tipo	Description
Microsoft.Compute	string

PaymentDetail

Informações sobre o pagamento relacionado a um pedido de reserva.

Nome	Tipo	Description
billingAccount	string	Mostra a Conta que é cobrada para esse pagamento.
billingCurrencyTotal	Price	Valor cobrado em Moeda de cobrança. Imposto não incluído. É nulo para pagamentos futuros
dueDate	string	Data em que o pagamento precisa ser feito.
extendedStatusInfo	ExtendedStatusInfo
paymentDate	string	Data em que a transação é concluída. É nulo quando está agendado.
pricingCurrencyTotal	Price	Valor em moeda de preços. Imposto não incluído.
status	PaymentStatus	Descreve se o pagamento foi concluído, falhou, foi cancelado ou agendado no futuro.

PaymentStatus

Descreve se o pagamento foi concluído, falhou, foi cancelado ou agendado no futuro.

Nome	Tipo	Description
Cancelled	string
Failed	string
Scheduled	string
Succeeded	string

Price

Informações de preços que contêm o valor e o código de moeda

Nome	Tipo	Description
amount	number
currencyCode	string	O código de moeda iso 4217 de 3 letras para a moeda usada por este registro de compra.

PricingCurrencyTotal

Valor que a Microsoft usa para registro. Usado durante o reembolso para calcular o limite de reembolso. O imposto não está incluído. Esse preço é bloqueado 30 dias antes da expiração.

Nome	Tipo	Description
amount	number
currencyCode	string	O código de moeda iso 4217 de 3 letras para a moeda usada por este registro de compra.

ProvisioningState

Represente o estado atual da Reserva.

Nome	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

A solicitação de compra de reserva

Nome	Tipo	Valor padrão	Description
location	string		A região do Azure em que o recurso reservado reside.
properties.appliedScopeProperties	AppliedScopeProperties		Propriedades específicas para o tipo de escopo aplicado. Não é necessário se não for aplicável. Obrigatório e precisa fornecer tenantId e managementGroupId se AppliedScopeType for ManagementGroup
properties.appliedScopeType	AppliedScopeType		Tipo do Escopo Aplicado.
properties.appliedScopes	string[]		Lista das assinaturas que o benefício será aplicado. Não especifique se AppliedScopeType é Compartilhado. Essa propriedade será preterida e substituída por appliedScopeProperties em vez de Single AppliedScopeType.
properties.billingPlan	ReservationBillingPlan		Represente os planos de cobrança.
properties.billingScopeId	string		Assinatura que será cobrada para comprar reserva ou plano de economia
properties.displayName	string		Nome amigável da reserva
properties.quantity	integer		Quantidade dos skus que fazem parte da reserva.
properties.renew	boolean	False	Definir isso como true comprará automaticamente uma nova reserva na data de validade.
properties.reservedResourceProperties	ReservedResourceProperties		Propriedades específicas para cada tipo de recurso reservado. Não é necessário se não for aplicável.
properties.reservedResourceType	ReservedResourceType		O tipo do recurso que está sendo reservado.
properties.reviewDateTime	string		Essa é a data e hora em que o benefício híbrido do Azure precisa ser revisado.
properties.term	ReservationTerm		Represente o termo de reserva.
sku	SkuName		O nome do sku

RenewPropertiesResponse

As propriedades de renovação de uma reserva.

Nome	Tipo	Description
billingCurrencyTotal	BillingCurrencyTotal	Conversor de Moedas e o valor que o cliente será cobrado na moeda local do cliente para compra de renovação. O imposto não está incluído.
pricingCurrencyTotal	PricingCurrencyTotal	Valor que a Microsoft usa para registro. Usado durante o reembolso para calcular o limite de reembolso. O imposto não está incluído. Esse preço é bloqueado 30 dias antes da expiração.
purchaseProperties	PurchaseRequest	A solicitação de compra de reserva

ReservationBillingPlan

Represente os planos de cobrança.

Nome	Tipo	Description
Monthly	string
Upfront	string

ReservationMergeProperties

Propriedades da mesclagem de reserva

Nome	Tipo	Description
mergeDestination	string	ID do recurso de reserva Criado devido à mesclagem. O formato da ID do recurso é /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}
mergeSources	string[]	IDs de recurso da reserva de origem mescladas para formar essa reserva. O formato da ID do recurso é /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}

ReservationOrderBillingPlanInformation

Informações que descrevem o tipo de plano de cobrança para essa reserva.

Nome	Tipo	Description
nextPaymentDueDate	string	Para planos de cobrança recorrentes, indica a data em que o próximo pagamento será processado. Nulo quando o total é pago.
pricingCurrencyTotal	Price	Quantidade de dinheiro a ser pago pelo Pedido. O imposto não está incluído.
startDate	string	Data em que o plano de cobrança foi iniciado.
transactions	PaymentDetail[]	Informações sobre o pagamento relacionado a um pedido de reserva.

ReservationOrderResponse

Detalhes de um pedido de reserva sendo retornado.

Nome	Tipo	Description
etag	integer
id	string	Identificador da reserva
name	string	Nome da reserva
properties.benefitStartTime	string	Esse é o DateTime quando o benefício de reserva foi iniciado.
properties.billingPlan	ReservationBillingPlan	Represente os planos de cobrança.
properties.createdDateTime	string	Esse é o DateTime quando a reserva foi criada.
properties.displayName	string	Nome amigável para o usuário identificar facilmente a reserva.
properties.expiryDate	string	Essa é a data em que a reserva expirará.
properties.expiryDateTime	string	Essa é a data e hora em que a reserva expirará.
properties.originalQuantity	integer	Quantidade Total dos skus comprados na reserva.
properties.planInformation	ReservationOrderBillingPlanInformation	Informações que descrevem o tipo de plano de cobrança para essa reserva.
properties.provisioningState	ProvisioningState	Estado atual da reserva.
properties.requestDateTime	string	Esse é o DateTime quando a reserva foi inicialmente solicitada para compra.
properties.reservations	ReservationResponse[]	A definição da reserva.
properties.reviewDateTime	string	Essa é a data e hora em que o Benefício Híbrido do Azure precisa ser revisado.
properties.term	ReservationTerm	Represente o termo de reserva.
systemData	systemData	Metadados relativos à criação e à última modificação do recurso.
type	string	Tipo de recurso. "Microsoft.Capacity/reservations"

ReservationResponse

A definição da reserva.

Nome	Tipo	Description
etag	integer
id	string	ID de recurso totalmente qualificada para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind	Kind	Tipo de provedor de recursos a ser reservado.
location	string	A região do Azure em que o recurso reservado reside.
name	string	O nome do recurso
properties	ReservationsProperties	As propriedades associadas a essa reserva
sku	SkuName	As informações de sku associadas a essa reserva
systemData	systemData	Os metadados do Azure Resource Manager que contêm as informações createdBy e modifiedBy.
type	string	Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

ReservationSplitProperties

Propriedades da divisão de reserva

Nome	Tipo	Description
splitDestinations	string[]	Lista de ID de recurso de destino que são criadas devido à divisão. O formato da ID do recurso é /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}
splitSource	string	ID do recurso da reserva da qual isso é dividido. O formato da ID do recurso é /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}

ReservationsProperties

As propriedades das reservas

Nome	Tipo	Valor padrão	Description
appliedScopeProperties	AppliedScopeProperties		Propriedades específicas para o tipo de escopo aplicado. Não é necessário se não for aplicável. Obrigatório e precisa fornecer tenantId e managementGroupId se AppliedScopeType for ManagementGroup
appliedScopeType	AppliedScopeType		O tipo de escopo aplicado
appliedScopes	string[]		A lista de escopos aplicados
archived	boolean		Indica se a reserva foi arquivada
benefitStartTime	string		Esse é o DateTime quando o benefício de reserva foi iniciado.
billingPlan	ReservationBillingPlan		As opções de plano de cobrança disponíveis para esse sku.
billingScopeId	string		Assinatura que será cobrada para comprar reserva ou plano de economia
capabilities	string		Funcionalidades da reserva
displayName	string		Nome amigável para o usuário identificar facilmente a reserva
displayProvisioningState	string		O estado de provisionamento da reserva para exibição, por exemplo, Êxito
effectiveDateTime	string		DateTime da reserva a partir de quando essa versão é eficaz.
expiryDate	string		Essa é a data em que a reserva expirará.
expiryDateTime	string		Essa é a data e hora em que a reserva expirará.
extendedStatusInfo	ExtendedStatusInfo		A mensagem que fornece informações detalhadas sobre o código status.
instanceFlexibility	InstanceFlexibility		Permite que o desconto de reserva seja aplicado entre skus dentro do mesmo grupo de ajuste automático. Nem todos os skus dão suporte à flexibilidade de tamanho da instância.
lastUpdatedDateTime	string		DateTime da última vez em que a reserva foi atualizada.
mergeProperties	ReservationMergeProperties		Propriedades da mesclagem de reserva
provisioningState	ProvisioningState		Estado atual da reserva.
provisioningSubState	string		O sub-estado de provisionamento da reserva, por exemplo, Êxito
purchaseDate	string		Essa é a data em que a reserva foi comprada.
purchaseDateTime	string		Essa é a data e hora em que a reserva foi comprada.
quantity	integer		Quantidade dos skus que fazem parte da reserva.
renew	boolean	False	Definir isso como true comprará automaticamente uma nova reserva na data de validade.
renewDestination	string		ID de reserva da reserva que é adquirida devido à renovação. O formato da ID do recurso é /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}.
renewProperties	RenewPropertiesResponse		As propriedades de renovação de uma reserva.
renewSource	string		ID de reserva da reserva da qual essa reserva é renovada. O formato da ID do recurso é /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}.
reservedResourceType	ReservedResourceType		O tipo do recurso que está sendo reservado.
reviewDateTime	string		Essa é a data e hora em que o Benefício Híbrido do Azure precisa ser revisado.
skuDescription	string		Descrição do sku em inglês.
splitProperties	ReservationSplitProperties		Propriedades da divisão de reserva
swapProperties	ReservationSwapProperties		Propriedades da troca de reserva
term	ReservationTerm		Represente o termo de reserva.
userFriendlyAppliedScopeType	string		O tipo de escopo aplicado da reserva para exibição, por exemplo, Compartilhado
userFriendlyRenewState	string		O estado de renovação da reserva para exibição, por exemplo, Ativado
utilization	Utilization		Utilização da reserva

ReservationStatusCode

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

ReservationSwapProperties

Propriedades da troca de reserva

Nome	Tipo	Description
swapDestination	string	ID do recurso de reserva para a qual o recurso original é trocado. O formato da ID do recurso é /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}
swapSource	string	ID do recurso da reserva de origem que é trocada. O formato da ID do recurso é /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}

ReservationTerm

Represente o termo de reserva.

Nome	Tipo	Description
P1Y	string
P3Y	string
P5Y	string

ReservationUtilizationAggregates

Os valores agregados da utilização da reserva

Nome	Tipo	Description
grain	number	A granularidade da agregação
grainUnit	string	A unidade de granularidade da agregação
value	number	O valor agregado
valueUnit	string	A unidade de valor agregado

ReservedResourceProperties

Propriedades específicas para cada tipo de recurso reservado. Não é necessário se não for aplicável.

Nome	Tipo	Description
instanceFlexibility	InstanceFlexibility	Ativar isso aplicará o desconto de reserva a outras VMs no mesmo grupo de tamanho de VM. Especifique apenas para o tipo de recurso reservado VirtualMachines.

ReservedResourceType

O tipo do recurso que está sendo reservado.

Nome	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

O nome do sku

Nome	Tipo	Description
name	string

systemData

Metadados relativos à criação e à última modificação do recurso.

Nome	Tipo	Description
createdAt	string	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

Utilization

Utilização da reserva

Nome	Tipo	Description
aggregates	ReservationUtilizationAggregates[]	A matriz de agregações da utilização de uma reserva
trend	string	tendência de utilização dos últimos 7 dias para uma reserva