Reservation Order - Purchase

Služba:

Reserved VM Instances

Verze rozhraní API:

2022-11-01

Kupte ReservationOrder a vytvořte prostředek pod zadaným identifikátorem URI.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
reservationOrderId	path	True	string	ID objednávky rezervace
api-version	query	True	string	Podporovaná verze.

Text požadavku

Name	Typ	Description
location	string	Oblast Azure, ve které se nachází rezervovaný prostředek.
properties.appliedScopeProperties	AppliedScopeProperties	Vlastnosti specifické pro použitý typ oboru. Není vyžadováno, pokud není k dispozici. Povinné a je potřeba zadat tenantId a managementGroupId, pokud appliedScopeType je ManagementGroup.
properties.appliedScopeType	AppliedScopeType	Typ použitého oboru.
properties.appliedScopes	string[]	Seznam předplatných, na která se výhoda použije. Nezadávejte, jestli je AppliedScopeType shared. Tato vlastnost bude vyřazena a nahrazena appliedScopeProperties místo pro Single AppliedScopeType.
properties.billingPlan	ReservationBillingPlan	Představuje fakturační plány.
properties.billingScopeId	string	Předplatné, které se bude účtovat za nákup rezervace nebo úspory
properties.displayName	string	Popisný název rezervace
properties.quantity	integer	Množství skladových položek, které jsou součástí rezervace.
properties.renew	boolean	Pokud tuto hodnotu nastavíte na true, automaticky se k datu vypršení platnosti zakoupí nová rezervace.
properties.reservedResourceProperties	ReservedResourceProperties	Vlastnosti specifické pro každý rezervovaný typ prostředku. Není vyžadováno, pokud není k dispozici.
properties.reservedResourceType	ReservedResourceType	Typ prostředku, který je rezervován.
properties.reviewDateTime	string	Jedná se o datum a čas, kdy je potřeba zkontrolovat Zvýhodněné hybridní využití Azure.
properties.term	ReservationTerm	Představuje dobu rezervace.
sku	SkuName	Název skladové položky

Odpovědi

Name	Typ	Description
200 OK	ReservationOrderResponse	Prostředek se vytvořil.
202 Accepted	ReservationOrderResponse	Žádost se přijme a zpracovává se. Odkaz na výsledek operace je v záhlaví umístění. Hlavičky Location: string Retry-After: integer
Other Status Codes	Error	Neočekávaná chyba

Příklady

Purchase

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:

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

Stavový kód:

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

Definice

Name	Description
AppliedScopeProperties	Vlastnosti specifické pro použitý typ oboru. Není vyžadováno, pokud není k dispozici. Povinné a je potřeba zadat tenantId a managementGroupId, pokud appliedScopeType je ManagementGroup.
AppliedScopeType	Typ použitého oboru.
BillingCurrencyTotal	Měna a částka, které budou zákazníkovi účtovány v místní měně zákazníka při nákupu pro prodloužení platnosti. Daň není zahrnuta.
createdByType	Typ identity, která prostředek vytvořila.
Error	Informace o chybě
ErrorResponseCode	Kód chyby popisující důvod, proč služba nemůže zpracovat příchozí požadavek
ExtendedErrorInfo	Rozšířené informace o chybách, včetně kódu chyby a chybové zprávy
ExtendedStatusInfo
InstanceFlexibility	Zapnutím této možnosti se sleva za rezervaci uplatní na ostatní virtuální počítače ve stejné skupině velikostí virtuálních počítačů. Pro VirtualMachines zadejte pouze rezervovaný typ prostředku.
Kind	Typ poskytovatele prostředků, který se má rezervovat.
PaymentDetail	Informace o platbě související s objednávkou rezervace.
PaymentStatus	Popisuje, jestli je platba dokončená, neúspěšná, zrušená nebo naplánovaná v budoucnu.
Price	Informace o cenách obsahující částku a kód měny
PricingCurrencyTotal	Částka, kterou Microsoft používá k záznamu. Používá se při refundaci pro výpočet limitu refundace. Daň není zahrnuta. Tato cena je uzamčena 30 dní před vypršením platnosti.
ProvisioningState	Představuje aktuální stav rezervace.
PurchaseRequest	Žádost o nákup rezervace
RenewPropertiesResponse	Prodloužení vlastností rezervace.
ReservationBillingPlan	Představuje fakturační plány.
ReservationMergeProperties	Vlastnosti sloučení rezervací
ReservationOrderBillingPlanInformation	Informace popisující typ fakturačního plánu pro tuto rezervaci
ReservationOrderResponse	Podrobnosti o vracené objednávce rezervace
ReservationResponse	Definice rezervace.
ReservationSplitProperties	Vlastnosti rozdělení rezervací
ReservationsProperties	Vlastnosti rezervací
ReservationStatusCode
ReservationSwapProperties	Vlastnosti prohození rezervací
ReservationTerm	Představuje dobu rezervace.
ReservationUtilizationAggregates	Agregované hodnoty využití rezervací
ReservedResourceProperties	Vlastnosti specifické pro každý rezervovaný typ prostředku. Není vyžadováno, pokud není k dispozici.
ReservedResourceType	Typ prostředku, který je rezervován.
SkuName	Název skladové položky
systemData	Metadata týkající se vytvoření a poslední změny prostředku.
Utilization	Využití rezervace

AppliedScopeProperties

Vlastnosti specifické pro použitý typ oboru. Není vyžadováno, pokud není k dispozici. Povinné a je potřeba zadat tenantId a managementGroupId, pokud appliedScopeType je ManagementGroup.

Name	Typ	Description
displayName	string	Zobrazované jméno
managementGroupId	string	Plně kvalifikovaný identifikátor skupiny pro správu, ve které musí být výhoda uplatněna.
resourceGroupId	string	Plně kvalifikovaný identifikátor skupiny prostředků.
subscriptionId	string	Plně kvalifikovaný identifikátor předplatného.
tenantId	string	ID tenanta, u kterého by plán úspory měl použít výhodu

AppliedScopeType

Typ použitého oboru.

Name	Typ	Description
ManagementGroup	string
Shared	string
Single	string

BillingCurrencyTotal

Měna a částka, které budou zákazníkovi účtovány v místní měně zákazníka při nákupu pro prodloužení platnosti. Daň není zahrnuta.

Name	Typ	Description
amount	number
currencyCode	string	3písmenný kód měny ISO 4217 pro měnu používanou tímto záznamem o nákupu.

createdByType

Typ identity, která prostředek vytvořila.

Name	Typ	Description
Application	string
Key	string
ManagedIdentity	string
User	string

Error

Informace o chybě

Name	Typ	Description
error	ExtendedErrorInfo	Rozšířené informace o chybách, včetně kódu chyby a chybové zprávy

ErrorResponseCode

Kód chyby popisující důvod, proč služba nemůže zpracovat příchozí požadavek

Name	Typ	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

Rozšířené informace o chybách, včetně kódu chyby a chybové zprávy

Name	Typ	Description
code	ErrorResponseCode	Kód chyby popisující důvod, proč služba nemůže zpracovat příchozí požadavek
message	string

ExtendedStatusInfo

Name	Typ	Description
message	string	Zpráva s podrobnými informacemi o stavovém kódu.
statusCode	ReservationStatusCode

InstanceFlexibility

Zapnutím této možnosti se sleva za rezervaci uplatní na ostatní virtuální počítače ve stejné skupině velikostí virtuálních počítačů. Pro VirtualMachines zadejte pouze rezervovaný typ prostředku.

Name	Typ	Description
Off	string
On	string

Kind

Typ poskytovatele prostředků, který se má rezervovat.

Name	Typ	Description
Microsoft.Compute	string

PaymentDetail

Informace o platbě související s objednávkou rezervace.

Name	Typ	Description
billingAccount	string	Zobrazuje účet, kterému se tato platba naúčtuje.
billingCurrencyTotal	Price	Účtovaná částka ve fakturační měně. Daň není zahrnuta. Je null pro budoucí platby
dueDate	string	Datum, kdy je potřeba provést platbu.
extendedStatusInfo	ExtendedStatusInfo
paymentDate	string	Datum, kdy je transakce dokončena. Má hodnotu null, pokud je naplánovaná.
pricingCurrencyTotal	Price	Částka v cenové měně. Daň není zahrnuta.
status	PaymentStatus	Popisuje, jestli je platba dokončená, neúspěšná, zrušená nebo naplánovaná v budoucnu.

PaymentStatus

Popisuje, jestli je platba dokončená, neúspěšná, zrušená nebo naplánovaná v budoucnu.

Name	Typ	Description
Cancelled	string
Failed	string
Scheduled	string
Succeeded	string

Price

Informace o cenách obsahující částku a kód měny

Name	Typ	Description
amount	number
currencyCode	string	3písmenný kód měny ISO 4217 pro měnu používanou tímto záznamem o nákupu.

PricingCurrencyTotal

Částka, kterou Microsoft používá k záznamu. Používá se při refundaci pro výpočet limitu refundace. Daň není zahrnuta. Tato cena je uzamčena 30 dní před vypršením platnosti.

Name	Typ	Description
amount	number
currencyCode	string	3písmenný kód měny ISO 4217 pro měnu používanou tímto záznamem o nákupu.

ProvisioningState

Představuje aktuální stav rezervace.

Name	Typ	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

Žádost o nákup rezervace

Name	Typ	Default value	Description
location	string		Oblast Azure, ve které se nachází rezervovaný prostředek.
properties.appliedScopeProperties	AppliedScopeProperties		Vlastnosti specifické pro použitý typ oboru. Není vyžadováno, pokud není k dispozici. Povinné a je potřeba zadat tenantId a managementGroupId, pokud appliedScopeType je ManagementGroup.
properties.appliedScopeType	AppliedScopeType		Typ použitého oboru.
properties.appliedScopes	string[]		Seznam předplatných, na která se výhoda použije. Nezadávejte, jestli je AppliedScopeType shared. Tato vlastnost bude vyřazena a nahrazena appliedScopeProperties místo pro Single AppliedScopeType.
properties.billingPlan	ReservationBillingPlan		Představuje fakturační plány.
properties.billingScopeId	string		Předplatné, které se bude účtovat za nákup rezervace nebo úspory
properties.displayName	string		Popisný název rezervace
properties.quantity	integer		Množství skladových položek, které jsou součástí rezervace.
properties.renew	boolean	False	Pokud tuto hodnotu nastavíte na true, automaticky se k datu vypršení platnosti zakoupí nová rezervace.
properties.reservedResourceProperties	ReservedResourceProperties		Vlastnosti specifické pro každý rezervovaný typ prostředku. Není vyžadováno, pokud není k dispozici.
properties.reservedResourceType	ReservedResourceType		Typ prostředku, který je rezervován.
properties.reviewDateTime	string		Jedná se o datum a čas, kdy je potřeba zkontrolovat Zvýhodněné hybridní využití Azure.
properties.term	ReservationTerm		Představuje dobu rezervace.
sku	SkuName		Název skladové položky

RenewPropertiesResponse

Prodloužení vlastností rezervace.

Name	Typ	Description
billingCurrencyTotal	BillingCurrencyTotal	Měna a částka, které budou zákazníkovi účtovány v místní měně zákazníka při nákupu pro prodloužení platnosti. Daň není zahrnuta.
pricingCurrencyTotal	PricingCurrencyTotal	Částka, kterou Microsoft používá k záznamu. Používá se při refundaci pro výpočet limitu refundace. Daň není zahrnuta. Tato cena je uzamčena 30 dní před vypršením platnosti.
purchaseProperties	PurchaseRequest	Žádost o nákup rezervace

ReservationBillingPlan

Představuje fakturační plány.

Name	Typ	Description
Monthly	string
Upfront	string

ReservationMergeProperties

Vlastnosti sloučení rezervací

Name	Typ	Description
mergeDestination	string	ID prostředku rezervace vytvořeného kvůli sloučení. Formát ID prostředku je /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}
mergeSources	string[]	ID prostředků zdrojové rezervace sloučená za účelem vytvoření této rezervace Formát ID prostředku je /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}

ReservationOrderBillingPlanInformation

Informace popisující typ fakturačního plánu pro tuto rezervaci

Name	Typ	Description
nextPaymentDueDate	string	U plánů opakované fakturace označuje datum zpracování další platby. Hodnota Null, když se součet vyplácí.
pricingCurrencyTotal	Price	Částka, která má být zaplacena za objednávku. Daň není zahrnuta.
startDate	string	Datum, kdy fakturační plán začal.
transactions	PaymentDetail[]	Informace o platbě související s objednávkou rezervace.

ReservationOrderResponse

Podrobnosti o vracené objednávce rezervace

Name	Typ	Description
etag	integer
id	string	Identifikátor rezervace
name	string	Název rezervace
properties.benefitStartTime	string	Toto je datum a čas, kdy výhoda rezervace začala.
properties.billingPlan	ReservationBillingPlan	Představuje fakturační plány.
properties.createdDateTime	string	Toto je datum a čas vytvoření rezervace.
properties.displayName	string	Popisný název pro uživatele, aby snadno identifikoval rezervaci.
properties.expiryDate	string	Toto je datum, kdy vyprší platnost rezervace.
properties.expiryDateTime	string	Toto je datum a čas, kdy vyprší platnost rezervace.
properties.originalQuantity	integer	Total Množství skladových položek zakoupených v rezervaci
properties.planInformation	ReservationOrderBillingPlanInformation	Informace popisující typ fakturačního plánu pro tuto rezervaci
properties.provisioningState	ProvisioningState	Aktuální stav rezervace.
properties.requestDateTime	string	Toto je datum a čas, kdy byla rezervace původně požádána o nákup.
properties.reservations	ReservationResponse[]	Definice rezervace.
properties.reviewDateTime	string	Jedná se o datum a čas, kdy je potřeba Zvýhodněné hybridní využití Azure zkontrolovat.
properties.term	ReservationTerm	Představuje dobu rezervace.
systemData	systemData	Metadata týkající se vytvoření a poslední změny prostředku.
type	string	Typ prostředku. Microsoft.Capacity/reservations

ReservationResponse

Definice rezervace.

Name	Typ	Description
etag	integer
id	string	Plně kvalifikované ID prostředku Například /subscriptions/{id_předplatného}/resourceGroups/{název_skupiny_prostředků}/providers/{název_poskytovatele_prostředku}/{typ_prostředku}/{název_prostředku}.
kind	Kind	Typ poskytovatele prostředků, který se má rezervovat.
location	string	Oblast Azure, ve které se nachází rezervovaný prostředek.
name	string	Název prostředku
properties	ReservationsProperties	Vlastnosti přidružené k této rezervaci
sku	SkuName	Informace o SKU přidružené k této rezervaci
systemData	systemData	Azure Resource Manager metadata obsahující informace createdBy a modifiedBy.
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

ReservationSplitProperties

Vlastnosti rozdělení rezervací

Name	Typ	Description
splitDestinations	string[]	Seznam ID cílového prostředku, které se vytvořily z důvodu rozdělení Formát ID prostředku je /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}
splitSource	string	ID prostředku rezervace, ze které se rozdělí. Formát ID prostředku je /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}

ReservationsProperties

Vlastnosti rezervací

Name	Typ	Default value	Description
appliedScopeProperties	AppliedScopeProperties		Vlastnosti specifické pro použitý typ oboru. Není vyžadováno, pokud není k dispozici. Povinné a je potřeba zadat tenantId a managementGroupId, pokud appliedScopeType je ManagementGroup.
appliedScopeType	AppliedScopeType		Použitý typ oboru
appliedScopes	string[]		Seznam použitých oborů
archived	boolean		Označuje, jestli je rezervace archivovaná.
benefitStartTime	string		Toto je datum a čas, kdy výhoda rezervace začala.
billingPlan	ReservationBillingPlan		Možnosti fakturačního plánu dostupné pro tuto skladovou položku
billingScopeId	string		Předplatné, které se bude účtovat za nákup rezervace nebo úspory
capabilities	string		Možnosti rezervace
displayName	string		Popisný název pro uživatele, který snadno identifikuje rezervaci
displayProvisioningState	string		Stav zřizování rezervace pro zobrazení, např. Úspěch
effectiveDateTime	string		DateTime rezervace, od které začíná platnost této verze.
expiryDate	string		Toto je datum, kdy vyprší platnost rezervace.
expiryDateTime	string		Toto je datum a čas, kdy vyprší platnost rezervace.
extendedStatusInfo	ExtendedStatusInfo		Zpráva s podrobnými informacemi o stavovém kódu.
instanceFlexibility	InstanceFlexibility		Umožňuje uplatnit slevu za rezervaci napříč skladovými položkami v rámci stejné skupiny automatického přizpůsobení. Ne všechny skladové položky podporují flexibilitu velikosti instance.
lastUpdatedDateTime	string		DateTime poslední aktualizace rezervace.
mergeProperties	ReservationMergeProperties		Vlastnosti sloučení rezervací
provisioningState	ProvisioningState		Aktuální stav rezervace.
provisioningSubState	string		Dílčí stav zřizování rezervace, např. Úspěšné
purchaseDate	string		Toto je datum, kdy byla rezervace zakoupena.
purchaseDateTime	string		Jedná se o datum a čas, kdy byla rezervace zakoupena.
quantity	integer		Množství skladových položek, které jsou součástí rezervace.
renew	boolean	False	Pokud tuto hodnotu nastavíte na true, automaticky se k datu vypršení platnosti zakoupí nová rezervace.
renewDestination	string		ID rezervace zakoupené z důvodu prodloužení. Formát ID prostředku je /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}.
renewProperties	RenewPropertiesResponse		Prodloužení vlastností rezervace.
renewSource	string		ID rezervace, ze které se tato rezervace obnovuje. Formát ID prostředku je /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}.
reservedResourceType	ReservedResourceType		Typ prostředku, který je rezervován.
reviewDateTime	string		Jedná se o datum a čas, kdy je potřeba Zvýhodněné hybridní využití Azure zkontrolovat.
skuDescription	string		Popis skladové položky v angličtině.
splitProperties	ReservationSplitProperties		Vlastnosti rozdělení rezervací
swapProperties	ReservationSwapProperties		Vlastnosti prohození rezervací
term	ReservationTerm		Představuje dobu rezervace.
userFriendlyAppliedScopeType	string		Použitý typ rozsahu rezervace pro zobrazení, například Sdílené
userFriendlyRenewState	string		Stav prodloužení rezervace pro zobrazení, např. Zapnuto
utilization	Utilization		Využití rezervace

ReservationStatusCode

Name	Typ	Description
Active	string
Expired	string
Merged	string
None	string
PaymentInstrumentError	string
Pending	string
Processing	string
PurchaseError	string
Split	string
Succeeded	string

ReservationSwapProperties

Vlastnosti prohození rezervací

Name	Typ	Description
swapDestination	string	ID prostředku rezervace, na který se původní prostředek prohodí. Formát ID prostředku je /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}
swapSource	string	ID prostředku zdrojové rezervace, která se prohodí. Formát ID prostředku je /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}

ReservationTerm

Představuje dobu rezervace.

Name	Typ	Description
P1Y	string
P3Y	string
P5Y	string

ReservationUtilizationAggregates

Agregované hodnoty využití rezervací

Name	Typ	Description
grain	number	Agregační interval
grainUnit	string	Agregační jednotka agregace
value	number	Agregovaná hodnota
valueUnit	string	Jednotka agregované hodnoty

ReservedResourceProperties

Vlastnosti specifické pro každý rezervovaný typ prostředku. Není vyžadováno, pokud není k dispozici.

Name	Typ	Description
instanceFlexibility	InstanceFlexibility	Zapnutím této možnosti se sleva za rezervaci uplatní na ostatní virtuální počítače ve stejné skupině velikostí virtuálních počítačů. Pro VirtualMachines zadejte pouze rezervovaný typ prostředku.

ReservedResourceType

Typ prostředku, který je rezervován.

Name	Typ	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

Název skladové položky

Name	Typ	Description
name	string

systemData

Metadata týkající se vytvoření a poslední změny prostředku.

Name	Typ	Description
createdAt	string	Časové razítko vytvoření prostředku (UTC)
createdBy	string	Identita, která vytvořila prostředek.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string	Časové razítko poslední změny prostředku (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.

Utilization

Využití rezervace

Name	Typ	Description
aggregates	ReservationUtilizationAggregates[]	Pole agregací využití rezervace
trend	string	Trend využití rezervace za posledních 7 dnů