Reservation Order - List

Serviço:

Reserved VM Instances

Versão da API:

2022-11-01

Obter todos os ReservationOrders.
Lista de todos os ReservationOrderaos quais o usuário tem acesso no locatário atual.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
api-version	query	True	string	Versão com suporte.

Respostas

Nome	Tipo	Description
200 OK	ReservationOrderList	Lista de ReservationOrders
Other Status Codes	Error	Erro inesperado

Exemplos

ReservationOrderList

Solicitação de exemplo

HTTP

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

Java

/**
 * Samples for ReservationOrder List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/reservations/resource-manager/Microsoft.Capacity/stable/2022-11-01/examples/GetReservationOrders.
     * json
     */
    /**
     * Sample code: ReservationOrderList.
     * 
     * @param manager Entry point to ReservationsManager.
     */
    public static void reservationOrderList(com.azure.resourcemanager.reservations.ReservationsManager manager) {
        manager.reservationOrders().list(com.azure.core.util.Context.NONE);
    }
}

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

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.reservations import AzureReservationAPI

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-reservations
# USAGE
    python get_reservation_orders.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.list()
    for item in response:
        print(item)


# x-ms-original-file: specification/reservations/resource-manager/Microsoft.Capacity/stable/2022-11-01/examples/GetReservationOrders.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/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/GetReservationOrders.json
func ExampleReservationOrderClient_NewListPager() {
	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)
	}
	pager := clientFactory.NewReservationOrderClient().NewListPager(nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ReservationOrderList = armreservations.ReservationOrderList{
		// 	Value: []*armreservations.ReservationOrderResponse{
		// 		{
		// 			Name: to.Ptr("1e6407ba-37a5-499f-80ed-a3f0f338e443"),
		// 			Type: to.Ptr("Microsoft.Capacity/reservationOrders"),
		// 			Etag: to.Ptr[int32](7),
		// 			ID: to.Ptr("/providers/microsoft.capacity/reservationOrders/1e6407ba-37a5-499f-80ed-a3f0f338e443"),
		// 			Properties: &armreservations.ReservationOrderProperties{
		// 				BenefitStartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-08-29T21:20:23.813Z"); return t}()),
		// 				BillingPlan: to.Ptr(armreservations.ReservationBillingPlanMonthly),
		// 				CreatedDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-08-29T21:22:56.854Z"); return t}()),
		// 				DisplayName: to.Ptr("cabri"),
		// 				ExpiryDate: to.Ptr(func() time.Time { t, _ := time.Parse("2006-01-02", "2018-08-29"); return t}()),
		// 				ExpiryDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-08-29T21:20:23.813Z"); return t}()),
		// 				OriginalQuantity: to.Ptr[int32](1),
		// 				ProvisioningState: to.Ptr(armreservations.ProvisioningStateSucceeded),
		// 				RequestDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-08-29T21:20:23.813Z"); return t}()),
		// 				Reservations: []*armreservations.ReservationResponse{
		// 					{
		// 						ID: to.Ptr("/providers/microsoft.capacity/reservationOrders/1e6407ba-37a5-499f-80ed-a3f0f338e443/reservations/cae5924e-7a15-419f-a369-124f52d4a106"),
		// 				}},
		// 				Term: to.Ptr(armreservations.ReservationTermP1Y),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("1ea6e203-288e-4732-b9e1-da8bbe10c614"),
		// 			Type: to.Ptr("Microsoft.Capacity/reservationOrders"),
		// 			Etag: to.Ptr[int32](7),
		// 			ID: to.Ptr("/providers/microsoft.capacity/reservationOrders/1ea6e203-288e-4732-b9e1-da8bbe10c614"),
		// 			Properties: &armreservations.ReservationOrderProperties{
		// 				BenefitStartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-08-30T12:55:40.279Z"); return t}()),
		// 				BillingPlan: to.Ptr(armreservations.ReservationBillingPlanMonthly),
		// 				CreatedDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-08-30T12:58:20.526Z"); 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-30T12:58:20.526Z"); return t}()),
		// 				OriginalQuantity: to.Ptr[int32](9),
		// 				ProvisioningState: to.Ptr(armreservations.ProvisioningStateSucceeded),
		// 				RequestDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-08-30T12:55:40.279Z"); return t}()),
		// 				Reservations: []*armreservations.ReservationResponse{
		// 					{
		// 						ID: to.Ptr("/providers/microsoft.capacity/reservationOrders/1ea6e203-288e-4732-b9e1-da8bbe10c614/reservations/d04fd48d-e3f6-42a3-a8f6-1ad0b7513e48"),
		// 				}},
		// 				Term: to.Ptr(armreservations.ReservationTermP1Y),
		// 			},
		// 		},
		// 		{
		// 			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{
		// 				BenefitStartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-08-30T03:49:19.025Z"); return t}()),
		// 				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 List of all the `ReservationOrder`s that the user has access to in the current tenant.
 *
 * @summary List of all the `ReservationOrder`s that the user has access to in the current tenant.
 * x-ms-original-file: specification/reservations/resource-manager/Microsoft.Capacity/stable/2022-11-01/examples/GetReservationOrders.json
 */
async function reservationOrderList() {
  const credential = new DefaultAzureCredential();
  const client = new AzureReservationAPI(credential);
  const resArray = new Array();
  for await (let item of client.reservationOrder.list()) {
    resArray.push(item);
  }
  console.log(resArray);
}

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 Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Reservations.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Reservations;

// Generated from example definition: specification/reservations/resource-manager/Microsoft.Capacity/stable/2022-11-01/examples/GetReservationOrders.json
// this example is just showing the usage of "ReservationOrder_List" 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);

TenantResource tenantResource = client.GetTenants().GetAllAsync().GetAsyncEnumerator().Current;

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

// invoke the operation and iterate over the result
await foreach (ReservationOrderResource item in collection.GetAllAsync())
{
    // the variable item 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 = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

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

Resposta de exemplo

Código de status:

200

{
  "value": [
    {
      "id": "/providers/microsoft.capacity/reservationOrders/1e6407ba-37a5-499f-80ed-a3f0f338e443",
      "type": "Microsoft.Capacity/reservationOrders",
      "name": "1e6407ba-37a5-499f-80ed-a3f0f338e443",
      "etag": 7,
      "properties": {
        "displayName": "cabri",
        "requestDateTime": "2017-08-29T21:20:23.8134834Z",
        "createdDateTime": "2017-08-29T21:22:56.8541664Z",
        "benefitStartTime": "2017-08-29T21:20:23.8134834Z",
        "expiryDate": "2018-08-29",
        "expiryDateTime": "2018-08-29T21:20:23.8134834Z",
        "term": "P1Y",
        "billingPlan": "Monthly",
        "provisioningState": "Succeeded",
        "reservations": [
          {
            "id": "/providers/microsoft.capacity/reservationOrders/1e6407ba-37a5-499f-80ed-a3f0f338e443/reservations/cae5924e-7a15-419f-a369-124f52d4a106"
          }
        ],
        "originalQuantity": 1
      }
    },
    {
      "id": "/providers/microsoft.capacity/reservationOrders/1ea6e203-288e-4732-b9e1-da8bbe10c614",
      "type": "Microsoft.Capacity/reservationOrders",
      "name": "1ea6e203-288e-4732-b9e1-da8bbe10c614",
      "etag": 7,
      "properties": {
        "displayName": "cabri",
        "benefitStartTime": "2017-08-30T12:55:40.2799114Z",
        "requestDateTime": "2017-08-30T12:55:40.2799114Z",
        "createdDateTime": "2017-08-30T12:58:20.526Z",
        "expiryDate": "2018-08-30",
        "expiryDateTime": "2018-08-30T12:58:20.526Z",
        "term": "P1Y",
        "billingPlan": "Monthly",
        "provisioningState": "Succeeded",
        "reservations": [
          {
            "id": "/providers/microsoft.capacity/reservationOrders/1ea6e203-288e-4732-b9e1-da8bbe10c614/reservations/d04fd48d-e3f6-42a3-a8f6-1ad0b7513e48"
          }
        ],
        "originalQuantity": 9
      }
    },
    {
      "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",
        "benefitStartTime": "2017-08-30T03:49:19.0252126Z",
        "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
      }
    }
  ],
  "nextLink": "https://management.azure.com/providers/Microsoft.Capacity/reservationOrders?api-version=2017-11-01&%24skiptoken=eyJyZyI6IjIwNTkyMzdlLWY3MmYtNDczYi1hNTZiLWExOGJkM2UwMDhlZCIsImlnIjpudWxsLCJzdCI6bnVsbH0%3d"
}

Definições

Nome	Description
AppliedScopeProperties	Propriedades específicas para o tipo de escopo aplicado. Não é necessário se não for aplicável. Necessário e necessário para fornecer tenantId e managementGroupId se AppliedScopeType for ManagementGroup
AppliedScopeType	Tipo do Escopo Aplicado.
BillingCurrencyTotal	Moeda e 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 relacionadas a um pedido de reserva.
PaymentStatus	Descreve se o pagamento foi concluído, com falha, 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.
ReservationOrderList	Lista de ReservationOrders
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 de reserva

AppliedScopeProperties

Objeto

Propriedades específicas para o tipo de escopo aplicado. Não é necessário se não for aplicável. Necessário e necessário para 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 poupança deve aplicar o benefício.

AppliedScopeType

Enumeração

Tipo do Escopo Aplicado.

Valor	Description
ManagementGroup
Shared
Single

BillingCurrencyTotal

Objeto

Moeda e 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

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
Application
Key
ManagedIdentity
User

Error

Objeto

Informações de erro

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

ErrorResponseCode

Enumeração

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

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

ExtendedErrorInfo

Objeto

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

Objeto

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

InstanceFlexibility

Enumeração

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.

Valor	Description
Off
On

Kind

Enumeração

Tipo de Provedor de Recursos a ser reservado.

Valor	Description
Microsoft.Compute

PaymentDetail

Objeto

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

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

PaymentStatus

Enumeração

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

Valor	Description
Cancelled
Failed
Scheduled
Succeeded

Price

Objeto

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

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

PricingCurrencyTotal

Objeto

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

Enumeração

Represente o estado atual da Reserva.

Valor	Description
BillingFailed
Cancelled
ConfirmedBilling
ConfirmedResourceHold
Created
Creating
Expired
Failed
Merged
PendingBilling
PendingResourceHold
Split
Succeeded

PurchaseRequest

Objeto

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. Necessário e necessário para 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 disso, para Single AppliedScopeType.
properties.billingPlan	ReservationBillingPlan		Represente os planos de cobrança.
properties.billingScopeId	string		Assinatura que será cobrada pelo plano de reserva ou poupança de compra
properties.displayName	string		Nome amigável da reserva
properties.quantity	integer (int32)		Quantidade de skus que fazem parte da reserva.
properties.renew	boolean	False	Definir isso como true comprará automaticamente uma nova reserva na hora da 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 (date-time)		Essa é a data e hora em que o benefício híbrido do Azure precisa ser revisto.
properties.term	ReservationTerm		Represente o termo de reserva.
sku	SkuName		O nome do sku

RenewPropertiesResponse

Objeto

As propriedades de renovação de uma reserva.

Nome	Tipo	Description
billingCurrencyTotal	BillingCurrencyTotal	Moeda e 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

Enumeração

Represente os planos de cobrança.

Valor	Description
Monthly
Upfront

ReservationMergeProperties

Objeto

Propriedades da mesclagem de reserva

Nome	Tipo	Description
mergeDestination	string	ID de recurso de reserva criada 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

Objeto

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

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

ReservationOrderList

Objeto

Lista de ReservationOrders

Nome	Tipo	Description
nextLink	string	Url para obter a próxima página de reservationOrders.
value	ReservationOrderResponse[]	Detalhes de um pedido de reserva sendo retornado.

ReservationOrderResponse

Objeto

Detalhes de um pedido de reserva sendo retornado.

Nome	Tipo	Description
etag	integer (int32)
id	string	Identificador da reserva
name	string	Nome da reserva
properties.benefitStartTime	string (date-time)	Este é o DateTime quando o benefício de reserva foi iniciado.
properties.billingPlan	ReservationBillingPlan	Represente os planos de cobrança.
properties.createdDateTime	string (date-time)	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 (date)	Esta é a data em que a reserva expirará.
properties.expiryDateTime	string (date-time)	Essa é a data e hora em que a reserva expirará.
properties.originalQuantity	integer (int32)	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 (date-time)	Este é o DateTime quando a reserva foi inicialmente solicitada para compra.
properties.reservations	ReservationResponse[]	A definição da reserva.
properties.reviewDateTime	string (date-time)	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

Objeto

A definição da reserva.

Nome	Tipo	Description
etag	integer (int32)
id	string (arm-id)	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	Metadados do Azure Resource Manager que contêm informações createdBy e modifiedBy.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

ReservationSplitProperties

Objeto

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

Objeto

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. Necessário e necessário para 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 (date-time)		Este é 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 pelo plano de reserva ou poupança de compra
capabilities	string		Recursos 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 (date-time)		DateTime da reserva a partir de quando essa versão é efetivada.
expiryDate	string (date)		Esta é a data em que a reserva expirará.
expiryDateTime	string (date-time)		Essa é a data e hora em que a reserva expirará.
extendedStatusInfo	ExtendedStatusInfo		A mensagem que dá informações detalhadas sobre o código de status.
instanceFlexibility	InstanceFlexibility		Permite que o desconto de reserva seja aplicado entre skus no mesmo grupo de ajuste automático. Nem todos os skus dão suporte à flexibilidade de tamanho da instância.
lastUpdatedDateTime	string (date-time)		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 (date)		Esta é a data em que a reserva foi comprada.
purchaseDateTime	string (date-time)		Essa é a data e hora em que a reserva foi comprada.
quantity	integer (int32)		Quantidade de skus que fazem parte da reserva.
renew	boolean	False	Definir isso como true comprará automaticamente uma nova reserva na hora da data de validade.
renewDestination	string		ID de reserva da reserva que é comprada por causa da 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 (date-time)		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, On
utilization	Utilization		Utilização de reserva

ReservationStatusCode

Enumeração

Valor	Description
Active
Expired
Merged
None
PaymentInstrumentError
Pending
Processing
PurchaseError
Split
Succeeded

ReservationSwapProperties

Objeto

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

Enumeração

Represente o termo de reserva.

Valor	Description
P1Y
P3Y
P5Y

ReservationUtilizationAggregates

Objeto

Os valores agregados da utilização da reserva

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

ReservedResourceProperties

Objeto

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

Enumeração

O tipo do recurso que está sendo reservado.

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

SkuName

Objeto

O nome do sku

Nome	Tipo	Description
name	string

systemData

Objeto

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

Nome	Tipo	Description
createdAt	string (date-time)	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 (date-time)	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

Objeto

Utilização de reserva

Nome	Tipo	Description
aggregates	ReservationUtilizationAggregates[]	A matriz de agregações da utilização de uma reserva
trend	string	Tendência de utilização do último dia 7 para uma reserva