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 매개 변수

Name	In(다음 안에)	필수	형식	Description
reservationOrderId	path	True	string	예약의 주문 ID
api-version	query	True	string	지원되는 버전입니다.

요청 본문

Name	형식	Description
location	string	예약된 리소스가 있는 Azure 지역입니다.
properties.appliedScopeProperties	AppliedScopeProperties	적용된 scope 형식과 관련된 속성입니다. 해당되지 않는 경우 필요하지 않습니다. AppliedScopeType이 ManagementGroup인 경우 필수이며 tenantId 및 managementGroupId를 제공해야 합니다.
properties.appliedScopeType	AppliedScopeType	적용된 범위의 형식입니다.
properties.appliedScopes	string[]	혜택이 적용될 구독 목록입니다. AppliedScopeType이 공유인지 지정하지 마세요. 이 속성은 더 이상 사용되지 않으며 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의 이름

응답

Name	형식	Description
200 OK	ReservationOrderResponse	리소스가 생성되었습니다.
202 Accepted	ReservationOrderResponse	요청이 수락되고 처리되고 있습니다. 작업 결과 링크는 위치 헤더에 있습니다. Headers Location: string Retry-After: integer
Other Status Codes	Error	예기치 않은 오류

예제

Purchase

Sample Request

HTTP

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

Java

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

Python

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

Go

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

JavaScript

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

dotnet

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

정의

Name	Description
AppliedScopeProperties	적용된 scope 형식과 관련된 속성입니다. 해당되지 않는 경우 필요하지 않습니다. 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

적용된 scope 형식과 관련된 속성입니다. 해당되지 않는 경우 필요하지 않습니다. AppliedScopeType이 ManagementGroup인 경우 필수 및 tenantId 및 managementGroupId를 제공해야 합니다.

Name	형식	Description
displayName	string	표시 이름
managementGroupId	string	혜택을 적용해야 하는 관리 그룹의 정규화된 식별자입니다.
resourceGroupId	string	리소스 그룹의 정규화된 식별자입니다.
subscriptionId	string	구독의 정규화된 식별자입니다.
tenantId	string	저축 계획이 혜택을 적용해야 하는 테넌트 ID입니다.

AppliedScopeType

적용된 범위의 형식입니다.

Name	형식	Description
ManagementGroup	string
Shared	string
Single	string

BillingCurrencyTotal

갱신 구매를 위해 고객의 현지 통화로 청구되는 통화 및 금액입니다. 세금은 포함되지 않습니다.

Name	형식	Description
amount	number
currencyCode	string	이 구매 레코드에서 사용하는 통화에 대한 ISO 4217 3자 통화 코드입니다.

createdByType

리소스를 만든 ID 유형입니다.

Name	형식	Description
Application	string
Key	string
ManagedIdentity	string
User	string

Error

오류 정보

Name	형식	Description
error	ExtendedErrorInfo	오류 코드 및 오류 메시지를 포함한 확장된 오류 정보

ErrorResponseCode

서비스가 들어오는 요청을 처리할 수 없는 이유를 설명하는 오류 코드

Name	형식	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

오류 코드 및 오류 메시지를 포함한 확장된 오류 정보

Name	형식	Description
code	ErrorResponseCode	서비스가 들어오는 요청을 처리할 수 없는 이유를 설명하는 오류 코드
message	string

ExtendedStatusInfo

Name	형식	Description
message	string	상태 코드에 대한 자세한 정보를 제공하는 메시지입니다.
statusCode	ReservationStatusCode

InstanceFlexibility

이를 켜면 동일한 VM 크기 그룹의 다른 VM에 예약 할인이 적용됩니다. VirtualMachines 예약 리소스 종류에 대해서만 지정합니다.

Name	형식	Description
Off	string
On	string

Kind

예약할 리소스 공급자 유형입니다.

Name	형식	Description
Microsoft.Compute	string

PaymentDetail

예약 주문과 관련된 결제에 대한 정보입니다.

Name	형식	Description
billingAccount	string	이 결제에 대해 청구되는 계정을 표시합니다.
billingCurrencyTotal	Price	청구 통화로 청구되는 금액입니다. 세금은 포함되지 않습니다. 향후 결제에 대해 null인 경우
dueDate	string	결제가 필요한 날짜입니다.
extendedStatusInfo	ExtendedStatusInfo
paymentDate	string	트랜잭션이 완료된 날짜입니다. 예약된 경우 null입니다.
pricingCurrencyTotal	Price	가격 책정 통화의 금액입니다. 세금은 포함되지 않습니다.
status	PaymentStatus	결제가 완료, 실패, 취소 또는 향후 예약되었는지 여부를 설명합니다.

PaymentStatus

결제가 완료, 실패, 취소 또는 향후 예약되었는지 여부를 설명합니다.

Name	형식	Description
Cancelled	string
Failed	string
Scheduled	string
Succeeded	string

Price

금액 및 통화 코드를 포함하는 가격 책정 정보

Name	형식	Description
amount	number
currencyCode	string	이 구매 레코드에서 사용하는 통화에 대한 ISO 4217 3자 통화 코드입니다.

PricingCurrencyTotal

Microsoft가 레코드에 사용하는 양입니다. 환불 한도를 계산하기 위해 환불 중에 사용됩니다. 세금은 포함되지 않습니다. 만료 30일 전에 잠긴 가격입니다.

Name	형식	Description
amount	number
currencyCode	string	이 구매 레코드에서 사용하는 통화에 대한 ISO 4217 3자 통화 코드입니다.

ProvisioningState

예약의 현재 상태를 나타냅니다.

Name	형식	Description
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

예약 구매 요청

Name	형식	기본값	Description
location	string		예약된 리소스가 있는 Azure 지역입니다.
properties.appliedScopeProperties	AppliedScopeProperties		적용된 scope 형식과 관련된 속성입니다. 해당되지 않는 경우 필요하지 않습니다. AppliedScopeType이 ManagementGroup인 경우 필수 및 tenantId 및 managementGroupId를 제공해야 합니다.
properties.appliedScopeType	AppliedScopeType		적용된 범위의 형식입니다.
properties.appliedScopes	string[]		혜택이 적용될 구독 목록입니다. AppliedScopeType이 공유인지 지정하지 마세요. 이 속성은 더 이상 사용되지 않으며 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

예약에 대한 갱신 속성입니다.

Name	형식	Description
billingCurrencyTotal	BillingCurrencyTotal	갱신 구매를 위해 고객의 현지 통화로 청구되는 통화 및 금액입니다. 세금은 포함되지 않습니다.
pricingCurrencyTotal	PricingCurrencyTotal	Microsoft가 레코드에 사용하는 양입니다. 환불 한도를 계산하기 위해 환불 중에 사용됩니다. 세금은 포함되지 않습니다. 만료 30일 전에 잠긴 가격입니다.
purchaseProperties	PurchaseRequest	예약 구매 요청

ReservationBillingPlan

청구 플랜을 나타냅니다.

Name	형식	Description
Monthly	string
Upfront	string

ReservationMergeProperties

예약 병합의 속성

Name	형식	Description
mergeDestination	string	병합으로 인해 생성된 예약 리소스 ID입니다. 리소스 ID의 형식은 /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}입니다.
mergeSources	string[]	이 예약을 형성하기 위해 병합된 원본 예약의 리소스 ID입니다. 리소스 ID의 형식은 /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}입니다.

ReservationOrderBillingPlanInformation

이 예약에 대한 청구 플랜 유형을 설명하는 정보입니다.

Name	형식	Description
nextPaymentDueDate	string	반복 청구 플랜의 경우 은 다음 결제가 처리되는 날짜를 나타냅니다. 합계가 상환되면 Null입니다.
pricingCurrencyTotal	Price	주문에 대해 지급할 금액입니다. 세금은 포함되지 않습니다.
startDate	string	청구 플랜이 시작된 날짜입니다.
transactions	PaymentDetail[]	예약 주문과 관련된 결제에 대한 정보입니다.

ReservationOrderResponse

반환되는 예약 주문의 세부 정보입니다.

Name	형식	Description
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

예약의 정의입니다.

Name	형식	Description
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

예약 분할의 속성

Name	형식	Description
splitDestinations	string[]	분할로 인해 만들어진 대상 리소스 ID 목록입니다. 리소스 ID의 형식은 /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}입니다.
splitSource	string	분할되는 예약의 리소스 ID입니다. 리소스 ID의 형식은 /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}입니다.

ReservationsProperties

예약의 속성

Name	형식	기본값	Description
appliedScopeProperties	AppliedScopeProperties		적용된 scope 형식과 관련된 속성입니다. 해당되지 않는 경우 필요하지 않습니다. AppliedScopeType이 ManagementGroup인 경우 필수 및 tenantId 및 managementGroupId를 제공해야 합니다.
appliedScopeType	AppliedScopeType		적용된 scope 형식
appliedScopes	string[]		적용된 범위 목록
archived	boolean		예약이 보관되었는지를 나타냅니다.
benefitStartTime	string		예약 혜택이 시작된 DateTime입니다.
billingPlan	ReservationBillingPlan		이 sku에 사용할 수 있는 청구 플랜 옵션입니다.
billingScopeId	string		구매 예약 또는 저축 플랜에 대해 청구되는 구독
capabilities	string		예약 기능
displayName	string		사용자가 예약을 쉽게 식별할 수 있는 친숙한 이름
displayProvisioningState	string		표시할 예약의 프로비전 상태(예: 성공)
effectiveDateTime	string		이 버전이 유효할 때 시작되는 예약의 DateTime입니다.
expiryDate	string		예약이 만료되는 날짜입니다.
expiryDateTime	string		예약이 만료되는 날짜 시간입니다.
extendedStatusInfo	ExtendedStatusInfo		상태 코드에 대한 자세한 정보를 제공하는 메시지입니다.
instanceFlexibility	InstanceFlexibility		동일한 자동 맞춤 그룹 내의 sku에 예약 할인을 적용할 수 있습니다. 모든 sku가 instance 크기 유연성을 지원하는 것은 아닙니다.
lastUpdatedDateTime	string		예약이 마지막으로 업데이트된 날짜/시간입니다.
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		표시할 예약의 적용된 scope 유형(예: 공유됨)
userFriendlyRenewState	string		표시할 예약의 갱신 상태(예: 켜기)입니다.
utilization	Utilization		예약 사용률

ReservationStatusCode

Name	형식	Description
Active	string
Expired	string
Merged	string
None	string
PaymentInstrumentError	string
Pending	string
Processing	string
PurchaseError	string
Split	string
Succeeded	string

ReservationSwapProperties

예약 교환의 속성

Name	형식	Description
swapDestination	string	원래 리소스가 교환되는 예약 리소스 ID입니다. 리소스 ID의 형식은 /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}입니다.
swapSource	string	교환되는 원본 예약의 리소스 ID입니다. 리소스 ID의 형식은 /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}입니다.

ReservationTerm

예약 기간을 나타냅니다.

Name	형식	Description
P1Y	string
P3Y	string
P5Y	string

ReservationUtilizationAggregates

예약 사용률의 집계 값

Name	형식	Description
grain	number	집계의 조직
grainUnit	string	집계의 조직 단위
value	number	집계 값
valueUnit	string	집계 값 단위

ReservedResourceProperties

각 예약된 리소스 종류와 관련된 속성입니다. 해당되지 않는 경우 필요하지 않습니다.

Name	형식	Description
instanceFlexibility	InstanceFlexibility	이를 켜면 동일한 VM 크기 그룹의 다른 VM에 예약 할인이 적용됩니다. VirtualMachines 예약 리소스 종류에 대해서만 지정합니다.

ReservedResourceType

예약되는 리소스의 형식입니다.

Name	형식	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

sku의 이름

Name	형식	Description
name	string

systemData

리소스 만들기 및 마지막 수정과 관련된 메타데이터입니다.

Name	형식	Description
createdAt	string	UTC(리소스 만들기)의 타임스탬프입니다.
createdBy	string	리소스를 만든 ID입니다.
createdByType	createdByType	리소스를 만든 ID 유형입니다.
lastModifiedAt	string	리소스 마지막 수정의 타임스탬프(UTC)
lastModifiedBy	string	리소스를 마지막으로 수정한 ID입니다.
lastModifiedByType	createdByType	리소스를 마지막으로 수정한 ID 유형입니다.

Utilization

예약 사용률

Name	형식	Description
aggregates	ReservationUtilizationAggregates[]	예약 사용률 집계의 배열입니다.
trend	string	예약에 대한 지난 7일 사용률 추세