Reservation Order - Calculate

Calculez le prix d’un ReservationOrder.
Calculez le prix pour placer un ReservationOrder.

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

Paramètres URI

Nom Dans Obligatoire Type Description
api-version
query True

string

Version prise en charge.

Corps de la demande

Nom Type Description
location

string

Région Azure où réside la ressource réservée.

properties.appliedScopeProperties

AppliedScopeProperties

Propriétés spécifiques au type d’étendue appliqué. Non obligatoire s’il n’est pas applicable. Obligatoire et doit fournir tenantId et managementGroupId si AppliedScopeType est ManagementGroupGroup

properties.appliedScopeType

AppliedScopeType

Type de l’étendue appliquée.

properties.appliedScopes

string[]

Liste des abonnements auxquels l’avantage sera appliqué. Ne spécifiez pas si AppliedScopeType est Partagé. Cette propriété sera déconseillée et remplacée par appliedScopeProperties à la place pour Single AppliedScopeType.

properties.billingPlan

ReservationBillingPlan

Représentez les plans de facturation.

properties.billingScopeId

string

Abonnement qui sera facturé pour l’achat d’une réservation ou d’un plan d’économies

properties.displayName

string

Nom convivial de la réservation

properties.quantity

integer

Quantité des références SKU qui font partie de la réservation.

properties.renew

boolean

La définition de cette valeur sur true permet d’acheter automatiquement une nouvelle réservation à l’heure de la date d’expiration.

properties.reservedResourceProperties

ReservedResourceProperties

Propriétés spécifiques à chaque type de ressource réservée. Non obligatoire s’il n’est pas applicable.

properties.reservedResourceType

ReservedResourceType

Type de la ressource réservée.

properties.reviewDateTime

string

Il s’agit de la date-heure à laquelle l’avantage hybride Azure doit être examiné.

properties.term

ReservationTerm

Représente le terme de réservation.

sku

SkuName

Nom de la référence sku

Réponses

Nom Type Description
200 OK

CalculatePriceResponse

Informations détaillées sur les prix pour l’achat ReservationOrder

Other Status Codes

Error

Erreur inattendue

Exemples

CalculatePrice

Sample Request

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

Sample Response

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

Définitions

Nom Description
AppliedScopeProperties

Propriétés spécifiques au type d’étendue appliqué. Non obligatoire s’il n’est pas applicable. Requis et doivent fournir tenantId et managementGroupId si AppliedScopeType est ManagementGroup

AppliedScopeType

Type de l’étendue appliquée.

BillingCurrencyTotal

Devise et montant que le client sera facturé dans la devise locale du client pour l’achat de renouvellement. La taxe n’est pas incluse.

CalculatePriceResponse

Réponse de calculer le prix pour la réservation.

CalculatePriceResponseProperties

Propriétés de la réponse de calcul du prix

Error

Informations sur l'erreur

ErrorResponseCode

Code d’erreur décrivant la raison pour laquelle le service n’est pas en mesure de traiter la requête entrante

ExtendedErrorInfo

Informations d’erreur étendues, notamment le code d’erreur et le message d’erreur

ExtendedStatusInfo
InstanceFlexibility

L’activation de cette option applique la remise de réservation à d’autres machines virtuelles du même groupe de taille de machine virtuelle. Spécifiez uniquement pour le type de ressource réservée VirtualMachines.

PaymentDetail

Informations sur le paiement lié à une commande de réservation.

PaymentStatus

Indique si le paiement est terminé, a échoué, annulé ou planifié à l’avenir.

Price

Informations de tarification contenant le montant et le code monétaire

PricingCurrencyTotal

Montant utilisé par Microsoft pour l’enregistrement. Utilisé pendant le remboursement pour le calcul de la limite de remboursement. La taxe n’est pas incluse. Ce prix est verrouillé 30 jours avant l’expiration.

PurchaseRequest

Demande d’achat de réservation

ReservationBillingPlan

Représentez les plans de facturation.

ReservationStatusCode
ReservationTerm

Représente le terme de réservation.

ReservedResourceProperties

Propriétés spécifiques à chaque type de ressource réservé. Non obligatoire s’il n’est pas applicable.

ReservedResourceType

Type de la ressource réservée.

SkuName

Nom de la référence sku

AppliedScopeProperties

Propriétés spécifiques au type d’étendue appliqué. Non obligatoire s’il n’est pas applicable. Requis et doivent fournir tenantId et managementGroupId si AppliedScopeType est ManagementGroup

Nom Type Description
displayName

string

Nom d’affichage

managementGroupId

string

Identificateur complet du groupe d’administration dans lequel l’avantage doit être appliqué.

resourceGroupId

string

Identificateur complet du groupe de ressources.

subscriptionId

string

Identificateur complet de l’abonnement.

tenantId

string

ID de locataire dans lequel le plan d’économies doit appliquer l’avantage.

AppliedScopeType

Type de l’étendue appliquée.

Nom Type Description
ManagementGroup

string

Shared

string

Single

string

BillingCurrencyTotal

Devise et montant que le client sera facturé dans la devise locale du client pour l’achat de renouvellement. La taxe n’est pas incluse.

Nom Type Description
amount

number

currencyCode

string

Code de devise ISO 4217 à 3 lettres pour la devise utilisée par cet enregistrement d’achat.

CalculatePriceResponse

Réponse de calculer le prix pour la réservation.

Nom Type Description
properties

CalculatePriceResponseProperties

Propriétés de la réponse de calcul du prix

CalculatePriceResponseProperties

Propriétés de la réponse de calcul du prix

Nom Type Description
billingCurrencyTotal

BillingCurrencyTotal

Devise et montant que le client sera facturé dans la devise locale du client. La taxe n’est pas incluse.

grandTotal

number

Montant total dans la devise de tarification.

isBillingPartnerManaged

boolean

True si la facturation est gérée par Microsoft Partner. Utilisé uniquement pour les comptes CSP.

isTaxIncluded

boolean

Si la taxe est incluse ou non dans le total général

netTotal

number

Montant total net dans la devise de tarification.

paymentSchedule

PaymentDetail[]

Informations sur le paiement lié à une commande de réservation.

pricingCurrencyTotal

PricingCurrencyTotal

Montant utilisé par Microsoft pour l’enregistrement. Utilisé pendant le remboursement pour le calcul de la limite de remboursement. La taxe n’est pas incluse.

reservationOrderId

string

GUID qui représente l’ordre de réservation qui peut être placé après le calcul du prix.

skuDescription

string

Description de la référence SKU en cours d’achat.

skuTitle

string

Titre de la référence SKU en cours d’achat.

taxTotal

number

Montant de la taxe dans la devise de tarification.

Error

Informations sur l'erreur

Nom Type Description
error

ExtendedErrorInfo

Informations d’erreur étendues, notamment le code d’erreur et le message d’erreur

ErrorResponseCode

Code d’erreur décrivant la raison pour laquelle le service n’est pas en mesure de traiter la requête entrante

Nom Type 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

Informations d’erreur étendues, notamment le code d’erreur et le message d’erreur

Nom Type Description
code

ErrorResponseCode

Code d’erreur décrivant la raison pour laquelle le service n’est pas en mesure de traiter la requête entrante

message

string

ExtendedStatusInfo

Nom Type Description
message

string

Message fournissant des informations détaillées sur le code status.

statusCode

ReservationStatusCode

InstanceFlexibility

L’activation de cette option applique la remise de réservation à d’autres machines virtuelles du même groupe de taille de machine virtuelle. Spécifiez uniquement pour le type de ressource réservée VirtualMachines.

Nom Type Description
Off

string

On

string

PaymentDetail

Informations sur le paiement lié à une commande de réservation.

Nom Type Description
billingAccount

string

Affiche le compte facturé pour ce paiement.

billingCurrencyTotal

Price

Montant facturé dans la devise de facturation. Taxe non incluse. Est null pour les paiements futurs

dueDate

string

Date à laquelle le paiement doit être effectué.

extendedStatusInfo

ExtendedStatusInfo

paymentDate

string

Date à laquelle la transaction est terminée. A la valeur Null lorsqu’elle est planifiée.

pricingCurrencyTotal

Price

Montant dans la devise de tarification. Taxe non incluse.

status

PaymentStatus

Indique si le paiement est terminé, a échoué, annulé ou planifié à l’avenir.

PaymentStatus

Indique si le paiement est terminé, a échoué, annulé ou planifié à l’avenir.

Nom Type Description
Cancelled

string

Failed

string

Scheduled

string

Succeeded

string

Price

Informations de tarification contenant le montant et le code monétaire

Nom Type Description
amount

number

currencyCode

string

Code de devise ISO 4217 à 3 lettres pour la devise utilisée par cet enregistrement d’achat.

PricingCurrencyTotal

Montant utilisé par Microsoft pour l’enregistrement. Utilisé pendant le remboursement pour le calcul de la limite de remboursement. La taxe n’est pas incluse. Ce prix est verrouillé 30 jours avant l’expiration.

Nom Type Description
amount

number

currencyCode

string

Code de devise ISO 4217 à 3 lettres pour la devise utilisée par cet enregistrement d’achat.

PurchaseRequest

Demande d’achat de réservation

Nom Type Valeur par défaut Description
location

string

Région Azure où réside la ressource réservée.

properties.appliedScopeProperties

AppliedScopeProperties

Propriétés spécifiques au type d’étendue appliqué. Non obligatoire s’il n’est pas applicable. Requis et doivent fournir tenantId et managementGroupId si AppliedScopeType est ManagementGroup

properties.appliedScopeType

AppliedScopeType

Type de l’étendue appliquée.

properties.appliedScopes

string[]

Liste des abonnements auxquels l’avantage sera appliqué. Ne spécifiez pas si AppliedScopeType est Partagé. Cette propriété sera déconseillée et remplacée par appliedScopeProperties à la place pour Single AppliedScopeType.

properties.billingPlan

ReservationBillingPlan

Représentez les plans de facturation.

properties.billingScopeId

string

Abonnement qui sera facturé pour l’achat d’une réservation ou d’un plan d’économies

properties.displayName

string

Nom convivial de la réservation

properties.quantity

integer

Quantité des références SKU qui font partie de la réservation.

properties.renew

boolean

False

La définition de cette valeur sur true permet d’acheter automatiquement une nouvelle réservation à la date d’expiration.

properties.reservedResourceProperties

ReservedResourceProperties

Propriétés spécifiques à chaque type de ressource réservé. Non obligatoire s’il n’est pas applicable.

properties.reservedResourceType

ReservedResourceType

Type de la ressource réservée.

properties.reviewDateTime

string

Il s’agit de la date et de l’heure à laquelle l’avantage hybride Azure doit être examiné.

properties.term

ReservationTerm

Représente le terme de réservation.

sku

SkuName

Nom de la référence sku

ReservationBillingPlan

Représentez les plans de facturation.

Nom Type Description
Monthly

string

Upfront

string

ReservationStatusCode

Nom Type Description
Active

string

Expired

string

Merged

string

None

string

PaymentInstrumentError

string

Pending

string

Processing

string

PurchaseError

string

Split

string

Succeeded

string

ReservationTerm

Représente le terme de réservation.

Nom Type Description
P1Y

string

P3Y

string

P5Y

string

ReservedResourceProperties

Propriétés spécifiques à chaque type de ressource réservé. Non obligatoire s’il n’est pas applicable.

Nom Type Description
instanceFlexibility

InstanceFlexibility

L’activation de cette option applique la remise de réservation à d’autres machines virtuelles du même groupe de taille de machine virtuelle. Spécifiez uniquement pour le type de ressource réservée VirtualMachines.

ReservedResourceType

Type de la ressource réservée.

Nom Type 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

Nom de la référence sku

Nom Type Description
name

string