Reservation Order - List

Dienst:

Reserved VM Instances

API-Version:

2022-11-01

Rufen Sie alle ReservationOrders ab.
Liste aller ReservationOrder, auf die der Benutzer im aktuellen Mandanten zugreifen kann.

GET https://management.azure.com/providers/Microsoft.Capacity/reservationOrders?api-version=2022-11-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
api-version	query	True	string	Unterstützte Version.

Antworten

Name	Typ	Beschreibung
200 OK	ReservationOrderList	Liste der ReservationOrder
Other Status Codes	Error	Unerwarteter Fehler

Beispiele

ReservationOrderList

Beispielanforderung

HTTP

GET https://management.azure.com/providers/Microsoft.Capacity/reservationOrders?api-version=2022-11-01

Java

/**
 * Samples for ReservationOrder List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/reservations/resource-manager/Microsoft.Capacity/stable/2022-11-01/examples/GetReservationOrders.
     * json
     */
    /**
     * Sample code: ReservationOrderList.
     * 
     * @param manager Entry point to ReservationsManager.
     */
    public static void reservationOrderList(com.azure.resourcemanager.reservations.ReservationsManager manager) {
        manager.reservationOrders().list(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 get_reservation_orders.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.list()
    for item in response:
        print(item)


# x-ms-original-file: specification/reservations/resource-manager/Microsoft.Capacity/stable/2022-11-01/examples/GetReservationOrders.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/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/GetReservationOrders.json
func ExampleReservationOrderClient_NewListPager() {
	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)
	}
	pager := clientFactory.NewReservationOrderClient().NewListPager(nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ReservationOrderList = armreservations.ReservationOrderList{
		// 	Value: []*armreservations.ReservationOrderResponse{
		// 		{
		// 			Name: to.Ptr("1e6407ba-37a5-499f-80ed-a3f0f338e443"),
		// 			Type: to.Ptr("Microsoft.Capacity/reservationOrders"),
		// 			Etag: to.Ptr[int32](7),
		// 			ID: to.Ptr("/providers/microsoft.capacity/reservationOrders/1e6407ba-37a5-499f-80ed-a3f0f338e443"),
		// 			Properties: &armreservations.ReservationOrderProperties{
		// 				BenefitStartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-08-29T21:20:23.813Z"); return t}()),
		// 				BillingPlan: to.Ptr(armreservations.ReservationBillingPlanMonthly),
		// 				CreatedDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-08-29T21:22:56.854Z"); return t}()),
		// 				DisplayName: to.Ptr("cabri"),
		// 				ExpiryDate: to.Ptr(func() time.Time { t, _ := time.Parse("2006-01-02", "2018-08-29"); return t}()),
		// 				ExpiryDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-08-29T21:20:23.813Z"); return t}()),
		// 				OriginalQuantity: to.Ptr[int32](1),
		// 				ProvisioningState: to.Ptr(armreservations.ProvisioningStateSucceeded),
		// 				RequestDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-08-29T21:20:23.813Z"); return t}()),
		// 				Reservations: []*armreservations.ReservationResponse{
		// 					{
		// 						ID: to.Ptr("/providers/microsoft.capacity/reservationOrders/1e6407ba-37a5-499f-80ed-a3f0f338e443/reservations/cae5924e-7a15-419f-a369-124f52d4a106"),
		// 				}},
		// 				Term: to.Ptr(armreservations.ReservationTermP1Y),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("1ea6e203-288e-4732-b9e1-da8bbe10c614"),
		// 			Type: to.Ptr("Microsoft.Capacity/reservationOrders"),
		// 			Etag: to.Ptr[int32](7),
		// 			ID: to.Ptr("/providers/microsoft.capacity/reservationOrders/1ea6e203-288e-4732-b9e1-da8bbe10c614"),
		// 			Properties: &armreservations.ReservationOrderProperties{
		// 				BenefitStartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-08-30T12:55:40.279Z"); return t}()),
		// 				BillingPlan: to.Ptr(armreservations.ReservationBillingPlanMonthly),
		// 				CreatedDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-08-30T12:58:20.526Z"); 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-30T12:58:20.526Z"); return t}()),
		// 				OriginalQuantity: to.Ptr[int32](9),
		// 				ProvisioningState: to.Ptr(armreservations.ProvisioningStateSucceeded),
		// 				RequestDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-08-30T12:55:40.279Z"); return t}()),
		// 				Reservations: []*armreservations.ReservationResponse{
		// 					{
		// 						ID: to.Ptr("/providers/microsoft.capacity/reservationOrders/1ea6e203-288e-4732-b9e1-da8bbe10c614/reservations/d04fd48d-e3f6-42a3-a8f6-1ad0b7513e48"),
		// 				}},
		// 				Term: to.Ptr(armreservations.ReservationTermP1Y),
		// 			},
		// 		},
		// 		{
		// 			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{
		// 				BenefitStartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-08-30T03:49:19.025Z"); return t}()),
		// 				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 List of all the `ReservationOrder`s that the user has access to in the current tenant.
 *
 * @summary List of all the `ReservationOrder`s that the user has access to in the current tenant.
 * x-ms-original-file: specification/reservations/resource-manager/Microsoft.Capacity/stable/2022-11-01/examples/GetReservationOrders.json
 */
async function reservationOrderList() {
  const credential = new DefaultAzureCredential();
  const client = new AzureReservationAPI(credential);
  const resArray = new Array();
  for await (let item of client.reservationOrder.list()) {
    resArray.push(item);
  }
  console.log(resArray);
}

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 Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Reservations.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Reservations;

// Generated from example definition: specification/reservations/resource-manager/Microsoft.Capacity/stable/2022-11-01/examples/GetReservationOrders.json
// this example is just showing the usage of "ReservationOrder_List" 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);

TenantResource tenantResource = client.GetTenants().GetAllAsync().GetAsyncEnumerator().Current;

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

// invoke the operation and iterate over the result
await foreach (ReservationOrderResource item in collection.GetAllAsync())
{
    // the variable item 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 = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

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

{
  "value": [
    {
      "id": "/providers/microsoft.capacity/reservationOrders/1e6407ba-37a5-499f-80ed-a3f0f338e443",
      "type": "Microsoft.Capacity/reservationOrders",
      "name": "1e6407ba-37a5-499f-80ed-a3f0f338e443",
      "etag": 7,
      "properties": {
        "displayName": "cabri",
        "requestDateTime": "2017-08-29T21:20:23.8134834Z",
        "createdDateTime": "2017-08-29T21:22:56.8541664Z",
        "benefitStartTime": "2017-08-29T21:20:23.8134834Z",
        "expiryDate": "2018-08-29",
        "expiryDateTime": "2018-08-29T21:20:23.8134834Z",
        "term": "P1Y",
        "billingPlan": "Monthly",
        "provisioningState": "Succeeded",
        "reservations": [
          {
            "id": "/providers/microsoft.capacity/reservationOrders/1e6407ba-37a5-499f-80ed-a3f0f338e443/reservations/cae5924e-7a15-419f-a369-124f52d4a106"
          }
        ],
        "originalQuantity": 1
      }
    },
    {
      "id": "/providers/microsoft.capacity/reservationOrders/1ea6e203-288e-4732-b9e1-da8bbe10c614",
      "type": "Microsoft.Capacity/reservationOrders",
      "name": "1ea6e203-288e-4732-b9e1-da8bbe10c614",
      "etag": 7,
      "properties": {
        "displayName": "cabri",
        "benefitStartTime": "2017-08-30T12:55:40.2799114Z",
        "requestDateTime": "2017-08-30T12:55:40.2799114Z",
        "createdDateTime": "2017-08-30T12:58:20.526Z",
        "expiryDate": "2018-08-30",
        "expiryDateTime": "2018-08-30T12:58:20.526Z",
        "term": "P1Y",
        "billingPlan": "Monthly",
        "provisioningState": "Succeeded",
        "reservations": [
          {
            "id": "/providers/microsoft.capacity/reservationOrders/1ea6e203-288e-4732-b9e1-da8bbe10c614/reservations/d04fd48d-e3f6-42a3-a8f6-1ad0b7513e48"
          }
        ],
        "originalQuantity": 9
      }
    },
    {
      "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",
        "benefitStartTime": "2017-08-30T03:49:19.0252126Z",
        "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
      }
    }
  ],
  "nextLink": "https://management.azure.com/providers/Microsoft.Capacity/reservationOrders?api-version=2017-11-01&%24skiptoken=eyJyZyI6IjIwNTkyMzdlLWY3MmYtNDczYi1hNTZiLWExOGJkM2UwMDhlZCIsImlnIjpudWxsLCJzdCI6bnVsbH0%3d"
}

Definitionen

Name	Beschreibung
AppliedScopeProperties	Eigenschaften, die für den angewendeten Bereichstyp spezifisch sind. Nicht erforderlich, falls nicht zutreffend. Erforderlich und muss tenantId und managementGroupId bereitstellen, wenn AppliedScopeType managementGroup ist
AppliedScopeType	Typ des angewendeten Bereichs.
BillingCurrencyTotal	Währung und Betrag, den der Kunde in der lokalen Währung des Kunden für den Verlängerungskauf in Rechnung gestellt wird. 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 virtuelle Computer 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 einer Reservierungsbestellung.
PaymentStatus	Beschreibt, ob die Zahlung in Zukunft abgeschlossen, fehlgeschlagen, storniert oder geplant ist.
Price	Preisinformationen, die den Betrag und den Währungscode enthalten
PricingCurrencyTotal	Betrag, den Microsoft für Datensatz verwendet. Wird während der Rückerstattung für die Berechnung des Erstattungslimits verwendet. Steuer ist nicht inbegriffen. Dieser Preis ist 30 Tage vor Ablauf gesperrt.
ProvisioningState	Stellt den aktuellen Status der Reservierung dar.
PurchaseRequest	Die Anfrage zum Reservierungskauf
RenewPropertiesResponse	Die Verlängerungseigenschaften für eine Reservierung.
ReservationBillingPlan	Stellen Sie die Abrechnungspläne dar.
ReservationMergeProperties	Eigenschaften der Reservierungszusammenführung
ReservationOrderBillingPlanInformation	Informationen zur Beschreibung der Art des Abrechnungsplans für diese Reservierung.
ReservationOrderList	Liste der ReservationOrder
ReservationOrderResponse	Details einer Reservierungsbestellung, die zurückgegeben wird.
ReservationResponse	Die Definition der Reservierung.
ReservationSplitProperties	Eigenschaften der Reservierung geteilt
ReservationsProperties	Die Eigenschaften der Reservierungen
ReservationStatusCode
ReservationSwapProperties	Eigenschaften des Reservierungstauschs
ReservationTerm	Stellt den Reservierungstermin dar.
ReservationUtilizationAggregates	Die Aggregatwerte der Reservierungsnutzung
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 zur Erstellung und letzten Änderung der Ressource.
Utilization	Reservierungsnutzung

AppliedScopeProperties

Objekt

Eigenschaften, die für den angewendeten Bereichstyp spezifisch sind. Nicht erforderlich, falls nicht zutreffend. Erforderlich und muss tenantId und managementGroupId bereitstellen, 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 Vorteile anwenden soll.

AppliedScopeType

Enumeration

Typ des angewendeten Bereichs.

Wert	Beschreibung
ManagementGroup
Shared
Single

BillingCurrencyTotal

Objekt

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

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

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
Application
Key
ManagedIdentity
User

Error

Objekt

Fehlerinformationen

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

ErrorResponseCode

Enumeration

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

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

ExtendedErrorInfo

Objekt

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

Objekt

Name	Typ	Beschreibung
message	string	Die Meldung, die detaillierte Informationen zum Statuscode enthält.
statusCode	ReservationStatusCode

InstanceFlexibility

Enumeration

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

Wert	Beschreibung
Off
On

Kind

Enumeration

Ressourcenanbietertyp, der reserviert werden soll.

Wert	Beschreibung
Microsoft.Compute

PaymentDetail

Objekt

Informationen zur Zahlung im Zusammenhang mit einer Reservierungsbestellung.

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

PaymentStatus

Enumeration

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

Wert	Beschreibung
Cancelled
Failed
Scheduled
Succeeded

Price

Objekt

Preisinformationen, die den Betrag und den Währungscode enthalten

Name	Typ	Beschreibung
amount	number (double)
currencyCode	string	Der ISO 4217-3-Buchstaben-Währungscode für die währung, die von diesem Einkaufsdatensatz verwendet wird.

PricingCurrencyTotal

Objekt

Betrag, den Microsoft für Datensatz verwendet. Wird während der Rückerstattung für die Berechnung des Erstattungslimits verwendet. Steuer ist nicht inbegriffen. Dieser Preis ist 30 Tage vor Ablauf gesperrt.

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

ProvisioningState

Enumeration

Stellt den aktuellen Status der Reservierung dar.

Wert	Beschreibung
BillingFailed
Cancelled
ConfirmedBilling
ConfirmedResourceHold
Created
Creating
Expired
Failed
Merged
PendingBilling
PendingResourceHold
Split
Succeeded

PurchaseRequest

Objekt

Die Anfrage zum Reservierungskauf

Name	Typ	Standardwert	Beschreibung
location	string		Die Azure-Region, in der sich die reservierte Ressource befindet.
properties.appliedScopeProperties	AppliedScopeProperties		Eigenschaften, die für den angewendeten Bereichstyp spezifisch sind. Nicht erforderlich, falls nicht zutreffend. Erforderlich und muss tenantId und managementGroupId bereitstellen, wenn AppliedScopeType managementGroup ist
properties.appliedScopeType	AppliedScopeType		Typ des angewendeten Bereichs.
properties.appliedScopes	string[]		Liste der Abonnements, auf die der Vorteil angewendet wird. Geben Sie nicht an, ob AppliedScopeType freigegeben ist. Diese Eigenschaft ist veraltet und wird stattdessen durch appliedScopeProperties für Single AppliedScopeType ersetzt.
properties.billingPlan	ReservationBillingPlan		Stellen Sie 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 (int32)		Menge der Skus, die Teil der Reservierung sind.
properties.renew	boolean	False	Wenn Sie diesen Wert 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 (date-time)		Dies ist die Uhrzeit, zu der der Azure-Hybridvorteil überprüft werden muss.
properties.term	ReservationTerm		Stellt den Reservierungstermin dar.
sku	SkuName		Der Name der Sku

RenewPropertiesResponse

Objekt

Die Verlängerungseigenschaften für eine Reservierung.

Name	Typ	Beschreibung
billingCurrencyTotal	BillingCurrencyTotal	Währung und Betrag, den der Kunde in der lokalen Währung des Kunden für den Verlängerungskauf in Rechnung gestellt wird. Steuer ist nicht inbegriffen.
pricingCurrencyTotal	PricingCurrencyTotal	Betrag, den Microsoft für Datensatz verwendet. Wird während der Rückerstattung für die Berechnung des Erstattungslimits verwendet. Steuer ist nicht inbegriffen. Dieser Preis ist 30 Tage vor Ablauf gesperrt.
purchaseProperties	PurchaseRequest	Die Anfrage zum Reservierungskauf

ReservationBillingPlan

Enumeration

Stellen Sie die Abrechnungspläne dar.

Wert	Beschreibung
Monthly
Upfront

ReservationMergeProperties

Objekt

Eigenschaften der Reservierungszusammenführung

Name	Typ	Beschreibung
mergeDestination	string	Die Reservierungsressourcen-ID wurde aufgrund des Seriendrucks erstellt. Format der Ressourcen-ID ist /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}
mergeSources	string[]	Ressourcen-IDs der zusammengeführten Quellreservierung, um diese Reservierung zu bilden. Format der Ressourcen-ID ist /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}

ReservationOrderBillingPlanInformation

Objekt

Informationen zur Beschreibung der Art des Abrechnungsplans für diese Reservierung.

Name	Typ	Beschreibung
nextPaymentDueDate	string (date)	Gibt für wiederkehrende Abrechnungspläne 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 gezahlt werden soll. Steuer ist nicht inbegriffen.
startDate	string (date)	Datum, an dem der Abrechnungsplan gestartet wurde.
transactions	PaymentDetail[]	Informationen zur Zahlung im Zusammenhang mit einer Reservierungsbestellung.

ReservationOrderList

Objekt

Liste der ReservationOrder

Name	Typ	Beschreibung
nextLink	string	Url zum Abrufen der nächsten Seite von reservationOrders.
value	ReservationOrderResponse[]	Details einer Reservierungsbestellung, die zurückgegeben wird.

ReservationOrderResponse

Objekt

Details einer Reservierungsbestellung, die zurückgegeben wird.

Name	Typ	Beschreibung
etag	integer (int32)
id	string	Bezeichner der Reservierung
name	string	Name der Reservierung
properties.benefitStartTime	string (date-time)	Dies ist dateTime, wenn der Reservierungsvorteil gestartet wurde.
properties.billingPlan	ReservationBillingPlan	Stellen Sie die Abrechnungspläne dar.
properties.createdDateTime	string (date-time)	Dies ist die DateTime, als die Reservierung erstellt wurde.
properties.displayName	string	Anzeigename für den Benutzer, um die Reservierung leicht zu identifizieren.
properties.expiryDate	string (date)	Dies ist das Datum, an dem die Reservierung abläuft.
properties.expiryDateTime	string (date-time)	Dies ist die Uhrzeit, zu der die Reservierung abläuft.
properties.originalQuantity	integer (int32)	Gesamtmenge der in der Reservierung erworbenen Skus.
properties.planInformation	ReservationOrderBillingPlanInformation	Informationen zur Beschreibung der Art des Abrechnungsplans für diese Reservierung.
properties.provisioningState	ProvisioningState	Aktueller Status der Reservierung.
properties.requestDateTime	string (date-time)	Dies ist dateTime, als die Reservierung ursprünglich zum Kauf angefordert wurde.
properties.reservations	ReservationResponse[]	Die Definition der Reservierung.
properties.reviewDateTime	string (date-time)	Dies ist die Uhrzeit, zu der der Azure-Hybridvorteil überprüft werden muss.
properties.term	ReservationTerm	Stellt den Reservierungstermin dar.
systemData	systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
type	string	Typ der Ressource. "Microsoft.Capacity/reservations"

ReservationResponse

Objekt

Die Definition der Reservierung.

Name	Typ	Beschreibung
etag	integer (int32)
id	string (arm-id)	Vollqualifizierte Ressourcen-ID für die Ressource. Z. B. "/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, die createdBy- und modifiedBy-Informationen enthalten.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

ReservationSplitProperties

Objekt

Eigenschaften der Reservierung geteilt

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

ReservationsProperties

Objekt

Die Eigenschaften der Reservierungen

Name	Typ	Standardwert	Beschreibung
appliedScopeProperties	AppliedScopeProperties		Eigenschaften, die für den angewendeten Bereichstyp spezifisch sind. Nicht erforderlich, falls nicht zutreffend. Erforderlich und muss tenantId und managementGroupId bereitstellen, wenn AppliedScopeType managementGroup ist
appliedScopeType	AppliedScopeType		Der angewendete Bereichstyp
appliedScopes	string[]		Die Liste der angewendeten Bereiche
archived	boolean		Gibt an, ob die Reservierung archiviert ist.
benefitStartTime	string (date-time)		Dies ist dateTime, wenn 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 benutzerfreundliche Identifizierung der Reservierung
displayProvisioningState	string		Der Bereitstellungsstatus der Reservierung für die Anzeige, z. B. erfolgreich
effectiveDateTime	string (date-time)		DateTime der Reservierung ab dem Zeitpunkt, ab dem diese Version wirksam ist.
expiryDate	string (date)		Dies ist das Datum, an dem die Reservierung abläuft.
expiryDateTime	string (date-time)		Dies ist die Uhrzeit, zu der die Reservierung abläuft.
extendedStatusInfo	ExtendedStatusInfo		Die Meldung, die detaillierte Informationen zum Statuscode enthält.
instanceFlexibility	InstanceFlexibility		Ermöglicht die Anwendung des Reservierungsrabatts über Skus innerhalb derselben Automatisch angepassten Gruppe. Nicht alle Skus unterstützen die Flexibilität der Instanzengröße.
lastUpdatedDateTime	string (date-time)		DateTime der letzten Aktualisierung der Reservierung.
mergeProperties	ReservationMergeProperties		Eigenschaften der Reservierungszusammenführung
provisioningState	ProvisioningState		Aktueller Status der Reservierung.
provisioningSubState	string		Der Bereitstellungsunterstatus der Reservierung, z. B. erfolgreich
purchaseDate	string (date)		Dies ist das Datum, an dem die Reservierung erworben wurde.
purchaseDateTime	string (date-time)		Dies ist die Uhrzeit, zu der die Reservierung erworben wurde.
quantity	integer (int32)		Menge der Skus, die Teil der Reservierung sind.
renew	boolean	False	Wenn Sie diesen Wert auf "true" festlegen, wird automatisch eine neue Reservierung am Ablaufdatum erworben.
renewDestination	string		Reservierungs-ID der Reservierung, die aufgrund der Verlängerung gekauft 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 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 (date-time)		Dies ist die Uhrzeit, zu der der Azure-Hybridvorteil überprüft werden muss.
skuDescription	string		Beschreibung der Sku in Englisch.
splitProperties	ReservationSplitProperties		Eigenschaften der Reservierung geteilt
swapProperties	ReservationSwapProperties		Eigenschaften des Reservierungstauschs
term	ReservationTerm		Stellt den Reservierungstermin dar.
userFriendlyAppliedScopeType	string		Der angewendete Bereichstyp der Reservierung für die Anzeige, z. B. Freigegeben
userFriendlyRenewState	string		Der Verlängerungszustand der Reservierung zur Anzeige, z. B. Ein
utilization	Utilization		Reservierungsnutzung

ReservationStatusCode

Enumeration

Wert	Beschreibung
Active
Expired
Merged
None
PaymentInstrumentError
Pending
Processing
PurchaseError
Split
Succeeded

ReservationSwapProperties

Objekt

Eigenschaften des Reservierungstauschs

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

ReservationTerm

Enumeration

Stellt den Reservierungstermin dar.

Wert	Beschreibung
P1Y
P3Y
P5Y

ReservationUtilizationAggregates

Objekt

Die Aggregatwerte der Reservierungsnutzung

Name	Typ	Beschreibung
grain	number	Das Korn des Aggregats
grainUnit	string	Die Korneinheit des Aggregats
value	number	Der Aggregatwert
valueUnit	string	Die Aggregatwerteinheit

ReservedResourceProperties

Objekt

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 virtuelle Computer in derselben VM-Größengruppe angewendet. Geben Sie nur für den reservierten Ressourcentyp "VirtualMachines" an.

ReservedResourceType

Enumeration

Der Typ der Ressource, die reserviert wird.

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

SkuName

Objekt

Der Name der Sku

Name	Typ	Beschreibung
name	string

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	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 (date-time)	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

Objekt

Reservierungsnutzung

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