你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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

请求已接受并正在处理。操作结果链接位于位置标头中。

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	创建资源的标识类型。
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

创建资源的标识类型。

名称	类型	说明
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 资源管理器元数据。
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		要显示的预留的预配状态，例如“成功”
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	创建资源的标识。
createdByType	createdByType	创建资源的标识类型。
lastModifiedAt	string	资源上次修改的时间戳 (UTC)
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识类型。

Utilization

预留利用率

名称	类型	说明
aggregates	ReservationUtilizationAggregates[]	预留利用率的聚合数组
trend	string	预留的最近 7 天利用率趋势