Reservation Order - Purchase

Service:

Reserved VM Instances

API Version:

2022-11-01

Beli ReservationOrder dan buat sumber daya di bawah URI yang ditentukan.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
reservationOrderId	path	True	string	Id Pesanan reservasi
api-version	query	True	string	Versi yang didukung.

Isi Permintaan

Nama	Jenis	Deskripsi
location	string	Wilayah Azure tempat sumber daya yang dipesan berada.
properties.appliedScopeProperties	AppliedScopeProperties	Properti khusus untuk jenis cakupan yang diterapkan. Tidak diperlukan jika tidak berlaku. Diperlukan dan perlu menyediakan tenantId dan managementGroupId jika AppliedScopeType adalah ManagementGroup
properties.appliedScopeType	AppliedScopeType	Jenis Cakupan yang Diterapkan.
properties.appliedScopes	string[]	Daftar langganan yang akan diterapkan manfaatnya. Jangan tentukan apakah AppliedScopeType dibagikan. Properti ini akan ditolak dan digantikan oleh appliedScopeProperties sebagai gantinya untuk Single AppliedScopeType.
properties.billingPlan	ReservationBillingPlan	Mewakili paket penagihan.
properties.billingScopeId	string	Langganan yang akan dikenakan untuk membeli reservasi atau paket penghematan
properties.displayName	string	Nama reservasi yang mudah diingat
properties.quantity	integer	Kuantitas sku yang merupakan bagian dari reservasi.
properties.renew	boolean	Mengatur ini ke true akan secara otomatis membeli reservasi baru pada tanggal kedaluwarsa.
properties.reservedResourceProperties	ReservedResourceProperties	Properti khusus untuk setiap jenis sumber daya yang dipesan. Tidak diperlukan jika tidak berlaku.
properties.reservedResourceType	ReservedResourceType	Jenis sumber daya yang sedang dicadangkan.
properties.reviewDateTime	string	Ini adalah tanggal-waktu ketika manfaat hibrid Azure perlu ditinjau.
properties.term	ReservationTerm	Mewakili jangka waktu reservasi.
sku	SkuName	Nama sku

Respons

Nama	Jenis	Deskripsi
200 OK	ReservationOrderResponse	Sumber daya telah dibuat
202 Accepted	ReservationOrderResponse	Permintaan diterima dan sedang diproses. Tautan hasil operasi ada di header lokasi. Headers Location: string Retry-After: integer
Other Status Codes	Error	Kesalahan tidak terduga

Contoh

Purchase

Sample Request

HTTP

PUT https://management.azure.com/providers/Microsoft.Capacity/reservationOrders/a075419f-44cc-497f-b68a-14ee811d48b9?api-version=2022-11-01

{
  "sku": {
    "name": "standard_D1"
  },
  "location": "westus",
  "properties": {
    "reservedResourceType": "VirtualMachines",
    "billingScopeId": "/subscriptions/ed3a1871-612d-abcd-a849-c2542a68be83",
    "term": "P1Y",
    "billingPlan": "Monthly",
    "quantity": 1,
    "displayName": "TestReservationOrder",
    "appliedScopes": null,
    "appliedScopeType": "Shared",
    "reservedResourceProperties": {
      "instanceFlexibility": "On"
    },
    "renew": false
  }
}

Java

import com.azure.resourcemanager.reservations.models.AppliedScopeType;
import com.azure.resourcemanager.reservations.models.InstanceFlexibility;
import com.azure.resourcemanager.reservations.models.PurchaseRequest;
import com.azure.resourcemanager.reservations.models.PurchaseRequestPropertiesReservedResourceProperties;
import com.azure.resourcemanager.reservations.models.ReservationBillingPlan;
import com.azure.resourcemanager.reservations.models.ReservationTerm;
import com.azure.resourcemanager.reservations.models.ReservedResourceType;
import com.azure.resourcemanager.reservations.models.SkuName;

/** Samples for ReservationOrder Purchase. */
public final class Main {
    /*
     * x-ms-original-file: specification/reservations/resource-manager/Microsoft.Capacity/stable/2022-11-01/examples/PurchaseReservationOrder.json
     */
    /**
     * Sample code: Purchase.
     *
     * @param manager Entry point to ReservationsManager.
     */
    public static void purchase(com.azure.resourcemanager.reservations.ReservationsManager manager) {
        manager
            .reservationOrders()
            .purchase(
                "a075419f-44cc-497f-b68a-14ee811d48b9",
                new PurchaseRequest()
                    .withSku(new SkuName().withName("standard_D1"))
                    .withLocation("westus")
                    .withReservedResourceType(ReservedResourceType.VIRTUAL_MACHINES)
                    .withBillingScopeId("/subscriptions/ed3a1871-612d-abcd-a849-c2542a68be83")
                    .withTerm(ReservationTerm.P1Y)
                    .withBillingPlan(ReservationBillingPlan.MONTHLY)
                    .withQuantity(1)
                    .withDisplayName("TestReservationOrder")
                    .withAppliedScopeType(AppliedScopeType.SHARED)
                    .withRenew(false)
                    .withReservedResourceProperties(
                        new PurchaseRequestPropertiesReservedResourceProperties()
                            .withInstanceFlexibility(InstanceFlexibility.ON)),
                com.azure.core.util.Context.NONE);
    }
}

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

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.reservations import AzureReservationAPI

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-reservations
# USAGE
    python purchase_reservation_order.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = AzureReservationAPI(
        credential=DefaultAzureCredential(),
    )

    response = client.reservation_order.begin_purchase(
        reservation_order_id="a075419f-44cc-497f-b68a-14ee811d48b9",
        body={
            "location": "westus",
            "properties": {
                "appliedScopeType": "Shared",
                "appliedScopes": None,
                "billingPlan": "Monthly",
                "billingScopeId": "/subscriptions/ed3a1871-612d-abcd-a849-c2542a68be83",
                "displayName": "TestReservationOrder",
                "quantity": 1,
                "renew": False,
                "reservedResourceProperties": {"instanceFlexibility": "On"},
                "reservedResourceType": "VirtualMachines",
                "term": "P1Y",
            },
            "sku": {"name": "standard_D1"},
        },
    ).result()
    print(response)


# x-ms-original-file: specification/reservations/resource-manager/Microsoft.Capacity/stable/2022-11-01/examples/PurchaseReservationOrder.json
if __name__ == "__main__":
    main()

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

Go

package armreservations_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/reservations/armreservations/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1e7b408f3323e7f5424745718fe62c7a043a2337/specification/reservations/resource-manager/Microsoft.Capacity/stable/2022-11-01/examples/PurchaseReservationOrder.json
func ExampleReservationOrderClient_BeginPurchase() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armreservations.NewClientFactory(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewReservationOrderClient().BeginPurchase(ctx, "a075419f-44cc-497f-b68a-14ee811d48b9", armreservations.PurchaseRequest{
		Location: to.Ptr("westus"),
		Properties: &armreservations.PurchaseRequestProperties{
			AppliedScopeType: to.Ptr(armreservations.AppliedScopeTypeShared),
			BillingPlan:      to.Ptr(armreservations.ReservationBillingPlanMonthly),
			BillingScopeID:   to.Ptr("/subscriptions/ed3a1871-612d-abcd-a849-c2542a68be83"),
			DisplayName:      to.Ptr("TestReservationOrder"),
			Quantity:         to.Ptr[int32](1),
			Renew:            to.Ptr(false),
			ReservedResourceProperties: &armreservations.PurchaseRequestPropertiesReservedResourceProperties{
				InstanceFlexibility: to.Ptr(armreservations.InstanceFlexibilityOn),
			},
			ReservedResourceType: to.Ptr(armreservations.ReservedResourceTypeVirtualMachines),
			Term:                 to.Ptr(armreservations.ReservationTermP1Y),
		},
		SKU: &armreservations.SKUName{
			Name: to.Ptr("standard_D1"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ReservationOrderResponse = armreservations.ReservationOrderResponse{
	// 	Name: to.Ptr("1f14354c-dc12-4c8d-8090-6f295a3a34aa"),
	// 	Type: to.Ptr("Microsoft.Capacity/reservationOrders"),
	// 	Etag: to.Ptr[int32](7),
	// 	ID: to.Ptr("/providers/microsoft.capacity/reservationOrders/1f14354c-dc12-4c8d-8090-6f295a3a34aa"),
	// 	Properties: &armreservations.ReservationOrderProperties{
	// 		BillingPlan: to.Ptr(armreservations.ReservationBillingPlanMonthly),
	// 		CreatedDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-08-30T03:51:49.808Z"); return t}()),
	// 		DisplayName: to.Ptr("cabri"),
	// 		ExpiryDate: to.Ptr(func() time.Time { t, _ := time.Parse("2006-01-02", "2018-08-30"); return t}()),
	// 		ExpiryDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-08-30T03:51:49.808Z"); return t}()),
	// 		OriginalQuantity: to.Ptr[int32](7),
	// 		ProvisioningState: to.Ptr(armreservations.ProvisioningStateSucceeded),
	// 		RequestDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-08-30T03:49:19.025Z"); return t}()),
	// 		Reservations: []*armreservations.ReservationResponse{
	// 			{
	// 				ID: to.Ptr("/providers/microsoft.capacity/reservationOrders/1f14354c-dc12-4c8d-8090-6f295a3a34aa/reservations/c8c926bd-fc5d-4e29-9d43-b68340ac23a6"),
	// 		}},
	// 		Term: to.Ptr(armreservations.ReservationTermP1Y),
	// 	},
	// }
}

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

JavaScript

const { AzureReservationAPI } = require("@azure/arm-reservations");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Purchase `ReservationOrder` and create resource under the specified URI.
 *
 * @summary Purchase `ReservationOrder` and create resource under the specified URI.
 * x-ms-original-file: specification/reservations/resource-manager/Microsoft.Capacity/stable/2022-11-01/examples/PurchaseReservationOrder.json
 */
async function purchase() {
  const reservationOrderId = "a075419f-44cc-497f-b68a-14ee811d48b9";
  const body = {
    appliedScopeType: "Shared",
    appliedScopes: [],
    billingPlan: "Monthly",
    billingScopeId: "/subscriptions/ed3a1871-612d-abcd-a849-c2542a68be83",
    displayName: "TestReservationOrder",
    location: "westus",
    quantity: 1,
    renew: false,
    reservedResourceProperties: { instanceFlexibility: "On" },
    reservedResourceType: "VirtualMachines",
    sku: { name: "standard_D1" },
    term: "P1Y",
  };
  const credential = new DefaultAzureCredential();
  const client = new AzureReservationAPI(credential);
  const result = await client.reservationOrder.beginPurchaseAndWait(reservationOrderId, body);
  console.log(result);
}

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

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Reservations;
using Azure.ResourceManager.Reservations.Models;

// Generated from example definition: specification/reservations/resource-manager/Microsoft.Capacity/stable/2022-11-01/examples/PurchaseReservationOrder.json
// this example is just showing the usage of "ReservationOrder_Purchase" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this TenantResource created on azure
// for more information of creating TenantResource, please refer to the document of TenantResource
var tenantResource = client.GetTenants().GetAllAsync().GetAsyncEnumerator().Current;

// get the collection of this ReservationOrderResource
ReservationOrderCollection collection = tenantResource.GetReservationOrders();

// invoke the operation
Guid reservationOrderId = Guid.Parse("a075419f-44cc-497f-b68a-14ee811d48b9");
ReservationPurchaseContent content = new ReservationPurchaseContent()
{
    SkuName = "standard_D1",
    Location = new AzureLocation("westus"),
    ReservedResourceType = ReservedResourceType.VirtualMachines,
    BillingScopeId = new ResourceIdentifier("/subscriptions/ed3a1871-612d-abcd-a849-c2542a68be83"),
    Term = ReservationTerm.P1Y,
    BillingPlan = ReservationBillingPlan.Monthly,
    Quantity = 1,
    DisplayName = "TestReservationOrder",
    AppliedScopeType = AppliedScopeType.Shared,
    AppliedScopes =
    {
    },
    IsRenewEnabled = false,
    ReservedResourceInstanceFlexibility = InstanceFlexibility.On,
};
ArmOperation<ReservationOrderResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, reservationOrderId, content);
ReservationOrderResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
ReservationOrderData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

Sample Response

Status code:

200

{
  "id": "/providers/microsoft.capacity/reservationOrders/1f14354c-dc12-4c8d-8090-6f295a3a34aa",
  "type": "Microsoft.Capacity/reservationOrders",
  "name": "1f14354c-dc12-4c8d-8090-6f295a3a34aa",
  "etag": 7,
  "properties": {
    "displayName": "cabri",
    "requestDateTime": "2017-08-30T03:49:19.0252126Z",
    "createdDateTime": "2017-08-30T03:51:49.8083758Z",
    "expiryDate": "2018-08-30",
    "expiryDateTime": "2018-08-30T03:51:49.8083758Z",
    "term": "P1Y",
    "billingPlan": "Monthly",
    "provisioningState": "Succeeded",
    "reservations": [
      {
        "id": "/providers/microsoft.capacity/reservationOrders/1f14354c-dc12-4c8d-8090-6f295a3a34aa/reservations/c8c926bd-fc5d-4e29-9d43-b68340ac23a6"
      }
    ],
    "originalQuantity": 7
  }
}

Status code:

202

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

Response Body

{
  "id": "/providers/microsoft.capacity/reservationOrders/1f14354c-dc12-4c8d-8090-6f295a3a34aa",
  "type": "Microsoft.Capacity/reservationOrders",
  "name": "1f14354c-dc12-4c8d-8090-6f295a3a34aa",
  "etag": 7,
  "properties": {
    "displayName": "cabri",
    "billingPlan": "Monthly",
    "requestDateTime": "2017-08-30T03:49:19.0252126Z",
    "createdDateTime": "2017-08-30T03:51:49.8083758Z",
    "expiryDate": "2018-08-30",
    "expiryDateTime": "2018-08-30T03:51:49.8083758Z",
    "term": "P1Y",
    "provisioningState": "Succeeded",
    "reservations": [
      {
        "id": "/providers/microsoft.capacity/reservationOrders/1f14354c-dc12-4c8d-8090-6f295a3a34aa/reservations/c8c926bd-fc5d-4e29-9d43-b68340ac23a6"
      }
    ],
    "originalQuantity": 7
  }
}

Definisi

Nama	Deskripsi
AppliedScopeProperties	Properti khusus untuk jenis cakupan yang diterapkan. Tidak diperlukan jika tidak berlaku. Diperlukan dan perlu menyediakan tenantId dan managementGroupId jika AppliedScopeType adalah ManagementGroup
AppliedScopeType	Jenis Cakupan yang Diterapkan.
BillingCurrencyTotal	Mata uang dan jumlah yang akan dikenakan pelanggan dalam mata uang lokal pelanggan untuk pembelian perpanjangan. Pajak tidak termasuk.
createdByType	Jenis identitas yang membuat sumber daya.
Error	Informasi kesalahan
ErrorResponseCode	Kode kesalahan yang menjelaskan alasan layanan tidak dapat memproses permintaan masuk
ExtendedErrorInfo	Informasi kesalahan yang diperluas termasuk kode kesalahan dan pesan kesalahan
ExtendedStatusInfo
InstanceFlexibility	Mengaktifkan ini akan menerapkan diskon reservasi ke VM lain dalam grup ukuran VM yang sama. Hanya tentukan untuk jenis sumber daya cadangan VirtualMachines.
Kind	Jenis Penyedia Sumber Daya yang akan dicadangkan.
PaymentDetail	Informasi tentang pembayaran yang terkait dengan pesanan reservasi.
PaymentStatus	Menjelaskan apakah pembayaran selesai, gagal, dibatalkan, atau dijadwalkan di masa mendatang.
Price	Informasi harga yang berisi jumlah dan kode mata uang
PricingCurrencyTotal	Jumlah yang digunakan Microsoft untuk rekaman. Digunakan selama pengembalian dana untuk menghitung batas pengembalian dana. Pajak tidak termasuk. Ini adalah harga terkunci 30 hari sebelum kedaluwarsa.
ProvisioningState	Mewakili status Reservasi saat ini.
PurchaseRequest	Permintaan pembelian reservasi
RenewPropertiesResponse	Properti perpanjangan untuk reservasi.
ReservationBillingPlan	Mewakili paket penagihan.
ReservationMergeProperties	Properti penggabungan reservasi
ReservationOrderBillingPlanInformation	Informasi yang menjelaskan jenis paket penagihan untuk reservasi ini.
ReservationOrderResponse	Detail pesanan reservasi yang dikembalikan.
ReservationResponse	Definisi reservasi.
ReservationSplitProperties	Properti pemisahan reservasi
ReservationsProperties	Properti reservasi
ReservationStatusCode
ReservationSwapProperties	Properti pertukaran reservasi
ReservationTerm	Mewakili jangka waktu reservasi.
ReservationUtilizationAggregates	Nilai agregat pemanfaatan reservasi
ReservedResourceProperties	Properti khusus untuk setiap jenis sumber daya yang dipesan. Tidak diperlukan jika tidak berlaku.
ReservedResourceType	Jenis sumber daya yang sedang dicadangkan.
SkuName	Nama sku
systemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.
Utilization	Pemanfaatan reservasi

AppliedScopeProperties

Properti khusus untuk jenis cakupan yang diterapkan. Tidak diperlukan jika tidak berlaku. Diperlukan dan perlu menyediakan tenantId dan managementGroupId jika AppliedScopeType adalah ManagementGroup

Nama	Jenis	Deskripsi
displayName	string	Nama tampilan
managementGroupId	string	Pengidentifikasi grup manajemen yang sepenuhnya memenuhi syarat di mana manfaat harus diterapkan.
resourceGroupId	string	Pengidentifikasi grup sumber daya yang sepenuhnya memenuhi syarat.
subscriptionId	string	Pengidentifikasi langganan yang sepenuhnya memenuhi syarat.
tenantId	string	ID penyewa tempat paket penghematan harus menerapkan manfaat.

AppliedScopeType

Jenis Cakupan yang Diterapkan.

Nama	Jenis	Deskripsi
ManagementGroup	string
Shared	string
Single	string

BillingCurrencyTotal

Mata uang dan jumlah yang akan dikenakan pelanggan dalam mata uang lokal pelanggan untuk pembelian perpanjangan. Pajak tidak termasuk.

Nama	Jenis	Deskripsi
amount	number
currencyCode	string	Kode mata uang ISO 4217 3 huruf untuk mata uang yang digunakan oleh catatan pembelian ini.

createdByType

Jenis identitas yang membuat sumber daya.

Nama	Jenis	Deskripsi
Application	string
Key	string
ManagedIdentity	string
User	string

Error

Informasi kesalahan

Nama	Jenis	Deskripsi
error	ExtendedErrorInfo	Informasi kesalahan yang diperluas termasuk kode kesalahan dan pesan kesalahan

ErrorResponseCode

Kode kesalahan yang menjelaskan alasan layanan tidak dapat memproses permintaan masuk

Nama	Jenis	Deskripsi
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

Informasi kesalahan yang diperluas termasuk kode kesalahan dan pesan kesalahan

Nama	Jenis	Deskripsi
code	ErrorResponseCode	Kode kesalahan yang menjelaskan alasan layanan tidak dapat memproses permintaan masuk
message	string

ExtendedStatusInfo

Nama	Jenis	Deskripsi
message	string	Pesan yang memberikan informasi terperinci tentang kode status.
statusCode	ReservationStatusCode

InstanceFlexibility

Mengaktifkan ini akan menerapkan diskon reservasi ke VM lain dalam grup ukuran VM yang sama. Hanya tentukan untuk jenis sumber daya cadangan VirtualMachines.

Nama	Jenis	Deskripsi
Off	string
On	string

Kind

Jenis Penyedia Sumber Daya yang akan dicadangkan.

Nama	Jenis	Deskripsi
Microsoft.Compute	string

PaymentDetail

Informasi tentang pembayaran yang terkait dengan pesanan reservasi.

Nama	Jenis	Deskripsi
billingAccount	string	Menampilkan Akun yang ditagih untuk pembayaran ini.
billingCurrencyTotal	Price	Jumlah yang dibebankan dalam mata uang Penagihan. Pajak tidak termasuk. Null untuk pembayaran di masa mendatang
dueDate	string	Tanggal saat pembayaran perlu dilakukan.
extendedStatusInfo	ExtendedStatusInfo
paymentDate	string	Tanggal ketika transaksi selesai. Null ketika dijadwalkan.
pricingCurrencyTotal	Price	Jumlah dalam mata uang harga. Pajak tidak termasuk.
status	PaymentStatus	Menjelaskan apakah pembayaran selesai, gagal, dibatalkan, atau dijadwalkan di masa mendatang.

PaymentStatus

Menjelaskan apakah pembayaran selesai, gagal, dibatalkan, atau dijadwalkan di masa mendatang.

Nama	Jenis	Deskripsi
Cancelled	string
Failed	string
Scheduled	string
Succeeded	string

Price

Informasi harga yang berisi jumlah dan kode mata uang

Nama	Jenis	Deskripsi
amount	number
currencyCode	string	Kode mata uang ISO 4217 3 huruf untuk mata uang yang digunakan oleh catatan pembelian ini.

PricingCurrencyTotal

Jumlah yang digunakan Microsoft untuk rekaman. Digunakan selama pengembalian dana untuk menghitung batas pengembalian dana. Pajak tidak termasuk. Ini adalah harga terkunci 30 hari sebelum kedaluwarsa.

Nama	Jenis	Deskripsi
amount	number
currencyCode	string	Kode mata uang ISO 4217 3 huruf untuk mata uang yang digunakan oleh catatan pembelian ini.

ProvisioningState

Mewakili status Reservasi saat ini.

Nama	Jenis	Deskripsi
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

Permintaan pembelian reservasi

Nama	Jenis	Nilai Default	Deskripsi
location	string		Wilayah Azure tempat sumber daya yang dipesan tinggal.
properties.appliedScopeProperties	AppliedScopeProperties		Properti khusus untuk jenis cakupan yang diterapkan. Tidak diperlukan jika tidak berlaku. Diperlukan dan perlu menyediakan tenantId dan managementGroupId jika AppliedScopeType adalah ManagementGroup
properties.appliedScopeType	AppliedScopeType		Jenis Cakupan yang Diterapkan.
properties.appliedScopes	string[]		Daftar langganan yang akan diterapkan manfaatnya. Jangan tentukan apakah AppliedScopeType dibagikan. Properti ini tidak akan digunakan lagi dan digantikan oleh appliedScopeProperties sebagai gantinya untuk Single AppliedScopeType.
properties.billingPlan	ReservationBillingPlan		Mewakili paket penagihan.
properties.billingScopeId	string		Langganan yang akan dikenakan untuk membeli reservasi atau paket penghematan
properties.displayName	string		Nama reservasi yang mudah diingat
properties.quantity	integer		Kuantitas sku yang merupakan bagian dari reservasi.
properties.renew	boolean	False	Mengatur ini ke true akan secara otomatis membeli reservasi baru pada tanggal kedaluwarsa.
properties.reservedResourceProperties	ReservedResourceProperties		Properti khusus untuk setiap jenis sumber daya yang dipesan. Tidak diperlukan jika tidak berlaku.
properties.reservedResourceType	ReservedResourceType		Jenis sumber daya yang sedang dicadangkan.
properties.reviewDateTime	string		Ini adalah tanggal-waktu ketika manfaat hibrid Azure perlu ditinjau.
properties.term	ReservationTerm		Mewakili jangka waktu reservasi.
sku	SkuName		Nama sku

RenewPropertiesResponse

Properti perpanjangan untuk reservasi.

Nama	Jenis	Deskripsi
billingCurrencyTotal	BillingCurrencyTotal	Mata uang dan jumlah yang akan dikenakan pelanggan dalam mata uang lokal pelanggan untuk pembelian perpanjangan. Pajak tidak termasuk.
pricingCurrencyTotal	PricingCurrencyTotal	Jumlah yang digunakan Microsoft untuk rekaman. Digunakan selama pengembalian dana untuk menghitung batas pengembalian dana. Pajak tidak termasuk. Ini adalah harga terkunci 30 hari sebelum kedaluwarsa.
purchaseProperties	PurchaseRequest	Permintaan untuk pembelian reservasi

ReservationBillingPlan

Mewakili paket penagihan.

Nama	Jenis	Deskripsi
Monthly	string
Upfront	string

ReservationMergeProperties

Properti penggabungan reservasi

Nama	Jenis	Deskripsi
mergeDestination	string	Id sumber daya reservasi Dibuat karena penggabungan. Format id sumber daya adalah /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}
mergeSources	string[]	Id sumber daya dari reservasi sumber digabungkan untuk membentuk reservasi ini. Format id sumber daya adalah /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}

ReservationOrderBillingPlanInformation

Informasi yang menjelaskan jenis paket penagihan untuk reservasi ini.

Nama	Jenis	Deskripsi
nextPaymentDueDate	string	Untuk paket penagihan berulang, menunjukkan tanggal kapan pembayaran berikutnya akan diproses. Null ketika total dilunasi.
pricingCurrencyTotal	Price	Jumlah uang yang harus dibayarkan untuk Pesanan. Pajak tidak termasuk.
startDate	string	Tanggal saat paket penagihan telah dimulai.
transactions	PaymentDetail[]	Informasi tentang pembayaran yang terkait dengan pesanan reservasi.

ReservationOrderResponse

Detail pesanan reservasi yang dikembalikan.

Nama	Jenis	Deskripsi
etag	integer
id	string	Pengidentifikasi reservasi
name	string	Nama reservasi
properties.benefitStartTime	string	Ini adalah DateTime ketika manfaat reservasi dimulai.
properties.billingPlan	ReservationBillingPlan	Mewakili paket penagihan.
properties.createdDateTime	string	Ini adalah DateTime ketika reservasi dibuat.
properties.displayName	string	Nama yang mudah diingat bagi pengguna untuk dengan mudah mengidentifikasi reservasi.
properties.expiryDate	string	Ini adalah tanggal ketika reservasi akan kedaluwarsa.
properties.expiryDateTime	string	Ini adalah tanggal-waktu ketika reservasi akan kedaluwarsa.
properties.originalQuantity	integer	Jumlah total sku yang dibeli dalam reservasi.
properties.planInformation	ReservationOrderBillingPlanInformation	Informasi yang menjelaskan jenis paket penagihan untuk reservasi ini.
properties.provisioningState	ProvisioningState	Status reservasi saat ini.
properties.requestDateTime	string	Ini adalah DateTime ketika reservasi awalnya diminta untuk dibeli.
properties.reservations	ReservationResponse[]	Definisi reservasi.
properties.reviewDateTime	string	Ini adalah tanggal-waktu ketika Azure Hybrid Benefit perlu ditinjau.
properties.term	ReservationTerm	Mewakili jangka waktu reservasi.
systemData	systemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.
type	string	Jenis sumber daya. "Microsoft.Capacity/reservations"

ReservationResponse

Definisi reservasi.

Nama	Jenis	Deskripsi
etag	integer
id	string	ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Misalnya "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind	Kind	Jenis Penyedia Sumber Daya yang akan dicadangkan.
location	string	Wilayah Azure tempat sumber daya yang dipesan tinggal.
name	string	Nama sumber daya.
properties	ReservationsProperties	Properti yang terkait dengan reservasi ini
sku	SkuName	Informasi sku yang terkait dengan reservasi ini
systemData	systemData	Metadata Azure Resource Manager yang berisi informasi createdBy dan modifiedBy.
type	string	Jenis sumber daya. Misalnya "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts"

ReservationSplitProperties

Properti pemisahan reservasi

Nama	Jenis	Deskripsi
splitDestinations	string[]	Daftar id sumber daya tujuan yang dibuat karena pemisahan. Format id sumber daya adalah /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}
splitSource	string	Id sumber daya reservasi tempat ini dibagi. Format id sumber daya adalah /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}

ReservationsProperties

Properti reservasi

Nama	Jenis	Nilai Default	Deskripsi
appliedScopeProperties	AppliedScopeProperties		Properti khusus untuk jenis cakupan yang diterapkan. Tidak diperlukan jika tidak berlaku. Diperlukan dan perlu menyediakan tenantId dan managementGroupId jika AppliedScopeType adalah ManagementGroup
appliedScopeType	AppliedScopeType		Jenis cakupan yang diterapkan
appliedScopes	string[]		Daftar cakupan yang diterapkan
archived	boolean		Menunjukkan apakah reservasi diarsipkan
benefitStartTime	string		Ini adalah DateTime ketika manfaat reservasi dimulai.
billingPlan	ReservationBillingPlan		Opsi paket penagihan tersedia untuk sku ini.
billingScopeId	string		Langganan yang akan dikenakan untuk membeli reservasi atau paket penghematan
capabilities	string		Kemampuan reservasi
displayName	string		Nama yang mudah diingat bagi pengguna untuk mengidentifikasi reservasi dengan mudah
displayProvisioningState	string		Status penyediaan reservasi untuk ditampilkan, misalnya Berhasil
effectiveDateTime	string		TanggalWaktu reservasi dimulai ketika versi ini berlaku.
expiryDate	string		Ini adalah tanggal ketika reservasi akan kedaluwarsa.
expiryDateTime	string		Ini adalah tanggal-waktu ketika reservasi akan kedaluwarsa.
extendedStatusInfo	ExtendedStatusInfo		Pesan yang memberikan informasi terperinci tentang kode status.
instanceFlexibility	InstanceFlexibility		Memungkinkan diskon reservasi diterapkan di seluruh sku dalam grup auto fit yang sama. Tidak semua sku mendukung fleksibilitas ukuran instans.
lastUpdatedDateTime	string		DateTime terakhir kali reservasi diperbarui.
mergeProperties	ReservationMergeProperties		Properti penggabungan reservasi
provisioningState	ProvisioningState		Status reservasi saat ini.
provisioningSubState	string		Sub-status penyediaan reservasi, misalnya Berhasil
purchaseDate	string		Ini adalah tanggal ketika reservasi dibeli.
purchaseDateTime	string		Ini adalah tanggal-waktu ketika reservasi dibeli.
quantity	integer		Kuantitas sku yang merupakan bagian dari reservasi.
renew	boolean	False	Mengatur ini ke true akan secara otomatis membeli reservasi baru pada tanggal kedaluwarsa.
renewDestination	string		Id Reservasi reservasi yang dibeli karena perpanjangan. Format Id sumber daya adalah /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}.
renewProperties	RenewPropertiesResponse		Properti perpanjangan untuk reservasi.
renewSource	string		Id Reservasi reservasi tempat reservasi ini diperpanjang. Format Id sumber daya adalah /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}.
reservedResourceType	ReservedResourceType		Jenis sumber daya yang sedang dicadangkan.
reviewDateTime	string		Ini adalah tanggal-waktu ketika Azure Hybrid Benefit perlu ditinjau.
skuDescription	string		Deskripsi sku dalam bahasa Inggris.
splitProperties	ReservationSplitProperties		Properti pemisahan reservasi
swapProperties	ReservationSwapProperties		Properti pertukaran reservasi
term	ReservationTerm		Mewakili jangka waktu reservasi.
userFriendlyAppliedScopeType	string		Jenis cakupan yang diterapkan dari reservasi untuk ditampilkan, misalnya Bersama
userFriendlyRenewState	string		Status perpanjangan reservasi untuk ditampilkan, misalnya Aktif
utilization	Utilization		Pemanfaatan reservasi

ReservationStatusCode

Nama	Jenis	Deskripsi
Active	string
Expired	string
Merged	string
None	string
PaymentInstrumentError	string
Pending	string
Processing	string
PurchaseError	string
Split	string
Succeeded	string

ReservationSwapProperties

Properti pertukaran reservasi

Nama	Jenis	Deskripsi
swapDestination	string	Id sumber daya reservasi tempat sumber daya asli ditukar. Format id sumber daya adalah /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}
swapSource	string	Id sumber daya dari reservasi sumber yang ditukar. Format id sumber daya adalah /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}

ReservationTerm

Mewakili jangka waktu reservasi.

Nama	Jenis	Deskripsi
P1Y	string
P3Y	string
P5Y	string

ReservationUtilizationAggregates

Nilai agregat pemanfaatan reservasi

Nama	Jenis	Deskripsi
grain	number	Butir agregat
grainUnit	string	Unit butir agregat
value	number	Nilai agregat
valueUnit	string	Unit nilai agregat

ReservedResourceProperties

Properti khusus untuk setiap jenis sumber daya yang dipesan. Tidak diperlukan jika tidak berlaku.

Nama	Jenis	Deskripsi
instanceFlexibility	InstanceFlexibility	Mengaktifkan ini akan menerapkan diskon reservasi ke VM lain dalam grup ukuran VM yang sama. Hanya tentukan untuk jenis sumber daya cadangan VirtualMachines.

ReservedResourceType

Jenis sumber daya yang sedang dicadangkan.

Nama	Jenis	Deskripsi
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

Nama sku

Nama	Jenis	Deskripsi
name	string

systemData

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Nama	Jenis	Deskripsi
createdAt	string	Tanda waktu pembuatan sumber daya (UTC).
createdBy	string	Identitas yang membuat sumber daya.
createdByType	createdByType	Jenis identitas yang membuat sumber daya.
lastModifiedAt	string	Tanda waktu modifikasi terakhir sumber daya (UTC)
lastModifiedBy	string	Identitas yang terakhir mengubah sumber daya.
lastModifiedByType	createdByType	Jenis identitas yang terakhir mengubah sumber daya.

Utilization

Pemanfaatan reservasi

Nama	Jenis	Deskripsi
aggregates	ReservationUtilizationAggregates[]	Array agregat pemanfaatan reservasi
trend	string	tren pemanfaatan 7 hari terakhir untuk reservasi