Reservation Order - Purchase

服務:

Reserved VM Instances

API 版本:

2022-11-01

在指定的 URI 下購買 ReservationOrder 並建立資源。

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

URI 參數

名稱	位於	必要	類型	Description
reservationOrderId	path	True	string	保留的訂單標識碼
api-version	query	True	string	支援的版本。

要求本文

名稱	類型	Description
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 的名稱

回應

名稱	類型	Description
200 OK	ReservationOrderResponse	資源已建立
202 Accepted	ReservationOrderResponse	接受要求並正在處理。 作業結果連結位於位置標頭中。 標題 Location: string Retry-After: integer
Other Status Codes	Error	未預期的錯誤

範例

Purchase

範例要求

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

範例回覆

狀態碼:

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

狀態碼:

202

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

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

定義

名稱	Description
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

名稱	類型	Description
displayName	string	顯示名稱
managementGroupId	string	必須套用權益之管理群組的完整標識符。
resourceGroupId	string	資源群組的完整標識碼。
subscriptionId	string	訂用帳戶的完整標識碼。
tenantId	string	節省方案應套用權益的租用戶標識碼。

AppliedScopeType

套用範圍的類型。

名稱	類型	Description
ManagementGroup	string
Shared	string
Single	string

BillingCurrencyTotal

客戶的貨幣和金額將會以客戶的當地貨幣支付續約購買費用。 不包含稅金。

名稱	類型	Description
amount	number
currencyCode	string	此購買記錄所使用的貨幣的 ISO 4217 3 字母貨幣代碼。

createdByType

建立資源的身分識別類型。

名稱	類型	Description
Application	string
Key	string
ManagedIdentity	string
User	string

Error

錯誤資訊

名稱	類型	Description
error	ExtendedErrorInfo	擴充的錯誤資訊，包括錯誤碼和錯誤訊息

ErrorResponseCode

描述服務無法處理傳入要求原因的錯誤碼

名稱	類型	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

擴充的錯誤資訊，包括錯誤碼和錯誤訊息

名稱	類型	Description
code	ErrorResponseCode	描述服務無法處理傳入要求原因的錯誤碼
message	string

ExtendedStatusInfo

名稱	類型	Description
message	string	提供狀態代碼詳細資訊的訊息。
statusCode	ReservationStatusCode

InstanceFlexibility

開啟此選項會將保留折扣套用至相同 VM 大小群組中的其他 VM。 只指定 VirtualMachines 保留的資源類型。

名稱	類型	Description
Off	string
On	string

Kind

要保留的資源提供者類型。

名稱	類型	Description
Microsoft.Compute	string

PaymentDetail

與保留訂單相關的付款相關信息。

名稱	類型	Description
billingAccount	string	顯示支付此付款費用的帳戶。
billingCurrencyTotal	Price	以計費貨幣收費的金額。 不包含稅金。 未來付款為 Null
dueDate	string	付款需要完成的日期。
extendedStatusInfo	ExtendedStatusInfo
paymentDate	string	交易完成的日期。 排程時為 null。
pricingCurrencyTotal	Price	定價貨幣金額。 不包含稅金。
status	PaymentStatus	描述付款是否已完成、失敗、取消或排程未來。

PaymentStatus

描述付款是否已完成、失敗、取消或排程未來。

名稱	類型	Description
Cancelled	string
Failed	string
Scheduled	string
Succeeded	string

Price

包含金額和貨幣代碼的定價資訊

名稱	類型	Description
amount	number
currencyCode	string	此購買記錄所使用貨幣的 ISO 4217 3 字母貨幣代碼。

PricingCurrencyTotal

Microsoft 用於記錄的數量。 在退款期間用於計算退款限制。 不包含稅金。 這是在到期前 30 天鎖定的價格。

名稱	類型	Description
amount	number
currencyCode	string	此購買記錄所使用的貨幣的 ISO 4217 3 字母貨幣代碼。

ProvisioningState

表示保留的目前狀態。

名稱	類型	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

購買保留的要求

名稱	類型	預設值	Description
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

保留的更新屬性。

名稱	類型	Description
billingCurrencyTotal	BillingCurrencyTotal	客戶的貨幣和金額將會以客戶的當地貨幣支付續約購買費用。 不包含稅金。
pricingCurrencyTotal	PricingCurrencyTotal	Microsoft 用於記錄的數量。 在退款期間用於計算退款限制。 不包含稅金。 這是在到期前 30 天鎖定的價格。
purchaseProperties	PurchaseRequest	保留購買的要求

ReservationBillingPlan

代表計費方案。

名稱	類型	Description
Monthly	string
Upfront	string

ReservationMergeProperties

保留合併的屬性

名稱	類型	Description
mergeDestination	string	保留資源標識碼 由於合併而建立。 資源標識符的格式為 /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}
mergeSources	string[]	來源保留的資源標識碼已合併成形成此保留。 資源標識符的格式為 /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}

ReservationOrderBillingPlanInformation

描述此保留之計費方案類型的資訊。

名稱	類型	Description
nextPaymentDueDate	string	針對週期性計費方案，指出下一次付款的處理日期。 當總計支付時為 Null。
pricingCurrencyTotal	Price	要支付訂單的金額。 不包含稅金。
startDate	string	計費方案開始時的日期。
transactions	PaymentDetail[]	與保留訂單相關的付款相關信息。

ReservationOrderResponse

傳回保留訂單的詳細數據。

名稱	類型	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 Hybrid Benefit 的日期時間。
properties.term	ReservationTerm	代表保留期限。
systemData	systemData	與建立和上次修改資源相關的元數據。
type	string	資源類型。 “Microsoft.Capacity/reservations”

ReservationResponse

保留的定義。

名稱	類型	Description
etag	integer
id	string	資源的完整資源識別碼。 例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
kind	Kind	要保留的資源提供者類型。
location	string	保留資源所在的 Azure 區域。
name	string	資源的名稱
properties	ReservationsProperties	與此保留相關聯的屬性
sku	SkuName	與此保留相關聯的 SKU 資訊
systemData	systemData	Azure Resource Manager 包含 createdBy 和 modifiedBy 資訊的中繼資料。
type	string	資源類型。 例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

ReservationSplitProperties

保留分割的屬性

名稱	類型	Description
splitDestinations	string[]	因為分割而建立的目的地資源標識符清單。 資源標識符的格式為 /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}
splitSource	string	從中分割此保留的資源識別碼。 資源標識符的格式為 /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}

ReservationsProperties

保留的屬性

名稱	類型	預設值	Description
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		因為續約而購買之保留的保留標識碼。 資源標識符的格式為 /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}。
renewProperties	RenewPropertiesResponse		保留的更新屬性。
renewSource	string		保留的保留標識碼，此保留會從中更新保留。 資源標識符的格式為 /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}。
reservedResourceType	ReservedResourceType		要保留的資源類型。
reviewDateTime	string		這是需要檢閱 Azure Hybrid Benefit 的日期時間。
skuDescription	string		英文 SKU 的描述。
splitProperties	ReservationSplitProperties		保留分割的屬性
swapProperties	ReservationSwapProperties		保留交換的屬性
term	ReservationTerm		代表保留字詞。
userFriendlyAppliedScopeType	string		顯示保留的套用範圍類型，例如共用
userFriendlyRenewState	string		顯示保留的更新狀態，例如開啟
utilization	Utilization		保留使用率

ReservationStatusCode

名稱	類型	Description
Active	string
Expired	string
Merged	string
None	string
PaymentInstrumentError	string
Pending	string
Processing	string
PurchaseError	string
Split	string
Succeeded	string

ReservationSwapProperties

保留交換的屬性

名稱	類型	Description
swapDestination	string	原始資源交換的保留資源標識碼。 資源標識符的格式為 /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}
swapSource	string	交換之來源保留的資源標識碼。 資源標識符的格式為 /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}

ReservationTerm

代表保留期限。

名稱	類型	Description
P1Y	string
P3Y	string
P5Y	string

ReservationUtilizationAggregates

保留使用率的匯總值

名稱	類型	Description
grain	number	匯總的粒度
grainUnit	string	匯總的粒度單位
value	number	匯總值
valueUnit	string	匯總值單位

ReservedResourceProperties

每個保留資源類型的特定屬性。 如果不適用，則不需要。

名稱	類型	Description
instanceFlexibility	InstanceFlexibility	開啟此選項會將保留折扣套用至相同 VM 大小群組中的其他 VM。 只指定 VirtualMachines 保留的資源類型。

ReservedResourceType

要保留的資源類型。

名稱	類型	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 的名稱

名稱	類型	Description
name	string

systemData

與建立和上次修改資源相關的元數據。

名稱	類型	Description
createdAt	string	資源建立的時間戳 (UTC) 。
createdBy	string	建立資源的身分識別。
createdByType	createdByType	建立資源的身分識別類型。
lastModifiedAt	string	上次修改的資源時間戳 (UTC)
lastModifiedBy	string	上次修改資源的身分識別。
lastModifiedByType	createdByType	上次修改資源的身分識別類型。

Utilization

保留使用率

名稱	類型	Description
aggregates	ReservationUtilizationAggregates[]	保留使用率匯總的陣列
trend	string	保留的最後7天使用率趨勢