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

Reservation - Split

服务:: Reserved VM Instances

API 版本:: 2022-11-01

拆分 Reservation。
将 Reservation 拆分为具有指定数量分布的两个 Reservation。

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

URI 参数

名称	在	必需	类型	说明
reservationOrderId	path	True	string	预留的订单 ID
api-version	query	True	string	支持的版本。

请求正文

名称	类型	说明
properties.quantities	integer[] (int32)	要创建的新预留中的数量列表。
properties.reservationId	string	要拆分的预留的资源 ID。资源 ID 的格式应为 /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}

响应

名称类型说明

200 OK

ReservationResponse[]

拆分作后创建的 Reservation列表。

202 Accepted

请求已接受并正在处理

标头

Location: string
Retry-After: integer

Other Status Codes

意外错误

示例

Split

示例请求

POST https://management.azure.com/providers/Microsoft.Capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/split?api-version=2022-11-01

{
  "properties": {
    "quantities": [
      1,
      2
    ],
    "reservationId": "/providers/Microsoft.Capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/bcae77cd-3119-4766-919f-b50d36c75c7a"
  }
}


import com.azure.resourcemanager.reservations.models.SplitRequest;
import java.util.Arrays;

/**
 * Samples for Reservation Split.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/reservations/resource-manager/Microsoft.Capacity/stable/2022-11-01/examples/SplitReservation.json
     */
    /**
     * Sample code: Split.
     * 
     * @param manager Entry point to ReservationsManager.
     */
    public static void split(com.azure.resourcemanager.reservations.ReservationsManager manager) {
        manager.reservations().split("276e7ae4-84d0-4da6-ab4b-d6b94f3557da",
            new SplitRequest().withQuantities(Arrays.asList(1, 2)).withReservationId(
                "/providers/Microsoft.Capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/bcae77cd-3119-4766-919f-b50d36c75c7a"),
            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 split_reservation.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.begin_split(
        reservation_order_id="276e7ae4-84d0-4da6-ab4b-d6b94f3557da",
        body={
            "properties": {
                "quantities": [1, 2],
                "reservationId": "/providers/Microsoft.Capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/bcae77cd-3119-4766-919f-b50d36c75c7a",
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/reservations/resource-manager/Microsoft.Capacity/stable/2022-11-01/examples/SplitReservation.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/SplitReservation.json
func ExampleReservationClient_BeginSplit() {
	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.NewReservationClient().BeginSplit(ctx, "276e7ae4-84d0-4da6-ab4b-d6b94f3557da", armreservations.SplitRequest{
		Properties: &armreservations.SplitProperties{
			Quantities: []*int32{
				to.Ptr[int32](1),
				to.Ptr[int32](2)},
			ReservationID: to.Ptr("/providers/Microsoft.Capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/bcae77cd-3119-4766-919f-b50d36c75c7a"),
		},
	}, 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.ReservationResponseArray = []*armreservations.ReservationResponse{
	// 	{
	// 		Name: to.Ptr("00238563-7312-4c20-a134-8c030bf938a7"),
	// 		Type: to.Ptr("Microsoft.Capacity/reservationOrders/reservations"),
	// 		ID: to.Ptr("/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/00238563-7312-4c20-a134-8c030bf938a7"),
	// 		Etag: to.Ptr[int32](2),
	// 		Location: to.Ptr("eastus"),
	// 		Properties: &armreservations.Properties{
	// 			AppliedScopeProperties: &armreservations.AppliedScopeProperties{
	// 				DisplayName: to.Ptr("Azure subscription 1"),
	// 				SubscriptionID: to.Ptr("/subscriptions/98df3792-7962-4f18-8be2-d5576f122de3"),
	// 			},
	// 			AppliedScopeType: to.Ptr(armreservations.AppliedScopeTypeSingle),
	// 			BillingPlan: to.Ptr(armreservations.ReservationBillingPlanMonthly),
	// 			BillingScopeID: to.Ptr("/subscriptions/19376483-64b8-49e4-a931-d5248828720a"),
	// 			DisplayName: to.Ptr("cabri_test"),
	// 			EffectiveDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-09-22T01:00:30.925Z"); return t}()),
	// 			ExpiryDate: to.Ptr(func() time.Time { t, _ := time.Parse("2006-01-02", "2018-09-22"); return t}()),
	// 			ExpiryDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-09-22T01:00:30.925Z"); return t}()),
	// 			InstanceFlexibility: to.Ptr(armreservations.InstanceFlexibilityOff),
	// 			LastUpdatedDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-09-22T01:00:36.319Z"); return t}()),
	// 			ProvisioningState: to.Ptr(armreservations.ProvisioningStateSucceeded),
	// 			Quantity: to.Ptr[int32](1),
	// 			Renew: to.Ptr(false),
	// 			ReservedResourceType: to.Ptr(armreservations.ReservedResourceTypeVirtualMachines),
	// 			SKUDescription: to.Ptr("D1 v2"),
	// 			SplitProperties: &armreservations.ReservationSplitProperties{
	// 				SplitSource: to.Ptr("/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/bcae77cd-3119-4766-919f-b50d36c75c7a"),
	// 			},
	// 		},
	// 		SKU: &armreservations.SKUName{
	// 			Name: to.Ptr("Standard_DS1_v2"),
	// 		},
	// 	},
	// 	{
	// 		Name: to.Ptr("e0e4b4f5-77ea-4984-9ee4-6bf9850ee6de"),
	// 		Type: to.Ptr("Microsoft.Capacity/reservationOrders/reservations"),
	// 		ID: to.Ptr("/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/e0e4b4f5-77ea-4984-9ee4-6bf9850ee6de"),
	// 		Etag: to.Ptr[int32](2),
	// 		Location: to.Ptr("eastus"),
	// 		Properties: &armreservations.Properties{
	// 			AppliedScopeProperties: &armreservations.AppliedScopeProperties{
	// 				DisplayName: to.Ptr("Azure subscription 1"),
	// 				SubscriptionID: to.Ptr("/subscriptions/98df3792-7962-4f18-8be2-d5576f122de3"),
	// 			},
	// 			AppliedScopeType: to.Ptr(armreservations.AppliedScopeTypeSingle),
	// 			BillingPlan: to.Ptr(armreservations.ReservationBillingPlanMonthly),
	// 			BillingScopeID: to.Ptr("/subscriptions/19376483-64b8-49e4-a931-d5248828720a"),
	// 			DisplayName: to.Ptr("cabri_test"),
	// 			EffectiveDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-09-22T01:00:30.925Z"); return t}()),
	// 			ExpiryDate: to.Ptr(func() time.Time { t, _ := time.Parse("2006-01-02", "2018-09-22"); return t}()),
	// 			ExpiryDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-09-22T01:00:30.925Z"); return t}()),
	// 			InstanceFlexibility: to.Ptr(armreservations.InstanceFlexibilityOff),
	// 			LastUpdatedDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-09-22T01:00:36.319Z"); return t}()),
	// 			ProvisioningState: to.Ptr(armreservations.ProvisioningStateSucceeded),
	// 			Quantity: to.Ptr[int32](2),
	// 			Renew: to.Ptr(false),
	// 			ReservedResourceType: to.Ptr(armreservations.ReservedResourceTypeVirtualMachines),
	// 			SKUDescription: to.Ptr("D1 v2"),
	// 			SplitProperties: &armreservations.ReservationSplitProperties{
	// 				SplitSource: to.Ptr("/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/bcae77cd-3119-4766-919f-b50d36c75c7a"),
	// 			},
	// 		},
	// 		SKU: &armreservations.SKUName{
	// 			Name: to.Ptr("Standard_DS1_v2"),
	// 		},
	// 	},
	// 	{
	// 		Name: to.Ptr("bcae77cd-3119-4766-919f-b50d36c75c7a"),
	// 		Type: to.Ptr("Microsoft.Capacity/reservationOrders/reservations"),
	// 		ID: to.Ptr("/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/bcae77cd-3119-4766-919f-b50d36c75c7a"),
	// 		Etag: to.Ptr[int32](10),
	// 		Location: to.Ptr("eastus"),
	// 		Properties: &armreservations.Properties{
	// 			AppliedScopeProperties: &armreservations.AppliedScopeProperties{
	// 				DisplayName: to.Ptr("Azure subscription 1"),
	// 				SubscriptionID: to.Ptr("/subscriptions/98df3792-7962-4f18-8be2-d5576f122de3"),
	// 			},
	// 			AppliedScopeType: to.Ptr(armreservations.AppliedScopeTypeSingle),
	// 			BillingPlan: to.Ptr(armreservations.ReservationBillingPlanMonthly),
	// 			BillingScopeID: to.Ptr("/subscriptions/19376483-64b8-49e4-a931-d5248828720a"),
	// 			DisplayName: to.Ptr("cabri_test"),
	// 			EffectiveDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-09-22T01:00:30.925Z"); return t}()),
	// 			ExpiryDate: to.Ptr(func() time.Time { t, _ := time.Parse("2006-01-02", "2018-09-22"); return t}()),
	// 			ExpiryDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-09-22T01:00:30.925Z"); return t}()),
	// 			ExtendedStatusInfo: &armreservations.ExtendedStatusInfo{
	// 				Message: to.Ptr("This reservation was split and is no longer active."),
	// 				StatusCode: to.Ptr(armreservations.ReservationStatusCodeSplit),
	// 			},
	// 			InstanceFlexibility: to.Ptr(armreservations.InstanceFlexibilityOff),
	// 			LastUpdatedDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-09-22T01:00:36.319Z"); return t}()),
	// 			ProvisioningState: to.Ptr(armreservations.ProvisioningStateSucceeded),
	// 			Quantity: to.Ptr[int32](3),
	// 			Renew: to.Ptr(false),
	// 			ReservedResourceType: to.Ptr(armreservations.ReservedResourceTypeVirtualMachines),
	// 			SKUDescription: to.Ptr("D1 v2"),
	// 			SplitProperties: &armreservations.ReservationSplitProperties{
	// 				SplitDestinations: []*string{
	// 					to.Ptr("/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/00238563-7312-4c20-a134-8c030bf938a7"),
	// 					to.Ptr("/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/e0e4b4f5-77ea-4984-9ee4-6bf9850ee6de")},
	// 				},
	// 			},
	// 			SKU: &armreservations.SKUName{
	// 				Name: to.Ptr("Standard_DS1_v2"),
	// 			},
	// 	}}
}

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 Split a `Reservation` into two `Reservation`s with specified quantity distribution.
 *
 * @summary Split a `Reservation` into two `Reservation`s with specified quantity distribution.
 * x-ms-original-file: specification/reservations/resource-manager/Microsoft.Capacity/stable/2022-11-01/examples/SplitReservation.json
 */
async function split() {
  const reservationOrderId = "276e7ae4-84d0-4da6-ab4b-d6b94f3557da";
  const body = {
    quantities: [1, 2],
    reservationId:
      "/providers/Microsoft.Capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/bcae77cd-3119-4766-919f-b50d36c75c7a",
  };
  const credential = new DefaultAzureCredential();
  const client = new AzureReservationAPI(credential);
  const result = await client.reservation.beginSplitAndWait(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 Azure;
using Azure.ResourceManager;
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Reservations.Models;
using Azure.ResourceManager.Reservations;

// Generated from example definition: specification/reservations/resource-manager/Microsoft.Capacity/stable/2022-11-01/examples/SplitReservation.json
// this example is just showing the usage of "Reservation_Split" 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 ReservationOrderResource created on azure
// for more information of creating ReservationOrderResource, please refer to the document of ReservationOrderResource
Guid reservationOrderId = Guid.Parse("276e7ae4-84d0-4da6-ab4b-d6b94f3557da");
ResourceIdentifier reservationOrderResourceId = ReservationOrderResource.CreateResourceIdentifier(reservationOrderId);
ReservationOrderResource reservationOrder = client.GetReservationOrderResource(reservationOrderResourceId);

// invoke the operation
SplitContent content = new SplitContent
{
    Quantities = { 1, 2 },
    ReservationId = new ResourceIdentifier("/providers/Microsoft.Capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/bcae77cd-3119-4766-919f-b50d36c75c7a"),
};
ArmOperation<IList<ReservationDetailData>> lro = await reservationOrder.SplitReservationAsync(WaitUntil.Completed, content);
IList<ReservationDetailData> result = lro.Value;

Console.WriteLine($"Succeeded: {result}");

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

示例响应

状态代码:: 200

[
  {
    "sku": {
      "name": "Standard_DS1_v2"
    },
    "id": "/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/00238563-7312-4c20-a134-8c030bf938a7",
    "type": "Microsoft.Capacity/reservationOrders/reservations",
    "name": "00238563-7312-4c20-a134-8c030bf938a7",
    "etag": 2,
    "location": "eastus",
    "properties": {
      "appliedScopeProperties": {
        "subscriptionId": "/subscriptions/98df3792-7962-4f18-8be2-d5576f122de3",
        "displayName": "Azure subscription 1"
      },
      "renew": false,
      "billingScopeId": "/subscriptions/19376483-64b8-49e4-a931-d5248828720a",
      "appliedScopeType": "Single",
      "quantity": 1,
      "provisioningState": "Succeeded",
      "expiryDate": "2018-09-22",
      "expiryDateTime": "2018-09-22T01:00:30.9253826Z",
      "displayName": "cabri_test",
      "billingPlan": "Monthly",
      "effectiveDateTime": "2017-09-22T01:00:30.9253826Z",
      "lastUpdatedDateTime": "2017-09-22T01:00:36.3191627Z",
      "reservedResourceType": "VirtualMachines",
      "instanceFlexibility": "Off",
      "skuDescription": "D1 v2",
      "splitProperties": {
        "splitSource": "/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/bcae77cd-3119-4766-919f-b50d36c75c7a"
      }
    }
  },
  {
    "sku": {
      "name": "Standard_DS1_v2"
    },
    "id": "/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/e0e4b4f5-77ea-4984-9ee4-6bf9850ee6de",
    "type": "Microsoft.Capacity/reservationOrders/reservations",
    "name": "e0e4b4f5-77ea-4984-9ee4-6bf9850ee6de",
    "etag": 2,
    "location": "eastus",
    "properties": {
      "appliedScopeProperties": {
        "subscriptionId": "/subscriptions/98df3792-7962-4f18-8be2-d5576f122de3",
        "displayName": "Azure subscription 1"
      },
      "renew": false,
      "billingScopeId": "/subscriptions/19376483-64b8-49e4-a931-d5248828720a",
      "appliedScopeType": "Single",
      "quantity": 2,
      "provisioningState": "Succeeded",
      "expiryDate": "2018-09-22",
      "expiryDateTime": "2018-09-22T01:00:30.9253826Z",
      "displayName": "cabri_test",
      "billingPlan": "Monthly",
      "effectiveDateTime": "2017-09-22T01:00:30.9253826Z",
      "lastUpdatedDateTime": "2017-09-22T01:00:36.3191627Z",
      "reservedResourceType": "VirtualMachines",
      "instanceFlexibility": "Off",
      "skuDescription": "D1 v2",
      "splitProperties": {
        "splitSource": "/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/bcae77cd-3119-4766-919f-b50d36c75c7a"
      }
    }
  },
  {
    "sku": {
      "name": "Standard_DS1_v2"
    },
    "id": "/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/bcae77cd-3119-4766-919f-b50d36c75c7a",
    "type": "Microsoft.Capacity/reservationOrders/reservations",
    "name": "bcae77cd-3119-4766-919f-b50d36c75c7a",
    "etag": 10,
    "location": "eastus",
    "properties": {
      "appliedScopeProperties": {
        "subscriptionId": "/subscriptions/98df3792-7962-4f18-8be2-d5576f122de3",
        "displayName": "Azure subscription 1"
      },
      "renew": false,
      "billingScopeId": "/subscriptions/19376483-64b8-49e4-a931-d5248828720a",
      "appliedScopeType": "Single",
      "quantity": 3,
      "provisioningState": "Cancelled",
      "expiryDate": "2018-09-22",
      "expiryDateTime": "2018-09-22T01:00:30.9253826Z",
      "displayName": "cabri_test",
      "billingPlan": "Monthly",
      "effectiveDateTime": "2017-09-22T01:00:30.9253826Z",
      "extendedStatusInfo": {
        "statusCode": "Split",
        "message": "This reservation was split and is no longer active."
      },
      "lastUpdatedDateTime": "2017-09-22T01:00:36.3191627Z",
      "reservedResourceType": "VirtualMachines",
      "instanceFlexibility": "Off",
      "skuDescription": "D1 v2",
      "splitProperties": {
        "splitDestinations": [
          "/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/00238563-7312-4c20-a134-8c030bf938a7",
          "/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/e0e4b4f5-77ea-4984-9ee4-6bf9850ee6de"
        ]
      }
    }
  }
]

状态代码:: 202

Location: https://management.azure.com/providers/Microsoft.Capacity/reservationorders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/splitoperationresults/bcae77cd-3119-4766-919f-b50d36c75c7a_10?api-version=2022-11-01
Retry-After: 120

定义

名称	说明
AppliedScopeProperties	特定于应用的范围类型的属性。如果不适用，则不需要。如果 AppliedScopeType 为 ManagementGroup，则需要提供 tenantId 和 managementGroupId
AppliedScopeType	应用的作用域的类型。
BillingCurrencyTotal	客户将按客户本地货币收取续订购买的货币和金额。不包括税款。
createdByType	创建资源的标识的类型。
Error	错误信息
ErrorResponseCode	描述服务无法处理传入请求的原因的错误代码
ExtendedErrorInfo	扩展的错误信息，包括错误代码和错误消息
ExtendedStatusInfo
InstanceFlexibility	打开此项会将预留折扣应用到同一 VM 大小组中的其他 VM。仅指定 VirtualMachines 保留资源类型。
Kind	要保留的资源提供程序类型。
PricingCurrencyTotal	Microsoft记录使用的量。在退款期间用于计算退款限制。不包括税款。这是在到期前 30 天锁定的价格。
ProvisioningState	表示预留的当前状态。
PurchaseRequest	预留购买请求
RenewPropertiesResponse	预留的续订属性。
ReservationBillingPlan	表示计费计划。
ReservationMergeProperties	预留合并的属性
ReservationResponse	预留的定义。
ReservationSplitProperties	预留拆分的属性
ReservationsProperties	预留的属性
ReservationStatusCode
ReservationSwapProperties	预留交换的属性
ReservationTerm	表示预留期限。
ReservationUtilizationAggregates	预留利用率的聚合值
ReservedResourceProperties	特定于每个保留资源类型的属性。如果不适用，则不需要。
ReservedResourceType	正在保留的资源的类型。除了以下类型外，我们还添加了以下内容：OpenAIPTU、MDC、Sentinel。
SkuName	SKU 的名称
SplitRequest	预留拆分请求
systemData	与创建和上次修改资源相关的元数据。
Utilization	预留利用率

AppliedScopeProperties

Object

特定于应用的范围类型的属性。如果不适用，则不需要。如果 AppliedScopeType 为 ManagementGroup，则需要提供 tenantId 和 managementGroupId

名称	类型	说明
displayName	string	显示名称
managementGroupId	string	必须应用权益的管理组的完全限定标识符。
resourceGroupId	string	资源组的完全限定标识符。
subscriptionId	string	订阅的完全限定标识符。
tenantId	string	保存计划应应用权益的租户 ID。

AppliedScopeType

枚举

应用的作用域的类型。

值	说明
Single
Shared
ManagementGroup

BillingCurrencyTotal

Object

客户将按客户本地货币收取续订购买的货币和金额。不包括税款。

名称	类型	说明
amount	number
currencyCode	string	此购买记录使用的货币的 ISO 4217 3 字母货币代码。

createdByType

枚举

创建资源的标识的类型。

值	说明
User
Application
ManagedIdentity
Key

Error

Object

错误信息

名称	类型	说明
error	ExtendedErrorInfo	扩展的错误信息，包括错误代码和错误消息

ErrorResponseCode

枚举

描述服务无法处理传入请求的原因的错误代码

值	说明
NotSpecified
InternalServerError
ServerTimeout
AuthorizationFailed
BadRequest
ClientCertificateThumbprintNotSet
InvalidRequestContent
OperationFailed
HttpMethodNotSupported
InvalidRequestUri
MissingTenantId
InvalidTenantId
InvalidReservationOrderId
InvalidReservationId
ReservationIdNotInReservationOrder
ReservationOrderNotFound
InvalidSubscriptionId
InvalidAccessToken
InvalidLocationId
UnauthenticatedRequestsThrottled
InvalidHealthCheckType
Forbidden
BillingScopeIdCannotBeChanged
AppliedScopesNotAssociatedWithCommerceAccount
PatchValuesSameAsExisting
RoleAssignmentCreationFailed
ReservationOrderCreationFailed
ReservationOrderNotEnabled
CapacityUpdateScopesFailed
UnsupportedReservationTerm
ReservationOrderIdAlreadyExists
RiskCheckFailed
CreateQuoteFailed
ActivateQuoteFailed
NonsupportedAccountId
PaymentInstrumentNotFound
MissingAppliedScopesForSingle
NoValidReservationsToReRate
ReRateOnlyAllowedForEA
OperationCannotBePerformedInCurrentState
InvalidSingleAppliedScopesCount
InvalidFulfillmentRequestParameters
NotSupportedCountry
InvalidRefundQuantity
PurchaseError
BillingCustomerInputError
BillingPaymentInstrumentSoftError
BillingPaymentInstrumentHardError
BillingTransientError
BillingError
FulfillmentConfigurationError
FulfillmentOutOfStockError
FulfillmentTransientError
FulfillmentError
CalculatePriceFailed
AppliedScopesSameAsExisting
SelfServiceRefundNotSupported
RefundLimitExceeded

ExtendedErrorInfo

Object

扩展的错误信息，包括错误代码和错误消息

名称	类型	说明
code	ErrorResponseCode	描述服务无法处理传入请求的原因的错误代码
message	string

ExtendedStatusInfo

Object

名称	类型	说明
message	string	该消息提供有关状态代码的详细信息。
statusCode	ReservationStatusCode

InstanceFlexibility

枚举

打开此项会将预留折扣应用到同一 VM 大小组中的其他 VM。仅指定 VirtualMachines 保留资源类型。

值	说明
On
Off

Kind

枚举

要保留的资源提供程序类型。

值	说明
Microsoft.Compute

PricingCurrencyTotal

Object

Microsoft记录使用的量。在退款期间用于计算退款限制。不包括税款。这是在到期前 30 天锁定的价格。

名称	类型	说明
amount	number
currencyCode	string	此购买记录使用的货币的 ISO 4217 3 字母货币代码。

ProvisioningState

枚举

表示预留的当前状态。

值	说明
Creating
PendingResourceHold
ConfirmedResourceHold
PendingBilling
ConfirmedBilling
Created
Succeeded
Cancelled
Expired
BillingFailed
Failed
Split
Merged

PurchaseRequest

Object

预留购买请求

名称	类型	默认值	说明
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 (int32)		属于预留的 SKU 的数量。
properties.renew	boolean	False	如果设置为 true，则会在到期日期时间自动购买新预留。
properties.reservedResourceProperties	ReservedResourceProperties		特定于每个保留资源类型的属性。如果不适用，则不需要。
properties.reservedResourceType	ReservedResourceType		正在保留的资源的类型。除了以下类型外，我们还添加了以下内容：OpenAIPTU、MDC、Sentinel。
properties.reviewDateTime	string (date-time)		这是需要查看 Azure 混合权益的日期时间。
properties.term	ReservationTerm		表示预留期限。
sku	SkuName		SKU 的名称

RenewPropertiesResponse

Object

预留的续订属性。

名称	类型	说明
billingCurrencyTotal	BillingCurrencyTotal	客户将按客户本地货币收取续订购买的货币和金额。不包括税款。
pricingCurrencyTotal	PricingCurrencyTotal	Microsoft记录使用的量。在退款期间用于计算退款限制。不包括税款。这是在到期前 30 天锁定的价格。
purchaseProperties	PurchaseRequest	预留购买请求

ReservationBillingPlan

枚举

表示计费计划。

值	说明
Upfront
Monthly

ReservationMergeProperties

Object

预留合并的属性

名称	类型	说明
mergeDestination	string	由于合并而创建的预留资源 ID。资源 ID 的格式为 /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}
mergeSources	string[]	源预留合并以形成此预留的资源 ID。资源 ID 的格式为 /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}

ReservationResponse

Object

预留的定义。

名称	类型	说明
etag	integer (int32)
id	string (arm-id)	资源的完全限定资源 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

Object

预留拆分的属性

名称	类型	说明
splitDestinations	string[]	由于拆分而创建的目标资源 ID 的列表。资源 ID 的格式为 /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}
splitSource	string	从中拆分的预留的资源 ID。资源 ID 的格式为 /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}

ReservationsProperties

Object

预留的属性

名称	类型	默认值	说明
appliedScopeProperties	AppliedScopeProperties		特定于应用的范围类型的属性。如果不适用，则不需要。如果 AppliedScopeType 为 ManagementGroup，则需要提供 tenantId 和 managementGroupId
appliedScopeType	AppliedScopeType		应用的范围类型
appliedScopes	string[]		已应用的范围列表
archived	boolean		指示预留是否已存档
benefitStartTime	string (date-time)		这是预留权益启动时的 DateTime。
billingPlan	ReservationBillingPlan		此 SKU 可用的计费计划选项。
billingScopeId	string		购买预留或节省计划的订阅
capabilities	string		预留的功能
displayName	string		用户易于识别预留的友好名称
displayProvisioningState	string		要显示的预留的预配状态，例如成功
effectiveDateTime	string (date-time)		从此版本生效时开始的预留的 DateTime。
expiryDate	string (date)		这是预留到期的日期。
expiryDateTime	string (date-time)		这是预留到期的日期时间。
extendedStatusInfo	ExtendedStatusInfo		该消息提供有关状态代码的详细信息。
instanceFlexibility	InstanceFlexibility		允许在同一自动调整组中的 SKU 之间应用预留折扣。并非所有 SKU 都支持实例大小灵活性。
lastUpdatedDateTime	string (date-time)		上次更新预留的 DateTime。
mergeProperties	ReservationMergeProperties		预留合并的属性
provisioningState	ProvisioningState		预留的当前状态。
provisioningSubState	string		预留的预配子状态，例如成功
purchaseDate	string (date)		这是购买预留的日期。
purchaseDateTime	string (date-time)		这是购买预留的日期时间。
quantity	integer (int32)		属于预留的 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 (date-time)		这是需要查看 Azure 混合权益的日期时间。
skuDescription	string		英语 SKU 的说明。
splitProperties	ReservationSplitProperties		预留拆分的属性
swapProperties	ReservationSwapProperties		预留交换的属性
term	ReservationTerm		表示预留期限。
userFriendlyAppliedScopeType	string		要显示的预留的应用范围类型，例如共享
userFriendlyRenewState	string		要显示的预留的续订状态，例如打开
utilization	Utilization		预留利用率

ReservationStatusCode

枚举

值	说明
None
Pending
Processing
Active
PurchaseError
PaymentInstrumentError
Split
Merged
Expired
Succeeded

ReservationSwapProperties

Object

预留交换的属性

名称	类型	说明
swapDestination	string	将原始资源交换到的预留资源 ID。资源 ID 的格式为 /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}
swapSource	string	交换的源预留的资源 ID。资源 ID 的格式为 /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}

ReservationTerm

枚举

表示预留期限。

值	说明
P1Y
P3Y
P5Y

ReservationUtilizationAggregates

Object

预留利用率的聚合值

名称	类型	说明
grain	number	聚合的粒度
grainUnit	string	聚合的粒度单位
value	number	聚合值
valueUnit	string	聚合值单位

ReservedResourceProperties

Object

特定于每个保留资源类型的属性。如果不适用，则不需要。

名称	类型	说明
instanceFlexibility	InstanceFlexibility	打开此项会将预留折扣应用到同一 VM 大小组中的其他 VM。仅指定 VirtualMachines 保留资源类型。

ReservedResourceType

枚举

正在保留的资源的类型。除了以下类型外，我们还添加了以下内容：OpenAIPTU、MDC、Sentinel。

值	说明
VirtualMachines
SqlDatabases
SuseLinux
CosmosDb
RedHat
SqlDataWarehouse
VMwareCloudSimple
RedHatOsa
Databricks
AppService
ManagedDisk
BlockBlob
RedisCache
AzureDataExplorer
MySql
MariaDb
PostgreSql
DedicatedHost
SapHana
SqlAzureHybridBenefit
AVS
DataFactory
NetAppStorage
AzureFiles
SqlEdge
VirtualMachineSoftware

SkuName

Object

SKU 的名称

名称	类型	说明
name	string

SplitRequest

Object

预留拆分请求

名称	类型	说明
properties.quantities	integer[] (int32)	要创建的新预留中的数量列表。
properties.reservationId	string	要拆分的预留的资源 ID。资源 ID 的格式应为 /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}

systemData

Object

与创建和上次修改资源相关的元数据。

名称	类型	说明
createdAt	string (date-time)	资源创建时间戳（UTC）。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识的类型。
lastModifiedAt	string (date-time)	上次修改的资源时间戳（UTC）
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识的类型。

Utilization

Object

预留利用率

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