Reservation Order - Purchase

リファレンス

Service:: Reserved VM Instances

API Version:: 2022-11-01

指定した URI でリソースを購入 ReservationOrder して作成します。

PUT https://management.azure.com/providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}?api-version=2022-11-01

URI パラメーター

名前	/	必須	型	説明
reservationOrderId	path	True	string	予約の注文 ID
api-version	query	True	string	サポートされているバージョン。

要求本文

名前	型	説明
location	string	予約済みリソースが格納されている Azure リージョン。
properties.appliedScopeProperties	AppliedScopeProperties	適用されたスコープの種類に固有のプロパティ。該当しない場合は必須ではありません。 AppliedScopeType が ManagementGroup の場合は、tenantId と managementGroupId を指定する必要があります
properties.appliedScopeType	AppliedScopeType	適用されたスコープの種類。
properties.appliedScopes	string[]	特典が適用されるサブスクリプションの一覧。 AppliedScopeType が Shared かどうかを指定しないでください。このプロパティは非推奨となり、Single AppliedScopeType の代わりに appliedScopeProperties に置き換えられます。
properties.billingPlan	ReservationBillingPlan	課金プランを表します。
properties.billingScopeId	string	予約プランまたは節約プランの購入に対して課金されるサブスクリプション
properties.displayName	string	予約のフレンドリ名
properties.quantity	integer	予約の一部である SKU の数量。
properties.renew	boolean	これを true に設定すると、有効期限の日時に新しい予約が自動的に購入されます。
properties.reservedResourceProperties	ReservedResourceProperties	予約済みリソースの種類ごとに固有のプロパティ。該当しない場合は必須ではありません。
properties.reservedResourceType	ReservedResourceType	予約されているリソースの種類。
properties.reviewDateTime	string	これは、Azure ハイブリッド特典を確認する必要がある日時です。
properties.term	ReservationTerm	予約の期間を表します。
sku	SkuName	SKU の名前

応答

名前

型

説明

200 OK

ReservationOrderResponse

リソースが作成されました

202 Accepted

ReservationOrderResponse

要求は受け入れられ、処理中です。操作結果のリンクは location ヘッダーにあります。

Headers

Location: string
Retry-After: integer

Other Status Codes

予期しないエラーが発生しました。

例

Purchase

Sample Request

PUT https://management.azure.com/providers/Microsoft.Capacity/reservationOrders/a075419f-44cc-497f-b68a-14ee811d48b9?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"
    },
    "renew": false
  }
}

import com.azure.resourcemanager.reservations.models.AppliedScopeType;
import com.azure.resourcemanager.reservations.models.InstanceFlexibility;
import com.azure.resourcemanager.reservations.models.PurchaseRequest;
import com.azure.resourcemanager.reservations.models.PurchaseRequestPropertiesReservedResourceProperties;
import com.azure.resourcemanager.reservations.models.ReservationBillingPlan;
import com.azure.resourcemanager.reservations.models.ReservationTerm;
import com.azure.resourcemanager.reservations.models.ReservedResourceType;
import com.azure.resourcemanager.reservations.models.SkuName;

/** Samples for ReservationOrder Purchase. */
public final class Main {
    /*
     * x-ms-original-file: specification/reservations/resource-manager/Microsoft.Capacity/stable/2022-11-01/examples/PurchaseReservationOrder.json
     */
    /**
     * Sample code: Purchase.
     *
     * @param manager Entry point to ReservationsManager.
     */
    public static void purchase(com.azure.resourcemanager.reservations.ReservationsManager manager) {
        manager
            .reservationOrders()
            .purchase(
                "a075419f-44cc-497f-b68a-14ee811d48b9",
                new PurchaseRequest()
                    .withSku(new SkuName().withName("standard_D1"))
                    .withLocation("westus")
                    .withReservedResourceType(ReservedResourceType.VIRTUAL_MACHINES)
                    .withBillingScopeId("/subscriptions/ed3a1871-612d-abcd-a849-c2542a68be83")
                    .withTerm(ReservationTerm.P1Y)
                    .withBillingPlan(ReservationBillingPlan.MONTHLY)
                    .withQuantity(1)
                    .withDisplayName("TestReservationOrder")
                    .withAppliedScopeType(AppliedScopeType.SHARED)
                    .withRenew(false)
                    .withReservedResourceProperties(
                        new PurchaseRequestPropertiesReservedResourceProperties()
                            .withInstanceFlexibility(InstanceFlexibility.ON)),
                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

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

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-reservations
# USAGE
    python purchase_reservation_order.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.begin_purchase(
        reservation_order_id="a075419f-44cc-497f-b68a-14ee811d48b9",
        body={
            "location": "westus",
            "properties": {
                "appliedScopeType": "Shared",
                "appliedScopes": None,
                "billingPlan": "Monthly",
                "billingScopeId": "/subscriptions/ed3a1871-612d-abcd-a849-c2542a68be83",
                "displayName": "TestReservationOrder",
                "quantity": 1,
                "renew": False,
                "reservedResourceProperties": {"instanceFlexibility": "On"},
                "reservedResourceType": "VirtualMachines",
                "term": "P1Y",
            },
            "sku": {"name": "standard_D1"},
        },
    ).result()
    print(response)


# x-ms-original-file: specification/reservations/resource-manager/Microsoft.Capacity/stable/2022-11-01/examples/PurchaseReservationOrder.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

package armreservations_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"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/PurchaseReservationOrder.json
func ExampleReservationOrderClient_BeginPurchase() {
	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)
	}
	poller, err := clientFactory.NewReservationOrderClient().BeginPurchase(ctx, "a075419f-44cc-497f-b68a-14ee811d48b9", armreservations.PurchaseRequest{
		Location: to.Ptr("westus"),
		Properties: &armreservations.PurchaseRequestProperties{
			AppliedScopeType: to.Ptr(armreservations.AppliedScopeTypeShared),
			BillingPlan:      to.Ptr(armreservations.ReservationBillingPlanMonthly),
			BillingScopeID:   to.Ptr("/subscriptions/ed3a1871-612d-abcd-a849-c2542a68be83"),
			DisplayName:      to.Ptr("TestReservationOrder"),
			Quantity:         to.Ptr[int32](1),
			Renew:            to.Ptr(false),
			ReservedResourceProperties: &armreservations.PurchaseRequestPropertiesReservedResourceProperties{
				InstanceFlexibility: to.Ptr(armreservations.InstanceFlexibilityOn),
			},
			ReservedResourceType: to.Ptr(armreservations.ReservedResourceTypeVirtualMachines),
			Term:                 to.Ptr(armreservations.ReservationTermP1Y),
		},
		SKU: &armreservations.SKUName{
			Name: to.Ptr("standard_D1"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ReservationOrderResponse = armreservations.ReservationOrderResponse{
	// 	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{
	// 		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

const { AzureReservationAPI } = require("@azure/arm-reservations");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Purchase `ReservationOrder` and create resource under the specified URI.
 *
 * @summary Purchase `ReservationOrder` and create resource under the specified URI.
 * x-ms-original-file: specification/reservations/resource-manager/Microsoft.Capacity/stable/2022-11-01/examples/PurchaseReservationOrder.json
 */
async function purchase() {
  const reservationOrderId = "a075419f-44cc-497f-b68a-14ee811d48b9";
  const body = {
    appliedScopeType: "Shared",
    appliedScopes: [],
    billingPlan: "Monthly",
    billingScopeId: "/subscriptions/ed3a1871-612d-abcd-a849-c2542a68be83",
    displayName: "TestReservationOrder",
    location: "westus",
    quantity: 1,
    renew: false,
    reservedResourceProperties: { instanceFlexibility: "On" },
    reservedResourceType: "VirtualMachines",
    sku: { name: "standard_D1" },
    term: "P1Y",
  };
  const credential = new DefaultAzureCredential();
  const client = new AzureReservationAPI(credential);
  const result = await client.reservationOrder.beginPurchaseAndWait(reservationOrderId, body);
  console.log(result);
}

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

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Reservations;
using Azure.ResourceManager.Reservations.Models;

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

// this example assumes you already have this TenantResource created on azure
// for more information of creating TenantResource, please refer to the document of TenantResource
var tenantResource = client.GetTenants().GetAllAsync().GetAsyncEnumerator().Current;

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

// invoke the operation
Guid reservationOrderId = Guid.Parse("a075419f-44cc-497f-b68a-14ee811d48b9");
ReservationPurchaseContent content = new ReservationPurchaseContent()
{
    SkuName = "standard_D1",
    Location = new AzureLocation("westus"),
    ReservedResourceType = ReservedResourceType.VirtualMachines,
    BillingScopeId = new ResourceIdentifier("/subscriptions/ed3a1871-612d-abcd-a849-c2542a68be83"),
    Term = ReservationTerm.P1Y,
    BillingPlan = ReservationBillingPlan.Monthly,
    Quantity = 1,
    DisplayName = "TestReservationOrder",
    AppliedScopeType = AppliedScopeType.Shared,
    AppliedScopes =
    {
    },
    IsRenewEnabled = false,
    ReservedResourceInstanceFlexibility = InstanceFlexibility.On,
};
ArmOperation<ReservationOrderResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, reservationOrderId, content);
ReservationOrderResource result = lro.Value;

// the variable result 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 = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

Sample Response

Status code:: 200

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

Status code:: 202

Location: https://management.azure.com/providers/microsoft.capacity/reservationOrders/1f14354c-dc12-4c8d-8090-6f295a3a34aa?api-version=2022-11-01
Retry-After: 120

Response Body

{
  "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",
    "billingPlan": "Monthly",
    "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",
    "provisioningState": "Succeeded",
    "reservations": [
      {
        "id": "/providers/microsoft.capacity/reservationOrders/1f14354c-dc12-4c8d-8090-6f295a3a34aa/reservations/c8c926bd-fc5d-4e29-9d43-b68340ac23a6"
      }
    ],
    "originalQuantity": 7
  }
}

定義

名前	説明
AppliedScopeProperties	適用されたスコープの種類に固有のプロパティ。該当しない場合は必須ではありません。 AppliedScopeType が ManagementGroup の場合は、tenantId と managementGroupId を指定する必要があります
AppliedScopeType	適用されたスコープの種類。
BillingCurrencyTotal	顧客が更新購入のために顧客の現地通貨で請求される通貨と金額。税は含まれていません。
createdByType	リソースを作成した ID の種類。
Error	エラー情報
ErrorResponseCode	サービスが受信要求を処理できない理由を説明するエラーコード
ExtendedErrorInfo	エラーコードとエラーメッセージを含む拡張エラー情報
ExtendedStatusInfo
InstanceFlexibility	これをオンにすると、同じ VM サイズグループ内の他の VM に予約割引が適用されます。 VirtualMachines の予約済みリソースの種類にのみを指定します。
Kind	予約するリソースプロバイダーの種類。
PaymentDetail	予約注文に関連する支払いに関する情報。
PaymentStatus	支払いが将来完了、失敗、取り消し、またはスケジュールされているかどうかを示します。
Price	金額と通貨コードを含む価格情報
PricingCurrencyTotal	Microsoft がレコードに使用する金額。払い戻し制限を計算するために払い戻し中に使用されます。税は含まれていません。これは、有効期限の 30 日前に価格がロックされています。
ProvisioningState	予約の現在の状態を表します。
PurchaseRequest	予約購入の要求
RenewPropertiesResponse	予約の更新プロパティ。
ReservationBillingPlan	課金プランを表します。
ReservationMergeProperties	予約のマージのプロパティ
ReservationOrderBillingPlanInformation	この予約の課金プランの種類を説明する情報。
ReservationOrderResponse	返される予約注文の詳細。
ReservationResponse	予約の定義。
ReservationSplitProperties	予約分割のプロパティ
ReservationsProperties	予約のプロパティ
ReservationStatusCode
ReservationSwapProperties	予約スワップのプロパティ
ReservationTerm	予約の期間を表します。
ReservationUtilizationAggregates	予約使用率の集計値
ReservedResourceProperties	予約済みリソースの種類ごとに固有のプロパティ。該当しない場合は必須ではありません。
ReservedResourceType	予約されているリソースの種類。
SkuName	SKU の名前
systemData	リソースの作成と最後の変更に関連するメタデータ。
Utilization	予約の使用率

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 文字の通貨コード。

createdByType

リソースを作成した ID の種類。

名前	型	説明
Application	string
Key	string
ManagedIdentity	string
User	string

Error

エラー情報

名前	型	説明
error	ExtendedErrorInfo	エラーコードとエラーメッセージを含む拡張エラー情報

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	ErrorResponseCode	サービスが受信要求を処理できない理由を説明するエラーコード
message	string

ExtendedStatusInfo

名前	型	説明
message	string	状態コードに関する詳細情報を示すメッセージ。
statusCode	ReservationStatusCode

InstanceFlexibility

これをオンにすると、同じ VM サイズグループ内の他の VM に予約割引が適用されます。 VirtualMachines の予約済みリソースの種類にのみを指定します。

名前	型	説明
Off	string
On	string

Kind

予約するリソースプロバイダーの種類。

名前	型	説明
Microsoft.Compute	string

PaymentDetail

予約注文に関連する支払いに関する情報。

名前	型	説明
billingAccount	string	この支払いに対して課金されるアカウントを表示します。
billingCurrencyTotal	Price	課金通貨で請求される金額。税は含まれていません。将来の支払いの場合は null です
dueDate	string	支払いが必要な日付。
extendedStatusInfo	ExtendedStatusInfo
paymentDate	string	トランザクションが完了した日付。スケジュールされている場合は null です。
pricingCurrencyTotal	Price	価格通貨での金額。税は含まれていません。
status	PaymentStatus	支払いが将来完了、失敗、取り消し、またはスケジュールされているかどうかを示します。

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 文字の通貨コード。

ProvisioningState

予約の現在の状態を表します。

名前	型	説明
BillingFailed	string
Cancelled	string
ConfirmedBilling	string
ConfirmedResourceHold	string
Created	string
Creating	string
Expired	string
Failed	string
Merged	string
PendingBilling	string
PendingResourceHold	string
Split	string
Succeeded	string

PurchaseRequest

予約購入の要求

名前	型	既定値	説明
location	string		予約済みリソースが格納されている Azure リージョン。
properties.appliedScopeProperties	AppliedScopeProperties		適用されたスコープの種類に固有のプロパティ。該当しない場合は必須ではありません。 AppliedScopeType が ManagementGroup の場合は、tenantId と managementGroupId を指定する必要があります
properties.appliedScopeType	AppliedScopeType		適用されたスコープの種類。
properties.appliedScopes	string[]		特典が適用されるサブスクリプションの一覧。 AppliedScopeType が Shared かどうかを指定しないでください。このプロパティは非推奨となり、Single AppliedScopeType の代わりに appliedScopeProperties に置き換えられます。
properties.billingPlan	ReservationBillingPlan		課金プランを表します。
properties.billingScopeId	string		予約プランまたは節約プランの購入に対して課金されるサブスクリプション
properties.displayName	string		予約のフレンドリ名
properties.quantity	integer		予約の一部である SKU の数量。
properties.renew	boolean	False	これを true に設定すると、有効期限の日時に新しい予約が自動的に購入されます。
properties.reservedResourceProperties	ReservedResourceProperties		予約済みリソースの種類ごとに固有のプロパティ。該当しない場合は必須ではありません。
properties.reservedResourceType	ReservedResourceType		予約されているリソースの種類。
properties.reviewDateTime	string		これは、Azure ハイブリッド特典を確認する必要がある日時です。
properties.term	ReservationTerm		予約の期間を表します。
sku	SkuName		SKU の名前

RenewPropertiesResponse

予約の更新プロパティ。

名前	型	説明
billingCurrencyTotal	BillingCurrencyTotal	顧客が更新購入のために顧客の現地通貨で請求される通貨と金額。税は含まれていません。
pricingCurrencyTotal	PricingCurrencyTotal	Microsoft がレコードに使用する金額。払い戻し制限を計算するために払い戻し中に使用されます。税は含まれていません。これは、有効期限の 30 日前に価格がロックされています。
purchaseProperties	PurchaseRequest	予約購入の要求

ReservationBillingPlan

課金プランを表します。

名前	型	説明
Monthly	string
Upfront	string

ReservationMergeProperties

予約のマージのプロパティ

名前	型	説明
mergeDestination	string	予約リソース ID マージが原因で作成されました。リソース ID の形式は /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} です
mergeSources	string[]	この予約を形成するためにマージされたソース予約のリソース ID。リソース ID の形式は /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} です

ReservationOrderBillingPlanInformation

この予約の課金プランの種類を説明する情報。

名前	型	説明
nextPaymentDueDate	string	定期的な請求プランの場合は、次の支払いが処理される日付を示します。合計が支払われる場合は null。
pricingCurrencyTotal	Price	注文に対して支払われる金額。税は含まれていません。
startDate	string	課金プランが開始された日付。
transactions	PaymentDetail[]	予約注文に関連する支払いに関する情報。

ReservationOrderResponse

返される予約注文の詳細。

名前	型	説明
etag	integer
id	string	予約の識別子
name	string	予約の名前
properties.benefitStartTime	string	これは、予約特典が開始されたときの DateTime です。
properties.billingPlan	ReservationBillingPlan	課金プランを表します。
properties.createdDateTime	string	これは、予約が作成されたときの DateTime です。
properties.displayName	string	予約を簡単に識別できるユーザーのフレンドリ名。
properties.expiryDate	string	これは予約の有効期限が切れる日付です。
properties.expiryDateTime	string	これは、予約の有効期限が切れる日時です。
properties.originalQuantity	integer	予約で購入した SKU の合計数量。
properties.planInformation	ReservationOrderBillingPlanInformation	この予約の課金プランの種類を説明する情報。
properties.provisioningState	ProvisioningState	予約の現在の状態。
properties.requestDateTime	string	これは、予約が最初に購入を要求されたときの DateTime です。
properties.reservations	ReservationResponse[]	予約の定義。
properties.reviewDateTime	string	これは、Azure ハイブリッド特典を確認する必要がある日時です。
properties.term	ReservationTerm	予約の期間を表します。
systemData	systemData	リソースの作成と最後の変更に関連するメタデータ。
type	string	リソースの種類。 "Microsoft.Capacity/reservations"

ReservationResponse

予約の定義。

名前	型	説明
etag	integer
id	string	リソースの完全修飾リソース ID。例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind	Kind	予約するリソースプロバイダーの種類。
location	string	予約済みリソースが格納されている Azure リージョン。
name	string	リソースの名前
properties	ReservationsProperties	この予約に関連付けられているプロパティ
sku	SkuName	この予約に関連付けられている SKU 情報
systemData	systemData	createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。
type	string	リソースの型。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

ReservationSplitProperties

予約分割のプロパティ

名前	型	説明
splitDestinations	string[]	分割が原因で作成されたターゲットリソース ID の一覧。リソース ID の形式は /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} です
splitSource	string	これが分割される予約のリソース ID。リソース ID の形式は /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} です

ReservationsProperties

予約のプロパティ

名前	型	既定値	説明
appliedScopeProperties	AppliedScopeProperties		適用されたスコープの種類に固有のプロパティ。該当しない場合は必須ではありません。 AppliedScopeType が ManagementGroup の場合は、tenantId と managementGroupId を指定する必要があります
appliedScopeType	AppliedScopeType		適用されたスコープの種類
appliedScopes	string[]		適用されたスコープの一覧
archived	boolean		予約がアーカイブされているかどうかを示します
benefitStartTime	string		これは、予約特典が開始されたときの DateTime です。
billingPlan	ReservationBillingPlan		この SKU で使用できる課金プランのオプション。
billingScopeId	string		予約プランまたは節約プランの購入に対して課金されるサブスクリプション
capabilities	string		予約の機能
displayName	string		予約を簡単に識別するためのユーザーのフレンドリ名
displayProvisioningState	string		表示用の予約のプロビジョニング状態 (例: Succeeded)
effectiveDateTime	string		このバージョンが有効になったときに開始される予約の DateTime。
expiryDate	string		これは予約の有効期限が切れる日付です。
expiryDateTime	string		これは、予約の有効期限が切れる日時です。
extendedStatusInfo	ExtendedStatusInfo		状態コードに関する詳細情報を示すメッセージ。
instanceFlexibility	InstanceFlexibility		同じ自動調整グループ内の SKU 間で予約割引を適用できるようにします。すべての SKU でインスタンスサイズの柔軟性がサポートされているわけではありません。
lastUpdatedDateTime	string		予約が最後に更新された時刻の DateTime。
mergeProperties	ReservationMergeProperties		予約のマージのプロパティ
provisioningState	ProvisioningState		予約の現在の状態。
provisioningSubState	string		予約のプロビジョニングサブ状態 (成功など)
purchaseDate	string		これは、予約が購入された日付です。
purchaseDateTime	string		これは、予約が購入された日時です。
quantity	integer		予約の一部である SKU の数量。
renew	boolean	False	これを true に設定すると、有効期限の日時に新しい予約が自動的に購入されます。
renewDestination	string		更新のために購入された予約の予約 ID。リソース ID の形式は /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} です。
renewProperties	RenewPropertiesResponse		予約の更新プロパティ。
renewSource	string		この予約の更新元となる予約の予約 ID。リソース ID の形式は /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} です。
reservedResourceType	ReservedResourceType		予約されているリソースの種類。
reviewDateTime	string		これは、Azure ハイブリッド特典を確認する必要がある日時です。
skuDescription	string		SKU の説明 (英語)。
splitProperties	ReservationSplitProperties		予約分割のプロパティ
swapProperties	ReservationSwapProperties		予約スワップのプロパティ
term	ReservationTerm		予約の期間を表します。
userFriendlyAppliedScopeType	string		表示する予約の適用スコープの種類 (共有など)
userFriendlyRenewState	string		表示する予約の更新状態 (例: オン)
utilization	Utilization		予約の使用率

ReservationStatusCode

名前	型	説明
Active	string
Expired	string
Merged	string
None	string
PaymentInstrumentError	string
Pending	string
Processing	string
PurchaseError	string
Split	string
Succeeded	string

ReservationSwapProperties

予約スワップのプロパティ

名前	型	説明
swapDestination	string	元のリソースがスワップされる予約リソース ID。リソース ID の形式は /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} です
swapSource	string	スワップされるソース予約のリソース ID。リソース ID の形式は /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} です

ReservationTerm

予約の期間を表します。

名前	型	説明
P1Y	string
P3Y	string
P5Y	string

ReservationUtilizationAggregates

予約使用率の集計値

名前	型	説明
grain	number	集計の粒度
grainUnit	string	集計のグレイン単位
value	number	集計値
valueUnit	string	集計値の単位

ReservedResourceProperties

予約済みリソースの種類ごとに固有のプロパティ。該当しない場合は必須ではありません。

名前	型	説明
instanceFlexibility	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

systemData

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

Utilization

予約の使用率

名前	型	説明
aggregates	ReservationUtilizationAggregates[]	予約の使用率の集計の配列
trend	string	予約の過去 7 日間の使用率の傾向