Reservation Order - Purchase

Referenz

Dienst:: Reserved VM Instances

API-Version:: 2022-11-01

Erwerben ReservationOrder und erstellen Sie eine Ressource unter dem angegebenen URI.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
reservationOrderId	path	True	string	Bestell-ID der Reservierung
api-version	query	True	string	Unterstützte Version.

Anforderungstext

Name	Typ	Beschreibung
location	string	Die Azure-Region, in der sich die reservierte Ressource befindet.
properties.appliedScopeProperties	AppliedScopeProperties	Spezifische Eigenschaften für den angewendeten Bereichstyp. Nicht erforderlich, falls nicht zutreffend. Erforderlich und müssen tenantId und managementGroupId angeben, wenn AppliedScopeType ManagementGroup ist.
properties.appliedScopeType	AppliedScopeType	Typ des angewendeten Bereichs.
properties.appliedScopes	string[]	Liste der Abonnements, für die der Vorteil angewendet wird. Geben Sie nicht an, ob AppliedScopeType freigegeben ist. Diese Eigenschaft wird veraltet und stattdessen durch appliedScopeProperties für Single AppliedScopeType ersetzt.
properties.billingPlan	ReservationBillingPlan	Stellt die Abrechnungspläne dar.
properties.billingScopeId	string	Abonnement, das für den Kauf einer Reservierung oder eines Sparplans in Rechnung gestellt wird
properties.displayName	string	Anzeigename der Reservierung
properties.quantity	integer	Anzahl der Skus, die Teil der Reservierung sind.
properties.renew	boolean	Wenn Sie dies auf true festlegen, wird automatisch eine neue Reservierung am Ablaufdatum erworben.
properties.reservedResourceProperties	ReservedResourceProperties	Eigenschaften, die für jeden reservierten Ressourcentyp spezifisch sind. Nicht erforderlich, falls nicht zutreffend.
properties.reservedResourceType	ReservedResourceType	Der Typ der Ressource, die reserviert wird.
properties.reviewDateTime	string	Dies ist das Datum und die Uhrzeit, zu dem der Azure-Hybridvorteil überprüft werden muss.
properties.term	ReservationTerm	Stellt den Reservierungsbegriff dar.
sku	SkuName	Der Name der SKU

Antworten

Name

Typ

Beschreibung

200 OK

ReservationOrderResponse

Die Ressource wurde erstellt.

202 Accepted

ReservationOrderResponse

Die Anforderung wird akzeptiert und verarbeitet. Vorgangsergebnislink befindet sich im Speicherortheader.

Header

Location: string
Retry-After: integer

Other Status Codes

Unerwarteter Fehler

Beispiele

Purchase

Beispielanforderung

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

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

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

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

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

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://video2.skills-academy.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

Beispiel für eine Antwort

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

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

Definitionen

Name	Beschreibung
AppliedScopeProperties	Spezifische Eigenschaften für den angewendeten Bereichstyp. Nicht erforderlich, falls nicht zutreffend. Erforderlich und müssen tenantId und managementGroupId angeben, wenn AppliedScopeType ManagementGroup ist.
AppliedScopeType	Typ des angewendeten Bereichs.
BillingCurrencyTotal	Währung und Betrag, die dem Kunden für den Verlängerungskauf in der lokalen Währung des Kunden in Rechnung gestellt werden. Die Steuer ist nicht inbegriffen.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
Error	Fehlerinformationen
ErrorResponseCode	Fehlercode, der den Grund beschreibt, warum der Dienst die eingehende Anforderung nicht verarbeiten kann
ExtendedErrorInfo	Erweiterte Fehlerinformationen einschließlich Fehlercode und Fehlermeldung
ExtendedStatusInfo
InstanceFlexibility	Wenn Sie dies aktivieren, wird der Reservierungsrabatt auf andere VMs in derselben VM-Größengruppe angewendet. Geben Sie nur für den reservierten Ressourcentyp VirtualMachines an.
Kind	Ressourcenanbietertyp, der reserviert werden soll.
PaymentDetail	Informationen zur Zahlung im Zusammenhang mit einem Reservierungsauftrag.
PaymentStatus	Beschreibt, ob die Zahlung abgeschlossen, fehlgeschlagen, storniert oder in Zukunft geplant ist.
Price	Preisinformationen mit dem Betrag und dem Währungscode
PricingCurrencyTotal	Der Betrag, den Microsoft für den Datensatz verwendet. Wird während der Rückerstattung zum Berechnen des Erstattungslimits verwendet. Die Steuer ist nicht inbegriffen. Dies ist der Gesperrte Preis 30 Tage vor Ablauf.
ProvisioningState	Stellt den aktuellen Zustand der Reservierung dar.
PurchaseRequest	Die Anforderung für den Reservierungskauf
RenewPropertiesResponse	Die Verlängerungseigenschaften für eine Reservierung.
ReservationBillingPlan	Stellt die Abrechnungspläne dar.
ReservationMergeProperties	Eigenschaften der Reservierungszusammenführung
ReservationOrderBillingPlanInformation	Informationen, die den Abrechnungsplan für diese Reservierung beschreiben.
ReservationOrderResponse	Details eines zurückgesendeten Reservierungsauftrags.
ReservationResponse	Die Definition der Reservierung.
ReservationSplitProperties	Eigenschaften der Reservierungsaufteilung
ReservationsProperties	Die Eigenschaften der Reservierungen
ReservationStatusCode
ReservationSwapProperties	Eigenschaften des Reservierungstauschs
ReservationTerm	Stellt den Reservierungsbegriff dar.
ReservationUtilizationAggregates	Die Aggregatwerte der Reservierungsauslastung
ReservedResourceProperties	Eigenschaften, die für jeden reservierten Ressourcentyp spezifisch sind. Nicht erforderlich, falls nicht zutreffend.
ReservedResourceType	Der Typ der Ressource, die reserviert wird.
SkuName	Der Name der SKU
systemData	Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.
Utilization	Reservierungsnutzung

AppliedScopeProperties

Spezifische Eigenschaften für den angewendeten Bereichstyp. Nicht erforderlich, falls nicht zutreffend. Erforderlich und müssen tenantId und managementGroupId angeben, wenn AppliedScopeType ManagementGroup ist.

Name	Typ	Beschreibung
displayName	string	Anzeigename
managementGroupId	string	Vollqualifizierter Bezeichner der Verwaltungsgruppe, in der der Vorteil angewendet werden muss.
resourceGroupId	string	Vollqualifizierter Bezeichner der Ressourcengruppe.
subscriptionId	string	Vollqualifizierter Bezeichner des Abonnements.
tenantId	string	Mandanten-ID, bei der der Sparplan den Vorteil anwenden soll.

AppliedScopeType

Typ des angewendeten Bereichs.

Name	Typ	Beschreibung
ManagementGroup	string
Shared	string
Single	string

BillingCurrencyTotal

Währung und Betrag, die dem Kunden für den Verlängerungskauf in der lokalen Währung des Kunden in Rechnung gestellt werden. Die Steuer ist nicht inbegriffen.

Name	Typ	Beschreibung
amount	number
currencyCode	string	Der ISO 4217-Währungscode mit drei Buchstaben für die Währung, die von diesem Kaufdatensatz verwendet wird.

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Name	Typ	Beschreibung
Application	string
Key	string
ManagedIdentity	string
User	string

Error

Fehlerinformationen

Name	Typ	Beschreibung
error	ExtendedErrorInfo	Erweiterte Fehlerinformationen einschließlich Fehlercode und Fehlermeldung

ErrorResponseCode

Fehlercode, der den Grund beschreibt, warum der Dienst die eingehende Anforderung nicht verarbeiten kann

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

Erweiterte Fehlerinformationen einschließlich Fehlercode und Fehlermeldung

Name	Typ	Beschreibung
code	ErrorResponseCode	Fehlercode, der den Grund beschreibt, warum der Dienst die eingehende Anforderung nicht verarbeiten kann
message	string

ExtendedStatusInfo

Name	Typ	Beschreibung
message	string	Die Meldung mit detaillierten Informationen zum status Code.
statusCode	ReservationStatusCode

InstanceFlexibility

Wenn Sie dies aktivieren, wird der Reservierungsrabatt auf andere VMs in derselben VM-Größengruppe angewendet. Geben Sie nur für den reservierten Ressourcentyp VirtualMachines an.

Name	Typ	Beschreibung
Off	string
On	string

Kind

Ressourcenanbietertyp, der reserviert werden soll.

Name	Typ	Beschreibung
Microsoft.Compute	string

PaymentDetail

Informationen zur Zahlung im Zusammenhang mit einem Reservierungsauftrag.

Name	Typ	Beschreibung
billingAccount	string	Zeigt das Konto an, das für diese Zahlung in Rechnung gestellt wird.
billingCurrencyTotal	Price	In Abrechnungswährung berechneter Betrag. Steuer nicht inbegriffen. Ist NULL für zukünftige Zahlungen
dueDate	string	Datum, an dem die Zahlung erfolgen muss.
extendedStatusInfo	ExtendedStatusInfo
paymentDate	string	Datum, an dem die Transaktion abgeschlossen ist. Ist NULL, wenn es geplant ist.
pricingCurrencyTotal	Price	Betrag in Preiswährung. Steuer nicht inbegriffen.
status	PaymentStatus	Beschreibt, ob die Zahlung abgeschlossen, fehlgeschlagen, storniert oder in Zukunft geplant ist.

PaymentStatus

Beschreibt, ob die Zahlung abgeschlossen, fehlgeschlagen, storniert oder in Zukunft geplant ist.

Name	Typ	Beschreibung
Cancelled	string
Failed	string
Scheduled	string
Succeeded	string

Price

Preisinformationen mit dem Betrag und dem Währungscode

Name	Typ	Beschreibung
amount	number
currencyCode	string	Der ISO 4217-Währungscode mit drei Buchstaben für die Währung, die von diesem Kaufdatensatz verwendet wird.

PricingCurrencyTotal

Der Betrag, den Microsoft für den Datensatz verwendet. Wird während der Rückerstattung zum Berechnen des Erstattungslimits verwendet. Die Steuer ist nicht inbegriffen. Dies ist der Gesperrte Preis 30 Tage vor Ablauf.

Name	Typ	Beschreibung
amount	number
currencyCode	string	Der ISO 4217-Währungscode mit drei Buchstaben für die Währung, die von diesem Kaufdatensatz verwendet wird.

ProvisioningState

Stellt den aktuellen Zustand der Reservierung dar.

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

Die Anforderung für den Reservierungskauf

Name	Typ	Standardwert	Beschreibung
location	string		Die Azure-Region, in der sich die reservierte Ressource befindet.
properties.appliedScopeProperties	AppliedScopeProperties		Spezifische Eigenschaften für den angewendeten Bereichstyp. Nicht erforderlich, falls nicht zutreffend. Erforderlich und müssen tenantId und managementGroupId angeben, wenn AppliedScopeType ManagementGroup ist.
properties.appliedScopeType	AppliedScopeType		Typ des angewendeten Bereichs.
properties.appliedScopes	string[]		Liste der Abonnements, für die der Vorteil angewendet wird. Geben Sie nicht an, ob AppliedScopeType freigegeben ist. Diese Eigenschaft wird veraltet und stattdessen durch appliedScopeProperties für Single AppliedScopeType ersetzt.
properties.billingPlan	ReservationBillingPlan		Stellt die Abrechnungspläne dar.
properties.billingScopeId	string		Abonnement, das für den Kauf einer Reservierung oder eines Sparplans in Rechnung gestellt wird
properties.displayName	string		Anzeigename der Reservierung
properties.quantity	integer		Anzahl der Skus, die Teil der Reservierung sind.
properties.renew	boolean	False	Wenn Sie dies auf true festlegen, wird automatisch eine neue Reservierung am Ablaufdatum erworben.
properties.reservedResourceProperties	ReservedResourceProperties		Eigenschaften, die für jeden reservierten Ressourcentyp spezifisch sind. Nicht erforderlich, falls nicht zutreffend.
properties.reservedResourceType	ReservedResourceType		Der Typ der Ressource, die reserviert wird.
properties.reviewDateTime	string		Dies ist das Datum und die Uhrzeit, zu dem der Azure-Hybridvorteil überprüft werden muss.
properties.term	ReservationTerm		Stellt den Reservierungsbegriff dar.
sku	SkuName		Der Name der SKU

RenewPropertiesResponse

Die Verlängerungseigenschaften für eine Reservierung.

Name	Typ	Beschreibung
billingCurrencyTotal	BillingCurrencyTotal	Währung und Betrag, die dem Kunden für den Verlängerungskauf in der lokalen Währung des Kunden in Rechnung gestellt werden. Die Steuer ist nicht inbegriffen.
pricingCurrencyTotal	PricingCurrencyTotal	Der Betrag, den Microsoft für den Datensatz verwendet. Wird während der Rückerstattung zum Berechnen des Erstattungslimits verwendet. Die Steuer ist nicht inbegriffen. Dies ist der Gesperrte Preis 30 Tage vor Ablauf.
purchaseProperties	PurchaseRequest	Die Anforderung für den Reservierungskauf

ReservationBillingPlan

Stellt die Abrechnungspläne dar.

Name	Typ	Beschreibung
Monthly	string
Upfront	string

ReservationMergeProperties

Eigenschaften der Reservierungszusammenführung

Name	Typ	Beschreibung
mergeDestination	string	Die Id der Reservierungsressource wurde aufgrund der Zusammenführung erstellt. Das Format der Ressourcen-ID lautet /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}
mergeSources	string[]	Ressourcen-IDs der Quellreservierung werden zusammengeführt, um diese Reservierung zu bilden. Das Format der Ressourcen-ID lautet /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}

ReservationOrderBillingPlanInformation

Informationen, die den Abrechnungsplan für diese Reservierung beschreiben.

Name	Typ	Beschreibung
nextPaymentDueDate	string	Gibt bei wiederkehrenden Abrechnungsplänen das Datum an, an dem die nächste Zahlung verarbeitet wird. Null, wenn die Summe ausbezahlt wird.
pricingCurrencyTotal	Price	Betrag, der für die Bestellung zu zahlen ist. Die Steuer ist nicht inbegriffen.
startDate	string	Datum, an dem der Abrechnungsplan gestartet wurde.
transactions	PaymentDetail[]	Informationen zur Zahlung im Zusammenhang mit einem Reservierungsauftrag.

ReservationOrderResponse

Details eines zurückgesendeten Reservierungsauftrags.

Name	Typ	Beschreibung
etag	integer
id	string	Bezeichner der Reservierung
name	string	Name der Reservierung.
properties.benefitStartTime	string	Dies ist der DateTime-Wert, als der Reservierungsvorteil gestartet wurde.
properties.billingPlan	ReservationBillingPlan	Stellt die Abrechnungspläne dar.
properties.createdDateTime	string	Dies ist der DateTime-Wert, als die Reservierung erstellt wurde.
properties.displayName	string	Anzeigename für den Benutzer, um die Reservierung leicht zu identifizieren.
properties.expiryDate	string	Dies ist das Datum, an dem die Reservierung abläuft.
properties.expiryDateTime	string	Dies ist das Datum und die Uhrzeit, zu dem die Reservierung abläuft.
properties.originalQuantity	integer	Gesamtmenge der in der Reservierung erworbenen Skus.
properties.planInformation	ReservationOrderBillingPlanInformation	Informationen, die den Abrechnungsplan für diese Reservierung beschreiben.
properties.provisioningState	ProvisioningState	Aktueller Status der Reservierung.
properties.requestDateTime	string	Dies ist der DateTime-Wert, bei dem die Reservierung ursprünglich zum Kauf angefordert wurde.
properties.reservations	ReservationResponse[]	Die Definition der Reservierung.
properties.reviewDateTime	string	Dies ist das Datum und die Uhrzeit, zu dem die Azure-Hybridvorteil überprüft werden muss.
properties.term	ReservationTerm	Stellt den Reservierungsbegriff dar.
systemData	systemData	Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.
type	string	Ressourcentyp. "Microsoft.Capacity/reservations"

ReservationResponse

Die Definition der Reservierung.

Name	Typ	Beschreibung
etag	integer
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind	Kind	Ressourcenanbietertyp, der reserviert werden soll.
location	string	Die Azure-Region, in der sich die reservierte Ressource befindet.
name	string	Der Name der Ressource
properties	ReservationsProperties	Die eigenschaften, die dieser Reservierung zugeordnet sind
sku	SkuName	Die dieser Reservierung zugeordneten SKU-Informationen
systemData	systemData	Azure Resource Manager-Metadaten mit createdBy- und modifiedBy-Informationen.
type	string	Der Typ der Ressource. Z.B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

ReservationSplitProperties

Eigenschaften der Reservierungsaufteilung

Name	Typ	Beschreibung
splitDestinations	string[]	Liste der Zielressourcen-ID, die aufgrund der Aufteilung erstellt werden. Das Format der Ressourcen-ID lautet /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}
splitSource	string	Ressourcen-ID der Reservierung, von der dies geteilt wird. Das Format der Ressourcen-ID lautet /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}

ReservationsProperties

Die Eigenschaften der Reservierungen

Name	Typ	Standardwert	Beschreibung
appliedScopeProperties	AppliedScopeProperties		Spezifische Eigenschaften für den angewendeten Bereichstyp. Nicht erforderlich, falls nicht zutreffend. Erforderlich und müssen tenantId und managementGroupId angeben, wenn AppliedScopeType ManagementGroup ist.
appliedScopeType	AppliedScopeType		Der angewendete Bereichstyp
appliedScopes	string[]		Die Liste der angewendeten Bereiche
archived	boolean		Gibt an, ob die Reservierung archiviert wird.
benefitStartTime	string		Dies ist der DateTime-Wert, als der Reservierungsvorteil gestartet wurde.
billingPlan	ReservationBillingPlan		Die für diese SKU verfügbaren Abrechnungsplanoptionen.
billingScopeId	string		Abonnement, das für den Kauf einer Reservierung oder eines Sparplans in Rechnung gestellt wird
capabilities	string		Funktionen der Reservierung
displayName	string		Anzeigename für benutzerfreundliches Identifizieren der Reservierung
displayProvisioningState	string		Der Bereitstellungsstatus der Reservierung für die Anzeige, z. B. Erfolgreich
effectiveDateTime	string		DateTime der Reservierung ab dem Zeitpunkt, ab dem diese Version wirksam wird.
expiryDate	string		Dies ist das Datum, an dem die Reservierung abläuft.
expiryDateTime	string		Dies ist das Datum und die Uhrzeit, zu dem die Reservierung abläuft.
extendedStatusInfo	ExtendedStatusInfo		Die Meldung mit detaillierten Informationen zum status Code.
instanceFlexibility	InstanceFlexibility		Ermöglicht die Anwendung des Reservierungsrabatts auf mehrere Skus innerhalb derselben Gruppe mit automatischer Anpassung. Nicht alle Skus unterstützen instance Größenflexibilität.
lastUpdatedDateTime	string		DateTime der letzten Aktualisierung der Reservierung.
mergeProperties	ReservationMergeProperties		Eigenschaften der Reservierungszusammenführung
provisioningState	ProvisioningState		Aktueller Status der Reservierung.
provisioningSubState	string		Der Bereitstellungsunterzustand der Reservierung, z. B. Erfolgreich
purchaseDate	string		Dies ist das Datum, an dem die Reservierung erworben wurde.
purchaseDateTime	string		Dies ist das Datum und die Uhrzeit des Kaufs der Reservierung.
quantity	integer		Anzahl der Skus, die Teil der Reservierung sind.
renew	boolean	False	Wenn Sie dies auf true festlegen, wird automatisch eine neue Reservierung am Ablaufdatum erworben.
renewDestination	string		Reservierungs-ID der Reservierung, die aufgrund der Verlängerung erworben wird. Das Format der Ressourcen-ID lautet /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}.
renewProperties	RenewPropertiesResponse		Die Verlängerungseigenschaften für eine Reservierung.
renewSource	string		Reservierungs-ID der Reservierung, von der aus diese Reservierung verlängert wird. Das Format der Ressourcen-ID lautet /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}.
reservedResourceType	ReservedResourceType		Der Typ der Ressource, die reserviert wird.
reviewDateTime	string		Dies ist das Datum und die Uhrzeit, zu dem die Azure-Hybridvorteil überprüft werden muss.
skuDescription	string		Beschreibung der SKU in Englisch.
splitProperties	ReservationSplitProperties		Eigenschaften der Reservierungsaufteilung
swapProperties	ReservationSwapProperties		Eigenschaften des Reservierungstauschs
term	ReservationTerm		Stellt den Reservierungsbegriff dar.
userFriendlyAppliedScopeType	string		Der angewendete Bereichstyp der Reservierung für die Anzeige, z. B. Shared
userFriendlyRenewState	string		Der Verlängerungsstatus der Reservierung für die Anzeige, z. B. Ein
utilization	Utilization		Reservierungsnutzung

ReservationStatusCode

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

ReservationSwapProperties

Eigenschaften des Reservierungstauschs

Name	Typ	Beschreibung
swapDestination	string	Reservierungsressourcen-ID, in die die ursprüngliche Ressource getauscht wird. Das Format der Ressourcen-ID lautet /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}
swapSource	string	Ressourcen-ID der Quellreservierung, die getauscht wird. Das Format der Ressourcen-ID lautet /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}

ReservationTerm

Stellt den Reservierungsbegriff dar.

Name	Typ	Beschreibung
P1Y	string
P3Y	string
P5Y	string

ReservationUtilizationAggregates

Die Aggregatwerte der Reservierungsauslastung

Name	Typ	Beschreibung
grain	number	Die Körnung des Aggregats
grainUnit	string	Die Korneinheit des Aggregats
value	number	Der Aggregatwert
valueUnit	string	Die Aggregatwerteinheit

ReservedResourceProperties

Eigenschaften, die für jeden reservierten Ressourcentyp spezifisch sind. Nicht erforderlich, falls nicht zutreffend.

Name	Typ	Beschreibung
instanceFlexibility	InstanceFlexibility	Wenn Sie dies aktivieren, wird der Reservierungsrabatt auf andere VMs in derselben VM-Größengruppe angewendet. Geben Sie nur für den reservierten Ressourcentyp VirtualMachines an.

ReservedResourceType

Der Typ der Ressource, die reserviert wird.

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

Der Name der SKU

Name	Typ	Beschreibung
name	string

systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

Name	Typ	Beschreibung
createdAt	string	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

Utilization

Reservierungsnutzung

Name	Typ	Beschreibung
aggregates	ReservationUtilizationAggregates[]	Das Array von Aggregaten der Auslastung einer Reservierung
trend	string	Auslastungstrend der letzten 7 Tage für eine Reservierung