Reservation Order - Calculate
の価格を ReservationOrder
計算します。
を配置するための価格を計算します ReservationOrder
。
POST https://management.azure.com/providers/Microsoft.Capacity/calculatePrice?api-version=2022-11-01
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
api-version
|
query | True |
string |
サポートされているバージョン。 |
要求本文
名前 | 型 | 説明 |
---|---|---|
location |
string |
予約済みリソースが格納されている Azure リージョン。 |
properties.appliedScopeProperties |
適用されたスコープの種類に固有のプロパティ。 該当しない場合は必須ではありません。 AppliedScopeType が ManagementGroup の場合は、tenantId と managementGroupId を指定する必要があり、必須 |
|
properties.appliedScopeType |
適用されたスコープの種類。 |
|
properties.appliedScopes |
string[] |
特典が適用されるサブスクリプションの一覧。 AppliedScopeType が Shared かどうかを指定しないでください。 このプロパティは非推奨となり、Single AppliedScopeType の代わりに appliedScopeProperties に置き換えられます。 |
properties.billingPlan |
課金プランを表します。 |
|
properties.billingScopeId |
string |
予約または節約プランの購入に対して課金されるサブスクリプション |
properties.displayName |
string |
予約のフレンドリ名 |
properties.quantity |
integer |
予約の一部である SKU の数量。 |
properties.renew |
boolean |
これを true に設定すると、有効期限時に新しい予約が自動的に購入されます。 |
properties.reservedResourceProperties |
各予約済みリソースの種類に固有のプロパティ。 該当しない場合は必須ではありません。 |
|
properties.reservedResourceType |
予約されているリソースの種類。 |
|
properties.reviewDateTime |
string |
これは、Azure ハイブリッド特典を確認する必要がある日時です。 |
properties.term |
予約の期間を表します。 |
|
sku |
SKU の名前 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
購入の詳細な価格情報 |
|
Other Status Codes |
予期しないエラーが発生しました。 |
例
CalculatePrice
要求のサンプル
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"
}
}
}
応答のサンプル
{
"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
}
}
]
}
}
定義
名前 | 説明 |
---|---|
Applied |
適用されたスコープの種類に固有のプロパティ。 該当しない場合は必須ではありません。 AppliedScopeType が ManagementGroup の場合は、tenantId と managementGroupId を指定する必要があり、必須 |
Applied |
適用されたスコープの種類。 |
Billing |
顧客が更新購入のためにお客様の現地通貨で請求される通貨と金額。 税金は含まれていません。 |
Calculate |
の応答は、予約の価格を計算します。 |
Calculate |
価格応答を計算するためのプロパティ |
Error |
エラー情報 |
Error |
サービスが受信要求を処理できない理由を説明するエラー コード |
Extended |
エラー コードとエラー メッセージを含む拡張エラー情報 |
Extended |
|
Instance |
これをオンにすると、同じ VM サイズ グループ内の他の VM に予約割引が適用されます。 VirtualMachines の予約済みリソースの種類にのみ を指定します。 |
Payment |
予約注文に関連する支払いに関する情報。 |
Payment |
支払いが今後完了、失敗、取り消し、またはスケジュールされるかどうかを示します。 |
Price |
金額と通貨コードを含む価格情報 |
Pricing |
Microsoft がレコードに使用する金額。 払い戻し制限を計算するために払い戻し中に使用されます。 税金は含まれていません。 これは、有効期限の 30 日前にロックされた価格です。 |
Purchase |
予約購入の要求 |
Reservation |
課金プランを表します。 |
Reservation |
|
Reservation |
予約の期間を表します。 |
Reserved |
各予約済みリソースの種類に固有のプロパティ。 該当しない場合は必須ではありません。 |
Reserved |
予約されているリソースの種類。 |
Sku |
SKU の名前 |
AppliedScopeProperties
適用されたスコープの種類に固有のプロパティ。 該当しない場合は必須ではありません。 AppliedScopeType が ManagementGroup の場合は、tenantId と managementGroupId を指定する必要があり、必須
名前 | 型 | 説明 |
---|---|---|
displayName |
string |
表示名 |
managementGroupId |
string |
特典を適用する必要がある管理グループの完全修飾識別子。 |
resourceGroupId |
string |
リソース グループの完全修飾識別子。 |
subscriptionId |
string |
サブスクリプションの完全修飾識別子。 |
tenantId |
string |
節約プランが特典を適用する必要があるテナント ID。 |
AppliedScopeType
適用されたスコープの種類。
名前 | 型 | 説明 |
---|---|---|
ManagementGroup |
string |
|
Shared |
string |
|
Single |
string |
BillingCurrencyTotal
顧客が更新購入のためにお客様の現地通貨で請求される通貨と金額。 税金は含まれていません。
名前 | 型 | 説明 |
---|---|---|
amount |
number |
|
currencyCode |
string |
この購入レコードで使用される通貨の ISO 4217 3 文字の通貨コード。 |
CalculatePriceResponse
の応答は、予約の価格を計算します。
名前 | 型 | 説明 |
---|---|---|
properties |
価格応答を計算するためのプロパティ |
CalculatePriceResponseProperties
価格応答を計算するためのプロパティ
名前 | 型 | 説明 |
---|---|---|
billingCurrencyTotal |
顧客の現地通貨で請求される通貨と金額。 税金は含まれていません。 |
|
grandTotal |
number |
価格通貨の合計金額。 |
isBillingPartnerManaged |
boolean |
True を指定すると、Microsoft Partner によって課金が管理されます。 CSP アカウントにのみ使用されます。 |
isTaxIncluded |
boolean |
総計に税金が含まれているかどうか |
netTotal |
number |
価格通貨での正味合計金額。 |
paymentSchedule |
予約注文に関連する支払いに関する情報。 |
|
pricingCurrencyTotal |
Microsoft がレコードに使用する金額。 払い戻し制限を計算するために払い戻し中に使用されます。 税金は含まれていません。 |
|
reservationOrderId |
string |
価格の計算後に配置できる予約注文を表す GUID。 |
skuDescription |
string |
購入中の SKU の説明。 |
skuTitle |
string |
購入中の SKU のタイトル。 |
taxTotal |
number |
価格通貨での税額。 |
Error
エラー情報
名前 | 型 | 説明 |
---|---|---|
error |
エラー コードとエラー メッセージを含む拡張エラー情報 |
ErrorResponseCode
サービスが受信要求を処理できない理由を説明するエラー コード
名前 | 型 | 説明 |
---|---|---|
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
エラー コードとエラー メッセージを含む拡張エラー情報
名前 | 型 | 説明 |
---|---|---|
code |
サービスが受信要求を処理できない理由を説明するエラー コード |
|
message |
string |
ExtendedStatusInfo
名前 | 型 | 説明 |
---|---|---|
message |
string |
状態コードに関する詳細情報を示すメッセージ。 |
statusCode |
InstanceFlexibility
これをオンにすると、同じ VM サイズ グループ内の他の VM に予約割引が適用されます。 VirtualMachines の予約済みリソースの種類にのみ を指定します。
名前 | 型 | 説明 |
---|---|---|
Off |
string |
|
On |
string |
PaymentDetail
予約注文に関連する支払いに関する情報。
名前 | 型 | 説明 |
---|---|---|
billingAccount |
string |
この支払いに対して課金されるアカウントが表示されます。 |
billingCurrencyTotal |
請求通貨で請求される金額。 税は含まれていません。 将来の支払いの場合は null です |
|
dueDate |
string |
支払いを行う必要がある日付。 |
extendedStatusInfo | ||
paymentDate |
string |
トランザクションが完了した日付。 スケジュールされている場合は null です。 |
pricingCurrencyTotal |
価格通貨単位の金額。 税は含まれていません。 |
|
status |
支払いが今後完了、失敗、取り消し、またはスケジュールされるかどうかを示します。 |
PaymentStatus
支払いが今後完了、失敗、取り消し、またはスケジュールされるかどうかを示します。
名前 | 型 | 説明 |
---|---|---|
Cancelled |
string |
|
Failed |
string |
|
Scheduled |
string |
|
Succeeded |
string |
Price
金額と通貨コードを含む価格情報
名前 | 型 | 説明 |
---|---|---|
amount |
number |
|
currencyCode |
string |
この購入レコードで使用される通貨の ISO 4217 3 文字の通貨コード。 |
PricingCurrencyTotal
Microsoft がレコードに使用する金額。 払い戻し制限を計算するために払い戻し中に使用されます。 税金は含まれていません。 これは、有効期限の 30 日前にロックされた価格です。
名前 | 型 | 説明 |
---|---|---|
amount |
number |
|
currencyCode |
string |
この購入レコードで使用される通貨の ISO 4217 3 文字の通貨コード。 |
PurchaseRequest
予約購入の要求
名前 | 型 | 規定値 | 説明 |
---|---|---|---|
location |
string |
予約済みリソースが格納されている Azure リージョン。 |
|
properties.appliedScopeProperties |
適用されたスコープの種類に固有のプロパティ。 該当しない場合は必須ではありません。 AppliedScopeType が ManagementGroup の場合は、tenantId と managementGroupId を指定する必要があり、必須 |
||
properties.appliedScopeType |
適用されたスコープの種類。 |
||
properties.appliedScopes |
string[] |
特典が適用されるサブスクリプションの一覧。 AppliedScopeType が Shared かどうかを指定しないでください。 このプロパティは非推奨となり、Single AppliedScopeType の代わりに appliedScopeProperties に置き換えられます。 |
|
properties.billingPlan |
課金プランを表します。 |
||
properties.billingScopeId |
string |
予約または節約プランの購入に対して課金されるサブスクリプション |
|
properties.displayName |
string |
予約のフレンドリ名 |
|
properties.quantity |
integer |
予約の一部である SKU の数量。 |
|
properties.renew |
boolean |
False |
これを true に設定すると、有効期限時に新しい予約が自動的に購入されます。 |
properties.reservedResourceProperties |
各予約済みリソースの種類に固有のプロパティ。 該当しない場合は必須ではありません。 |
||
properties.reservedResourceType |
予約されているリソースの種類。 |
||
properties.reviewDateTime |
string |
これは、Azure ハイブリッド特典を確認する必要がある日時です。 |
|
properties.term |
予約の期間を表します。 |
||
sku |
SKU の名前 |
ReservationBillingPlan
課金プランを表します。
名前 | 型 | 説明 |
---|---|---|
Monthly |
string |
|
Upfront |
string |
ReservationStatusCode
名前 | 型 | 説明 |
---|---|---|
Active |
string |
|
Expired |
string |
|
Merged |
string |
|
None |
string |
|
PaymentInstrumentError |
string |
|
Pending |
string |
|
Processing |
string |
|
PurchaseError |
string |
|
Split |
string |
|
Succeeded |
string |
ReservationTerm
予約の期間を表します。
名前 | 型 | 説明 |
---|---|---|
P1Y |
string |
|
P3Y |
string |
|
P5Y |
string |
ReservedResourceProperties
各予約済みリソースの種類に固有のプロパティ。 該当しない場合は必須ではありません。
名前 | 型 | 説明 |
---|---|---|
instanceFlexibility |
これをオンにすると、同じ VM サイズ グループ内の他の VM に予約割引が適用されます。 VirtualMachines の予約済みリソースの種類にのみ を指定します。 |
ReservedResourceType
予約されているリソースの種類。
名前 | 型 | 説明 |
---|---|---|
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
SKU の名前
名前 | 型 | 説明 |
---|---|---|
name |
string |