Reservation Order - Calculate
Calcular o preço de um ReservationOrder
.
Calcular o preço para colocar um ReservationOrder
.
POST https://management.azure.com/providers/Microsoft.Capacity/calculatePrice?api-version=2022-11-01
Parâmetros do URI
Name | Em | Necessário | Tipo | Description |
---|---|---|---|---|
api-version
|
query | True |
string |
Versão suportada. |
Corpo do Pedido
Name | Tipo | Description |
---|---|---|
location |
string |
A região do Azure onde reside o recurso reservado. |
properties.appliedScopeProperties |
Propriedades específicas do tipo de âmbito 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 |
Tipo do Âmbito Aplicado. |
|
properties.appliedScopes |
string[] |
Lista das subscrições às quais o benefício será aplicado. Não especifique se AppliedScopeType é Partilhado. Esta propriedade será preterida e substituída por appliedScopeProperties em vez de Single AppliedScopeType. |
properties.billingPlan |
Representar os planos de faturação. |
|
properties.billingScopeId |
string |
Subscrição que será cobrada pela compra de reserva ou plano de poupança |
properties.displayName |
string |
Nome amigável da reserva |
properties.quantity |
integer |
Quantidade de skUs que fazem parte da reserva. |
properties.renew |
boolean |
Definir isto como verdadeiro comprará automaticamente uma nova reserva na data de expiração. |
properties.reservedResourceProperties |
Propriedades específicas de cada tipo de recurso reservado. Não é necessário se não for aplicável. |
|
properties.reservedResourceType |
O tipo de recurso que está a ser reservado. |
|
properties.reviewDateTime |
string |
Esta é a data-hora em que o benefício híbrido do Azure precisa de ser revisto. |
properties.term |
Representar o termo da reserva. |
|
sku |
O nome do SKU |
Respostas
Name | Tipo | Description |
---|---|---|
200 OK |
Informações detalhadas sobre o preço para a compra |
|
Other Status Codes |
Erro inesperado |
Exemplos
CalculatePrice
Pedido de amostra
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 da amostra
{
"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
Name | Description |
---|---|
Applied |
Propriedades específicas do tipo de âmbito 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 |
Applied |
Tipo do Âmbito Aplicado. |
Billing |
Moeda e montante a que o cliente será cobrado na moeda local do cliente para compra de renovação. O imposto não está incluído. |
Calculate |
A resposta do preço de cálculo da reserva. |
Calculate |
Propriedades para calcular a resposta ao preço |
Error |
Informações de erro |
Error |
Código de erro que descreve o motivo pelo qual o serviço não consegue processar o pedido recebido |
Extended |
Informações de erro expandidas, incluindo código de erro e mensagem de erro |
Extended |
|
Instance |
Ativar esta opção aplicará o desconto de reserva a outras VMs no mesmo grupo de tamanho de VM. Especifique apenas para o tipo de recurso reservado VirtualMachines. |
Payment |
Informações sobre o pagamento relacionados com uma encomenda de reserva. |
Payment |
Descreve se o pagamento foi concluído, falhou, foi cancelado ou agendado no futuro. |
Price |
Informações de preços que contêm o montante e o código de moeda |
Pricing |
Montante que a Microsoft utiliza para registo. Utilizado durante o reembolso para calcular o limite de reembolso. O imposto não está incluído. Este preço está bloqueado 30 dias antes de expirar. |
Purchase |
O pedido de compra de reserva |
Reservation |
Representar os planos de faturação. |
Reservation |
|
Reservation |
Representar o termo da reserva. |
Reserved |
Propriedades específicas de cada tipo de recurso reservado. Não é necessário se não for aplicável. |
Reserved |
O tipo de recurso que está a ser reservado. |
Sku |
O nome do SKU |
AppliedScopeProperties
Propriedades específicas do tipo de âmbito 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
Name | Tipo | Description |
---|---|---|
displayName |
string |
Nome a apresentar |
managementGroupId |
string |
Identificador completamente qualificado do grupo de gestão onde o benefício tem de ser aplicado. |
resourceGroupId |
string |
Identificador completamente qualificado do grupo de recursos. |
subscriptionId |
string |
Identificador completamente qualificado da subscrição. |
tenantId |
string |
ID do inquilino onde o plano de poupança deve aplicar benefícios. |
AppliedScopeType
Tipo do Âmbito Aplicado.
Name | Tipo | Description |
---|---|---|
ManagementGroup |
string |
|
Shared |
string |
|
Single |
string |
BillingCurrencyTotal
Moeda e montante a que o cliente será cobrado na moeda local do cliente para compra de renovação. O imposto não está incluído.
Name | Tipo | Description |
---|---|---|
amount |
number |
|
currencyCode |
string |
O código de moeda iso 4217 de 3 letras para a moeda utilizada por este registo de compra. |
CalculatePriceResponse
A resposta do preço de cálculo da reserva.
Name | Tipo | Description |
---|---|---|
properties |
Propriedades para calcular a resposta ao preço |
CalculatePriceResponseProperties
Propriedades para calcular a resposta ao preço
Name | Tipo | Description |
---|---|---|
billingCurrencyTotal |
Moeda e montante que o cliente será cobrado na moeda local do cliente. O imposto não está incluído. |
|
grandTotal |
number |
Montante total na moeda de preços. |
isBillingPartnerManaged |
boolean |
Verdadeiro se a faturação for gerida pelo Parceiro da Microsoft. Utilizado apenas para contas CSP. |
isTaxIncluded |
boolean |
Se o imposto está ou não incluído no total geral |
netTotal |
number |
Montante total líquido na moeda de preços. |
paymentSchedule |
Informações sobre o pagamento relacionados com uma encomenda de reserva. |
|
pricingCurrencyTotal |
Montante que a Microsoft utiliza para registo. Utilizado durante o reembolso para calcular o limite de reembolso. O imposto não está incluído. |
|
reservationOrderId |
string |
GUID que representa a encomenda de reserva que pode ser feita após calcular o preço. |
skuDescription |
string |
Descrição do SKU que está a ser comprado. |
skuTitle |
string |
Título do SKU que está a ser comprado. |
taxTotal |
number |
Montante do imposto na moeda de preço. |
Error
Informações de erro
Name | Tipo | Description |
---|---|---|
error |
Informações de erro expandidas, 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 consegue processar o pedido recebido
Name | 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 expandidas, incluindo código de erro e mensagem de erro
Name | Tipo | Description |
---|---|---|
code |
Código de erro que descreve o motivo pelo qual o serviço não consegue processar o pedido recebido |
|
message |
string |
ExtendedStatusInfo
Name | Tipo | Description |
---|---|---|
message |
string |
A mensagem que fornece informações detalhadas sobre o código de estado. |
statusCode |
InstanceFlexibility
Ativar esta opção aplicará o desconto de reserva a outras VMs no mesmo grupo de tamanho de VM. Especifique apenas para o tipo de recurso reservado VirtualMachines.
Name | Tipo | Description |
---|---|---|
Off |
string |
|
On |
string |
PaymentDetail
Informações sobre o pagamento relacionados com uma encomenda de reserva.
Name | Tipo | Description |
---|---|---|
billingAccount |
string |
Mostra a Conta que é cobrada por este pagamento. |
billingCurrencyTotal |
Montante cobrado na moeda de faturação. Imposto não incluído. É nulo para pagamentos futuros |
|
dueDate |
string |
Data em que o pagamento tem de ser feito. |
extendedStatusInfo | ||
paymentDate |
string |
Data em que a transação é concluída. É nulo quando está agendado. |
pricingCurrencyTotal |
Montante em moeda de preços. Imposto não incluído. |
|
status |
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.
Name | Tipo | Description |
---|---|---|
Cancelled |
string |
|
Failed |
string |
|
Scheduled |
string |
|
Succeeded |
string |
Price
Informações de preços que contêm o montante e o código de moeda
Name | Tipo | Description |
---|---|---|
amount |
number |
|
currencyCode |
string |
O código de moeda iso 4217 de 3 letras para a moeda utilizada por este registo de compra. |
PricingCurrencyTotal
Montante que a Microsoft utiliza para registo. Utilizado durante o reembolso para calcular o limite de reembolso. O imposto não está incluído. Este preço está bloqueado 30 dias antes de expirar.
Name | Tipo | Description |
---|---|---|
amount |
number |
|
currencyCode |
string |
O código de moeda iso 4217 de 3 letras para a moeda utilizada por este registo de compra. |
PurchaseRequest
O pedido de compra de reserva
Name | Tipo | Default value | Description |
---|---|---|---|
location |
string |
A região do Azure onde reside o recurso reservado. |
|
properties.appliedScopeProperties |
Propriedades específicas do tipo de âmbito 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 |
Tipo do Âmbito Aplicado. |
||
properties.appliedScopes |
string[] |
Lista das subscrições às quais o benefício será aplicado. Não especifique se AppliedScopeType é Partilhado. Esta propriedade será preterida e substituída por appliedScopeProperties em vez de Single AppliedScopeType. |
|
properties.billingPlan |
Representar os planos de faturação. |
||
properties.billingScopeId |
string |
Subscrição que será cobrada pela compra de reserva ou plano de poupança |
|
properties.displayName |
string |
Nome amigável da reserva |
|
properties.quantity |
integer |
Quantidade de skUs que fazem parte da reserva. |
|
properties.renew |
boolean |
False |
Definir isto como verdadeiro comprará automaticamente uma nova reserva na data de expiração. |
properties.reservedResourceProperties |
Propriedades específicas de cada tipo de recurso reservado. Não é necessário se não for aplicável. |
||
properties.reservedResourceType |
O tipo de recurso que está a ser reservado. |
||
properties.reviewDateTime |
string |
Esta é a data-hora em que o benefício híbrido do Azure precisa de ser revisto. |
|
properties.term |
Representar o termo da reserva. |
||
sku |
O nome do SKU |
ReservationBillingPlan
Representar os planos de faturação.
Name | Tipo | Description |
---|---|---|
Monthly |
string |
|
Upfront |
string |
ReservationStatusCode
Name | Tipo | Description |
---|---|---|
Active |
string |
|
Expired |
string |
|
Merged |
string |
|
None |
string |
|
PaymentInstrumentError |
string |
|
Pending |
string |
|
Processing |
string |
|
PurchaseError |
string |
|
Split |
string |
|
Succeeded |
string |
ReservationTerm
Representar o termo da reserva.
Name | Tipo | Description |
---|---|---|
P1Y |
string |
|
P3Y |
string |
|
P5Y |
string |
ReservedResourceProperties
Propriedades específicas de cada tipo de recurso reservado. Não é necessário se não for aplicável.
Name | Tipo | Description |
---|---|---|
instanceFlexibility |
Ativar esta opção 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 de recurso que está a ser reservado.
Name | 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
Name | Tipo | Description |
---|---|---|
name |
string |