Reservation - Update

Riferimento

Servizio:: Reserved VM Instances

Versione API:: 2022-11-01

Aggiorna un Reservation.
Aggiorna gli ambiti applicati del Reservation.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
reservationId	path	True	string	ID dell'elemento della prenotazione
reservationOrderId	path	True	string	ID ordine della prenotazione
api-version	query	True	string	Versione supportata.

Corpo della richiesta

Nome	Tipo	Descrizione
properties.appliedScopeProperties	AppliedScopeProperties	Proprietà specifiche del tipo di ambito applicato. Non obbligatorio se non applicabile. Obbligatorio e necessario fornire tenantId e managementGroupId se AppliedScopeType è ManagementGroup
properties.appliedScopeType	AppliedScopeType	Tipo dell'ambito applicato.
properties.appliedScopes	string[]	Elenco delle sottoscrizioni a cui verrà applicato il vantaggio. Non specificare se AppliedScopeType è Condiviso. Questa proprietà verrà deprecata e sostituita da appliedScopeProperties per Single AppliedScopeType.
properties.instanceFlexibility	InstanceFlexibility	L'attivazione di questa opzione applicherà lo sconto per la prenotazione ad altre macchine virtuali nello stesso gruppo di dimensioni della macchina virtuale. Specificare solo per il tipo di risorsa riservata VirtualMachines.
properties.name	string	Nome visualizzato della prenotazione
properties.renew	boolean	L'impostazione di questa proprietà su true acquisterà automaticamente una nuova prenotazione all'ora di scadenza.
properties.renewProperties	RenewProperties
properties.reviewDateTime	string (date-time)	Questo è l'ora in cui è necessario esaminare il vantaggio Azure Hybrid.

Risposte

Nome Tipo Descrizione

200 OK

ReservationResponse

Restituisce il Reservationaggiornato.

202 Accepted

La richiesta viene accettata ed è in corso l'elaborazione

Intestazioni

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

Other Status Codes

Errore imprevisto

Esempio

PatchReservation

Esempio di richiesta

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

Risposta di esempio

Codice di stato:: 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"
      ]
    }
  }
}

Codice di stato:: 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

Definizioni

Nome	Descrizione
AppliedScopeProperties	Proprietà specifiche del tipo di ambito applicato. Non obbligatorio se non applicabile. Obbligatorio e necessario fornire tenantId e managementGroupId se AppliedScopeType è ManagementGroup
AppliedScopeType	Tipo dell'ambito applicato.
BillingCurrencyTotal	Valuta e importo che il cliente verrà addebitato nella valuta locale del cliente per l'acquisto di rinnovo. L'imposta non è inclusa.
createdByType	Tipo di identità che ha creato la risorsa.
Error	Informazioni sull'errore
ErrorResponseCode	Codice di errore che descrive il motivo per cui il servizio non è in grado di elaborare la richiesta in ingresso
ExtendedErrorInfo	Informazioni estese sugli errori, inclusi il codice di errore e il messaggio di errore
ExtendedStatusInfo
InstanceFlexibility	L'attivazione di questa opzione applicherà lo sconto per la prenotazione ad altre macchine virtuali nello stesso gruppo di dimensioni della macchina virtuale. Specificare solo per il tipo di risorsa riservata VirtualMachines.
Kind	Tipo di provider di risorse da riservare.
Patch	Richiesta di patch per la prenotazione
PricingCurrencyTotal	Quantità utilizzata da Microsoft per il record. Utilizzato durante il rimborso per il calcolo del limite di rimborso. L'imposta non è inclusa. Questo è il prezzo bloccato 30 giorni prima della scadenza.
ProvisioningState	Rappresenta lo stato corrente della prenotazione.
PurchaseRequest	Richiesta di acquisto della prenotazione
RenewProperties
RenewPropertiesResponse	Proprietà di rinnovo per una prenotazione.
ReservationBillingPlan	Rappresenta i piani di fatturazione.
ReservationMergeProperties	Proprietà dell'unione di prenotazioni
ReservationResponse	Definizione della prenotazione.
ReservationSplitProperties	Proprietà della divisione della prenotazione
ReservationsProperties	Proprietà delle prenotazioni
ReservationStatusCode
ReservationSwapProperties	Proprietà dello scambio di prenotazioni
ReservationTerm	Rappresenta il termine della prenotazione.
ReservationUtilizationAggregates	Valori aggregati dell'utilizzo della prenotazione
ReservedResourceProperties	Proprietà specifiche di ogni tipo di risorsa riservata. Non obbligatorio se non applicabile.
ReservedResourceType	Tipo della risorsa riservata.
SkuName	Nome dello SKU
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.
Utilization	Utilizzo delle prenotazioni

AppliedScopeProperties

Object

Proprietà specifiche del tipo di ambito applicato. Non obbligatorio se non applicabile. Obbligatorio e necessario fornire tenantId e managementGroupId se AppliedScopeType è ManagementGroup

Nome	Tipo	Descrizione
displayName	string	Nome visualizzato
managementGroupId	string	Identificatore completo del gruppo di gestione in cui è necessario applicare il vantaggio.
resourceGroupId	string	Identificatore completo del gruppo di risorse.
subscriptionId	string	Identificatore completo della sottoscrizione.
tenantId	string	ID tenant in cui il piano di risparmio deve applicare il vantaggio.

AppliedScopeType

Enumerazione

Tipo dell'ambito applicato.

Valore	Descrizione
ManagementGroup
Shared
Single

BillingCurrencyTotal

Object

Valuta e importo che il cliente verrà addebitato nella valuta locale del cliente per l'acquisto di rinnovo. L'imposta non è inclusa.

Nome	Tipo	Descrizione
amount	number
currencyCode	string	Codice valuta ISO 4217 a 3 lettere per la valuta utilizzata da questo record di acquisto.

createdByType

Enumerazione

Tipo di identità che ha creato la risorsa.

Valore	Descrizione
Application
Key
ManagedIdentity
User

Error

Object

Informazioni sull'errore

Nome	Tipo	Descrizione
error	ExtendedErrorInfo	Informazioni estese sugli errori, inclusi il codice di errore e il messaggio di errore

ErrorResponseCode

Enumerazione

Codice di errore che descrive il motivo per cui il servizio non è in grado di elaborare la richiesta in ingresso

Valore	Descrizione
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

Object

Informazioni estese sugli errori, inclusi il codice di errore e il messaggio di errore

Nome	Tipo	Descrizione
code	ErrorResponseCode	Codice di errore che descrive il motivo per cui il servizio non è in grado di elaborare la richiesta in ingresso
message	string

ExtendedStatusInfo

Object

Nome	Tipo	Descrizione
message	string	Messaggio che fornisce informazioni dettagliate sul codice di stato.
statusCode	ReservationStatusCode

InstanceFlexibility

Enumerazione

L'attivazione di questa opzione applicherà lo sconto per la prenotazione ad altre macchine virtuali nello stesso gruppo di dimensioni della macchina virtuale. Specificare solo per il tipo di risorsa riservata VirtualMachines.

Valore	Descrizione
Off
On

Kind

Enumerazione

Tipo di provider di risorse da riservare.

Valore	Descrizione
Microsoft.Compute

Patch

Object

Richiesta di patch per la prenotazione

Nome	Tipo	Valore predefinito	Descrizione
properties.appliedScopeProperties	AppliedScopeProperties		Proprietà specifiche del tipo di ambito applicato. Non obbligatorio se non applicabile. Obbligatorio e necessario fornire tenantId e managementGroupId se AppliedScopeType è ManagementGroup
properties.appliedScopeType	AppliedScopeType		Tipo dell'ambito applicato.
properties.appliedScopes	string[]		Elenco delle sottoscrizioni a cui verrà applicato il vantaggio. Non specificare se AppliedScopeType è Condiviso. Questa proprietà verrà deprecata e sostituita da appliedScopeProperties per Single AppliedScopeType.
properties.instanceFlexibility	InstanceFlexibility		L'attivazione di questa opzione applicherà lo sconto per la prenotazione ad altre macchine virtuali nello stesso gruppo di dimensioni della macchina virtuale. Specificare solo per il tipo di risorsa riservata VirtualMachines.
properties.name	string		Nome visualizzato della prenotazione
properties.renew	boolean	False	L'impostazione di questa proprietà su true acquisterà automaticamente una nuova prenotazione all'ora di scadenza.
properties.renewProperties	RenewProperties
properties.reviewDateTime	string (date-time)		Questo è l'ora in cui è necessario esaminare il vantaggio Azure Hybrid.

PricingCurrencyTotal

Object

Quantità utilizzata da Microsoft per il record. Utilizzato durante il rimborso per il calcolo del limite di rimborso. L'imposta non è inclusa. Questo è il prezzo bloccato 30 giorni prima della scadenza.

Nome	Tipo	Descrizione
amount	number
currencyCode	string	Codice valuta ISO 4217 a 3 lettere per la valuta utilizzata da questo record di acquisto.

ProvisioningState

Enumerazione

Rappresenta lo stato corrente della prenotazione.

Valore	Descrizione
BillingFailed
Cancelled
ConfirmedBilling
ConfirmedResourceHold
Created
Creating
Expired
Failed
Merged
PendingBilling
PendingResourceHold
Split
Succeeded

PurchaseRequest

Object

Richiesta di acquisto della prenotazione

Nome	Tipo	Valore predefinito	Descrizione
location	string		Area di Azure in cui risiede la risorsa riservata.
properties.appliedScopeProperties	AppliedScopeProperties		Proprietà specifiche del tipo di ambito applicato. Non obbligatorio se non applicabile. Obbligatorio e necessario fornire tenantId e managementGroupId se AppliedScopeType è ManagementGroup
properties.appliedScopeType	AppliedScopeType		Tipo dell'ambito applicato.
properties.appliedScopes	string[]		Elenco delle sottoscrizioni a cui verrà applicato il vantaggio. Non specificare se AppliedScopeType è Condiviso. Questa proprietà verrà deprecata e sostituita da appliedScopeProperties per Single AppliedScopeType.
properties.billingPlan	ReservationBillingPlan		Rappresenta i piani di fatturazione.
properties.billingScopeId	string		Sottoscrizione che verrà addebitata per l'acquisto della prenotazione o del piano di risparmio
properties.displayName	string		Nome descrittivo della prenotazione
properties.quantity	integer (int32)		Quantità degli SKU che fanno parte della prenotazione.
properties.renew	boolean	False	L'impostazione di questa proprietà su true acquisterà automaticamente una nuova prenotazione all'ora di scadenza.
properties.reservedResourceProperties	ReservedResourceProperties		Proprietà specifiche di ogni tipo di risorsa riservata. Non obbligatorio se non applicabile.
properties.reservedResourceType	ReservedResourceType		Tipo della risorsa riservata.
properties.reviewDateTime	string (date-time)		Questo è l'ora in cui è necessario esaminare il vantaggio Azure Hybrid.
properties.term	ReservationTerm		Rappresenta il termine della prenotazione.
sku	SkuName		Nome dello SKU

RenewProperties

Object

Nome	Tipo	Descrizione
purchaseProperties	PurchaseRequest	Richiesta di acquisto della prenotazione

RenewPropertiesResponse

Object

Proprietà di rinnovo per una prenotazione.

Nome	Tipo	Descrizione
billingCurrencyTotal	BillingCurrencyTotal	Valuta e importo che il cliente verrà addebitato nella valuta locale del cliente per l'acquisto di rinnovo. L'imposta non è inclusa.
pricingCurrencyTotal	PricingCurrencyTotal	Quantità utilizzata da Microsoft per il record. Utilizzato durante il rimborso per il calcolo del limite di rimborso. L'imposta non è inclusa. Questo è il prezzo bloccato 30 giorni prima della scadenza.
purchaseProperties	PurchaseRequest	Richiesta di acquisto della prenotazione

ReservationBillingPlan

Enumerazione

Rappresenta i piani di fatturazione.

Valore	Descrizione
Monthly
Upfront

ReservationMergeProperties

Object

Proprietà dell'unione di prenotazioni

Nome	Tipo	Descrizione
mergeDestination	string	ID risorsa prenotazione Creato a causa dell'unione. Il formato dell'ID risorsa è /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}
mergeSources	string[]	ID risorsa della prenotazione di origine uniti per formare questa prenotazione. Il formato dell'ID risorsa è /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}

ReservationResponse

Object

Definizione della prenotazione.

Nome	Tipo	Descrizione
etag	integer (int32)
id	string (arm-id)	ID risorsa completo per la risorsa. Ad esempio, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind	Kind	Tipo di provider di risorse da riservare.
location	string	Area di Azure in cui risiede la risorsa riservata.
name	string	Nome della risorsa
properties	ReservationsProperties	Proprietà associate a questa prenotazione
sku	SkuName	Informazioni sullo SKU associate a questa prenotazione
systemData	systemData	Metadati di Azure Resource Manager contenenti le informazioni createdBy e modifiedBy.
type	string	Tipo della risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

ReservationSplitProperties

Object

Proprietà della divisione della prenotazione

Nome	Tipo	Descrizione
splitDestinations	string[]	Elenco dell'ID risorsa di destinazione creato a causa della divisione. Il formato dell'ID risorsa è /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}
splitSource	string	ID risorsa della prenotazione da cui viene divisa. Il formato dell'ID risorsa è /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}

ReservationsProperties

Object

Proprietà delle prenotazioni

Nome	Tipo	Valore predefinito	Descrizione
appliedScopeProperties	AppliedScopeProperties		Proprietà specifiche del tipo di ambito applicato. Non obbligatorio se non applicabile. Obbligatorio e necessario fornire tenantId e managementGroupId se AppliedScopeType è ManagementGroup
appliedScopeType	AppliedScopeType		Tipo di ambito applicato
appliedScopes	string[]		Elenco di ambiti applicati
archived	boolean		Indica se la prenotazione è archiviata
benefitStartTime	string (date-time)		DateTime all'avvio del vantaggio di prenotazione.
billingPlan	ReservationBillingPlan		Opzioni del piano di fatturazione disponibili per questo SKU.
billingScopeId	string		Sottoscrizione che verrà addebitata per l'acquisto della prenotazione o del piano di risparmio
capabilities	string		Funzionalità della prenotazione
displayName	string		Nome descrittivo per l'utente per identificare facilmente la prenotazione
displayProvisioningState	string		Stato di provisioning della prenotazione per la visualizzazione, ad esempio Succeeded
effectiveDateTime	string (date-time)		DateTime della prenotazione a partire da quando questa versione è valida.
expiryDate	string (date)		Questa è la data di scadenza della prenotazione.
expiryDateTime	string (date-time)		Data e ora di scadenza della prenotazione.
extendedStatusInfo	ExtendedStatusInfo		Messaggio che fornisce informazioni dettagliate sul codice di stato.
instanceFlexibility	InstanceFlexibility		Consente di applicare lo sconto per la prenotazione tra sku all'interno dello stesso gruppo di adattamento automatico. Non tutti gli SKU supportano la flessibilità delle dimensioni dell'istanza.
lastUpdatedDateTime	string (date-time)		DateTime dell'ultima volta che la prenotazione è stata aggiornata.
mergeProperties	ReservationMergeProperties		Proprietà dell'unione di prenotazioni
provisioningState	ProvisioningState		Stato corrente della prenotazione.
provisioningSubState	string		Stato secondario del provisioning della prenotazione, ad esempio Succeeded
purchaseDate	string (date)		Questa è la data in cui la prenotazione è stata acquistata.
purchaseDateTime	string (date-time)		Questa è la data in cui è stata acquistata la prenotazione.
quantity	integer (int32)		Quantità degli SKU che fanno parte della prenotazione.
renew	boolean	False	L'impostazione di questa proprietà su true acquisterà automaticamente una nuova prenotazione all'ora di scadenza.
renewDestination	string		ID prenotazione della prenotazione acquistata a causa del rinnovo. Il formato dell'ID risorsa è /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}.
renewProperties	RenewPropertiesResponse		Proprietà di rinnovo per una prenotazione.
renewSource	string		ID prenotazione della prenotazione da cui viene rinnovata la prenotazione. Il formato dell'ID risorsa è /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}.
reservedResourceType	ReservedResourceType		Tipo della risorsa riservata.
reviewDateTime	string (date-time)		Questa è la data in cui è necessario esaminare il vantaggio Azure Hybrid.
skuDescription	string		Descrizione dello SKU in inglese.
splitProperties	ReservationSplitProperties		Proprietà della divisione della prenotazione
swapProperties	ReservationSwapProperties		Proprietà dello scambio di prenotazioni
term	ReservationTerm		Rappresenta il termine della prenotazione.
userFriendlyAppliedScopeType	string		Tipo di ambito applicato della prenotazione per la visualizzazione, ad esempio Condiviso
userFriendlyRenewState	string		Stato di rinnovo della prenotazione per la visualizzazione, ad esempio Attivato
utilization	Utilization		Utilizzo delle prenotazioni

ReservationStatusCode

Enumerazione

Valore	Descrizione
Active
Expired
Merged
None
PaymentInstrumentError
Pending
Processing
PurchaseError
Split
Succeeded

ReservationSwapProperties

Object

Proprietà dello scambio di prenotazioni

Nome	Tipo	Descrizione
swapDestination	string	ID risorsa prenotazione a cui viene scambiata la risorsa originale. Il formato dell'ID risorsa è /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}
swapSource	string	ID risorsa della prenotazione di origine che viene scambiata. Il formato dell'ID risorsa è /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}

ReservationTerm

Enumerazione

Rappresenta il termine della prenotazione.

Valore	Descrizione
P1Y
P3Y
P5Y

ReservationUtilizationAggregates

Object

Valori aggregati dell'utilizzo della prenotazione

Nome	Tipo	Descrizione
grain	number	Granularità dell'aggregazione
grainUnit	string	Unità di granularità dell'aggregazione
value	number	Valore aggregato
valueUnit	string	Unità valore aggregato

ReservedResourceProperties

Object

Proprietà specifiche di ogni tipo di risorsa riservata. Non obbligatorio se non applicabile.

Nome	Tipo	Descrizione
instanceFlexibility	InstanceFlexibility	L'attivazione di questa opzione applicherà lo sconto per la prenotazione ad altre macchine virtuali nello stesso gruppo di dimensioni della macchina virtuale. Specificare solo per il tipo di risorsa riservata VirtualMachines.

ReservedResourceType

Enumerazione

Tipo della risorsa riservata.

Valore	Descrizione
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

Object

Nome dello SKU

Nome	Tipo	Descrizione
name	string

systemData

Object

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string (date-time)	Timestamp della creazione della risorsa (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string (date-time)	Timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy	string	Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima volta la risorsa.

Utilization

Object

Utilizzo delle prenotazioni

Nome	Tipo	Descrizione
aggregates	ReservationUtilizationAggregates[]	Matrice di aggregazioni dell'utilizzo di una prenotazione
trend	string	Tendenza di utilizzo degli ultimi 7 giorni per una prenotazione