共用方式為

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 參數

名稱 位於 必要 類型 Description
reservationOrderId
 path True

string

保留的順序標識碼
api-version
 query True

string

支援的版本。

要求本文

名稱 類型 Description
properties.quantities

integer[]

要建立之新保留中的數量清單。
properties.reservationId

string

要分割之保留的資源標識碼。 資源標識符的格式應該是 /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}

回應

名稱 類型 Description
200 OK

ReservationResponse[]

分割作業之後建立的 Reservation清單。
202 Accepted

已接受要求並正在處理

標題

  • Location: string
  • Retry-After: integer
Other Status Codes

Error

未預期的錯誤

範例

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

範例回覆

狀態碼:
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

定義

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

要保留的資源類型。
SkuName

SKU 的名稱
SplitRequest

保留分割的要求
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

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}

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

SplitRequest

保留分割的要求

名稱 類型 Description
properties.quantities

integer[]

要建立之新保留中的數量清單。
properties.reservationId

string

要分割之保留的資源標識碼。 資源標識符的格式應該是 /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}

systemData

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

名稱 類型 Description
createdAt

string

資源建立的時間戳 (UTC) 。
createdBy

string

建立資源的身分識別。
createdByType

createdByType

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

string

上次修改的資源時間戳 (UTC)

lastModifiedBy

string

上次修改資源的身分識別。
lastModifiedByType

createdByType

上次修改資源的身分識別類型。

Utilization

保留使用率

名稱 類型 Description
aggregates

ReservationUtilizationAggregates[]

保留使用率匯總的陣列
trend

string

保留的最後7天使用率趨勢