Compartilhar via


Reservation Order - Calculate

Calcule o preço de um ReservationOrder.
Calcule o preço para colocar um ReservationOrder.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
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 pela compra de reserva ou plano de economia

properties.displayName

string

Nome amigável da reserva

properties.quantity

integer

Quantidade de 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

Representa o termo de reserva.

sku

SkuName

O nome do sku

Respostas

Nome Tipo Description
200 OK

CalculatePriceResponse

Informações detalhadas de preço para compra ReservationOrder

Other Status Codes

Error

Erro inesperado

Exemplos

CalculatePrice

Solicitação de exemplo

POST https://management.azure.com/providers/Microsoft.Capacity/calculatePrice?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"
    }
  }
}

Resposta de exemplo

{
  "properties": {
    "billingCurrencyTotal": {
      "currencyCode": "USD",
      "amount": 46
    },
    "reservationOrderId": "6d9cec54-7de8-abcd-9de7-80f5d634f2d2",
    "skuTitle": "Reserved VM Instance, Standard_D1, US West, 1 Year",
    "skuDescription": "standard_D1",
    "pricingCurrencyTotal": {
      "currencyCode": "USD",
      "amount": 46
    },
    "paymentSchedule": [
      {
        "dueDate": "2019-05-14",
        "pricingCurrencyTotal": {
          "currencyCode": "USD",
          "amount": 46
        },
        "billingCurrencyTotal": {
          "currencyCode": "EUR",
          "amount": 40
        }
      },
      {
        "dueDate": "2019-06-14",
        "pricingCurrencyTotal": {
          "currencyCode": "USD",
          "amount": 46
        }
      },
      {
        "dueDate": "2019-07-14",
        "pricingCurrencyTotal": {
          "currencyCode": "USD",
          "amount": 46
        }
      }
    ]
  }
}

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 a compra de renovação. O imposto não está incluído.

CalculatePriceResponse

A resposta de calcular o preço da reserva.

CalculatePriceResponseProperties

Propriedades para calcular a resposta de preço

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.

PaymentDetail

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

PaymentStatus

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

Price

Informações de preço 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.

PurchaseRequest

A solicitação de compra de reserva

ReservationBillingPlan

Represente os planos de cobrança.

ReservationStatusCode
ReservationTerm

Representa o termo de 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

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 o 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 a 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.

CalculatePriceResponse

A resposta de calcular o preço da reserva.

Nome Tipo Description
properties

CalculatePriceResponseProperties

Propriedades para calcular a resposta de preço

CalculatePriceResponseProperties

Propriedades para calcular a resposta de preço

Nome Tipo Description
billingCurrencyTotal

BillingCurrencyTotal

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

grandTotal

number

Valor total em moeda de preço.

isBillingPartnerManaged

boolean

True se a cobrança for gerenciada pelo Parceiro da Microsoft. Usado somente para contas CSP.

isTaxIncluded

boolean

Se o imposto está incluído ou não no total geral

netTotal

number

Valor total líquido na moeda de preços.

paymentSchedule

PaymentDetail[]

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

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.

reservationOrderId

string

GUID que representa o pedido de reserva que pode ser colocado após o cálculo do preço.

skuDescription

string

Descrição da SKU que está sendo comprada.

skuTitle

string

Título de sku que está sendo comprado.

taxTotal

number

Valor do imposto na moeda do preço.

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

PaymentDetail

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

Nome Tipo Description
billingAccount

string

Mostra a Conta cobrada por 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ço. Imposto não incluído.

status

PaymentStatus

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

PaymentStatus

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

Nome Tipo Description
Cancelled

string

Failed

string

Scheduled

string

Succeeded

string

Price

Informações de preço 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.

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 pela compra de reserva ou plano de economia

properties.displayName

string

Nome amigável da reserva

properties.quantity

integer

Quantidade de 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

Representa o termo de reserva.

sku

SkuName

O nome do sku

ReservationBillingPlan

Represente os planos de cobrança.

Nome Tipo Description
Monthly

string

Upfront

string

ReservationStatusCode

Nome Tipo Description
Active

string

Expired

string

Merged

string

None

string

PaymentInstrumentError

string

Pending

string

Processing

string

PurchaseError

string

Split

string

Succeeded

string

ReservationTerm

Representa o termo de reserva.

Nome Tipo Description
P1Y

string

P3Y

string

P5Y

string

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