Reservation - Update

Referenz

Dienst:: Reserved VM Instances

API-Version:: 2022-11-01

Aktualisiert eine Reservation.
Aktualisiert die angewendeten Bereiche der Reservation.

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

URI-Parameter

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

Anforderungstext

Name	Typ	Beschreibung
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.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.
properties.name	string	Anzeigename der Reservierung
properties.renew	boolean	Wenn Sie diesen Wert auf "true" festlegen, wird automatisch eine neue Reservierung am Ablaufdatum erworben.
properties.renewProperties	RenewProperties
properties.reviewDateTime	string (date-time)	Dies ist die Uhrzeit, zu der der Azure-Hybridvorteil überprüft werden muss.

Antworten

Name Typ Beschreibung

200 OK

ReservationResponse

Gibt die aktualisierte Reservationzurück.

202 Accepted

Die Anforderung wird akzeptiert und verarbeitet.

Header

Azure-AsyncOperation: string
Location: string
Retry-After: integer

Other Status Codes

Unerwarteter Fehler

Beispiele

PatchReservation

Beispielanforderung

PATCH https://management.azure.com/providers/Microsoft.Capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/6ef59113-3482-40da-8d79-787f823e34bc?api-version=2022-11-01

{
  "properties": {
    "appliedScopeType": "Shared",
    "instanceFlexibility": "Off"
  }
}


import com.azure.resourcemanager.reservations.models.AppliedScopeType;
import com.azure.resourcemanager.reservations.models.InstanceFlexibility;
import com.azure.resourcemanager.reservations.models.PatchModel;

/**
 * Samples for Reservation Update.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/reservations/resource-manager/Microsoft.Capacity/stable/2022-11-01/examples/UpdateReservation.json
     */
    /**
     * Sample code: PatchReservation.
     * 
     * @param manager Entry point to ReservationsManager.
     */
    public static void patchReservation(com.azure.resourcemanager.reservations.ReservationsManager manager) {
        manager.reservations().update(
            "276e7ae4-84d0-4da6-ab4b-d6b94f3557da", "6ef59113-3482-40da-8d79-787f823e34bc", new PatchModel()
                .withAppliedScopeType(AppliedScopeType.SHARED).withInstanceFlexibility(InstanceFlexibility.OFF),
            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 update_reservation.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.begin_update(
        reservation_order_id="276e7ae4-84d0-4da6-ab4b-d6b94f3557da",
        reservation_id="6ef59113-3482-40da-8d79-787f823e34bc",
        parameters={"properties": {"appliedScopeType": "Shared", "instanceFlexibility": "Off"}},
    ).result()
    print(response)


# x-ms-original-file: specification/reservations/resource-manager/Microsoft.Capacity/stable/2022-11-01/examples/UpdateReservation.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/UpdateReservation.json
func ExampleReservationClient_BeginUpdate() {
	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.NewReservationClient().BeginUpdate(ctx, "276e7ae4-84d0-4da6-ab4b-d6b94f3557da", "6ef59113-3482-40da-8d79-787f823e34bc", armreservations.Patch{
		Properties: &armreservations.PatchProperties{
			AppliedScopeType:    to.Ptr(armreservations.AppliedScopeTypeShared),
			InstanceFlexibility: to.Ptr(armreservations.InstanceFlexibilityOff),
		},
	}, 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.ReservationResponse = armreservations.ReservationResponse{
	// 	Name: to.Ptr("6ef59113-3482-40da-8d79-787f823e34bc"),
	// 	Type: to.Ptr("Microsoft.Capacity/reservationOrders/reservations"),
	// 	ID: to.Ptr("/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/6ef59113-3482-40da-8d79-787f823e34bc"),
	// 	Etag: to.Ptr[int32](4),
	// 	Location: to.Ptr("eastus"),
	// 	Properties: &armreservations.Properties{
	// 		AppliedScopeType: to.Ptr(armreservations.AppliedScopeTypeShared),
	// 		BillingPlan: to.Ptr(armreservations.ReservationBillingPlanMonthly),
	// 		BillingScopeID: to.Ptr("/subscriptions/19376483-64b8-49e4-a931-d5248828720a"),
	// 		DisplayName: to.Ptr("cabri_test"),
	// 		EffectiveDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-09-22T23:57:48.189Z"); return t}()),
	// 		ExpiryDate: to.Ptr(func() time.Time { t, _ := time.Parse("2006-01-02", "2018-09-22"); return t}()),
	// 		ExpiryDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-09-22T23:57:48.189Z"); return t}()),
	// 		InstanceFlexibility: to.Ptr(armreservations.InstanceFlexibilityOff),
	// 		LastUpdatedDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-09-22T23:57:54.376Z"); return t}()),
	// 		MergeProperties: &armreservations.ReservationMergeProperties{
	// 			MergeSources: []*string{
	// 				to.Ptr("/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/00238563-7312-4c20-a134-8c030bf938a7"),
	// 				to.Ptr("/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/e0e4b4f5-77ea-4984-9ee4-6bf9850ee6de")},
	// 			},
	// 			ProvisioningState: to.Ptr(armreservations.ProvisioningStateSucceeded),
	// 			Quantity: to.Ptr[int32](3),
	// 			Renew: to.Ptr(false),
	// 			ReservedResourceType: to.Ptr(armreservations.ReservedResourceTypeVirtualMachines),
	// 			SKUDescription: to.Ptr("D1 v2"),
	// 		},
	// 		SKU: &armreservations.SKUName{
	// 			Name: to.Ptr("Standard_DS1_v2"),
	// 		},
	// 	}
}

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 Updates the applied scopes of the `Reservation`.
 *
 * @summary Updates the applied scopes of the `Reservation`.
 * x-ms-original-file: specification/reservations/resource-manager/Microsoft.Capacity/stable/2022-11-01/examples/UpdateReservation.json
 */
async function patchReservation() {
  const reservationOrderId = "276e7ae4-84d0-4da6-ab4b-d6b94f3557da";
  const reservationId = "6ef59113-3482-40da-8d79-787f823e34bc";
  const parameters = {
    appliedScopeType: "Shared",
    instanceFlexibility: "Off",
  };
  const credential = new DefaultAzureCredential();
  const client = new AzureReservationAPI(credential);
  const result = await client.reservation.beginUpdateAndWait(
    reservationOrderId,
    reservationId,
    parameters
  );
  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 Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Reservations.Models;
using Azure.ResourceManager.Reservations;

// Generated from example definition: specification/reservations/resource-manager/Microsoft.Capacity/stable/2022-11-01/examples/UpdateReservation.json
// this example is just showing the usage of "Reservation_Update" 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 ReservationDetailResource created on azure
// for more information of creating ReservationDetailResource, please refer to the document of ReservationDetailResource
Guid reservationOrderId = Guid.Parse("276e7ae4-84d0-4da6-ab4b-d6b94f3557da");
Guid reservationId = Guid.Parse("6ef59113-3482-40da-8d79-787f823e34bc");
ResourceIdentifier reservationDetailResourceId = ReservationDetailResource.CreateResourceIdentifier(reservationOrderId, reservationId);
ReservationDetailResource reservationDetail = client.GetReservationDetailResource(reservationDetailResourceId);

// invoke the operation
ReservationDetailPatch patch = new ReservationDetailPatch
{
    AppliedScopeType = AppliedScopeType.Shared,
    InstanceFlexibility = InstanceFlexibility.Off,
};
ArmOperation<ReservationDetailResource> lro = await reservationDetail.UpdateAsync(WaitUntil.Completed, patch);
ReservationDetailResource 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
ReservationDetailData 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

{
  "sku": {
    "name": "Standard_DS1_v2"
  },
  "id": "/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/6ef59113-3482-40da-8d79-787f823e34bc",
  "type": "Microsoft.Capacity/reservationOrders/reservations",
  "name": "6ef59113-3482-40da-8d79-787f823e34bc",
  "etag": 4,
  "location": "eastus",
  "properties": {
    "appliedScopeType": "Shared",
    "renew": false,
    "billingScopeId": "/subscriptions/19376483-64b8-49e4-a931-d5248828720a",
    "quantity": 3,
    "provisioningState": "Succeeded",
    "expiryDate": "2018-09-22",
    "expiryDateTime": "2018-09-22T23:57:48.1891638Z",
    "displayName": "cabri_test",
    "billingPlan": "Monthly",
    "effectiveDateTime": "2017-09-22T23:57:48.1891638Z",
    "lastUpdatedDateTime": "2017-09-22T23:57:54.3768768Z",
    "reservedResourceType": "VirtualMachines",
    "instanceFlexibility": "Off",
    "skuDescription": "D1 v2",
    "mergeProperties": {
      "mergeSources": [
        "/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/00238563-7312-4c20-a134-8c030bf938a7",
        "/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/e0e4b4f5-77ea-4984-9ee4-6bf9850ee6de"
      ]
    }
  }
}

Statuscode:: 202

Azure-AsyncOperation: https://management.azure.com/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/6ef59113-3482-40da-8d79-787f823e34bc?api-version=2022-11-01
Location: https://management.azure.com/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/6ef59113-3482-40da-8d79-787f823e34bc?api-version=2022-11-01
Retry-After: 120

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.
Patch	Die Anforderung des Reservierungspatches
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
RenewProperties
RenewPropertiesResponse	Die Verlängerungseigenschaften für eine Reservierung.
ReservationBillingPlan	Stellen Sie die Abrechnungspläne dar.
ReservationMergeProperties	Eigenschaften der Reservierungszusammenführung
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

Patch

Objekt

Die Anforderung des Reservierungspatches

Name	Typ	Standardwert	Beschreibung
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.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.
properties.name	string		Anzeigename der Reservierung
properties.renew	boolean	False	Wenn Sie diesen Wert auf "true" festlegen, wird automatisch eine neue Reservierung am Ablaufdatum erworben.
properties.renewProperties	RenewProperties
properties.reviewDateTime	string (date-time)		Dies ist die Uhrzeit, zu der der Azure-Hybridvorteil überprüft werden muss.

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

RenewProperties

Objekt

Name	Typ	Beschreibung
purchaseProperties	PurchaseRequest	Die Anfrage zum Reservierungskauf

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}

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