Reservation - Split

Service:

Reserved VM Instances

API Version:

2022-11-01

Dividere l'oggetto Reservation.
Suddividere un oggetto Reservation in due Reservations con la distribuzione di quantità specificata.

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

Parametri dell'URI

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

Corpo della richiesta

Nome	Tipo	Descrizione
properties.quantities	integer[]	Elenco delle quantità nelle nuove prenotazioni da creare.
properties.reservationId	string	ID risorsa della prenotazione da dividere. Il formato dell'ID risorsa deve essere /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}

Risposte

Nome	Tipo	Descrizione
200 OK	ReservationResponse[]	Elenco di elementi creati dopo l'operazione di Reservationdivisione.
202 Accepted		La richiesta viene accettata e viene elaborata Headers Location: string Retry-After: integer
Other Status Codes	Error	Errore imprevisto

Esempio

Split

Sample Request

HTTP

POST https://management.azure.com/providers/Microsoft.Capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/split?api-version=2022-11-01

{
  "properties": {
    "quantities": [
      1,
      2
    ],
    "reservationId": "/providers/Microsoft.Capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/bcae77cd-3119-4766-919f-b50d36c75c7a"
  }
}

Java

import com.azure.resourcemanager.reservations.models.SplitRequest;
import java.util.Arrays;

/** Samples for Reservation Split. */
public final class Main {
    /*
     * x-ms-original-file: specification/reservations/resource-manager/Microsoft.Capacity/stable/2022-11-01/examples/SplitReservation.json
     */
    /**
     * Sample code: Split.
     *
     * @param manager Entry point to ReservationsManager.
     */
    public static void split(com.azure.resourcemanager.reservations.ReservationsManager manager) {
        manager
            .reservations()
            .split(
                "276e7ae4-84d0-4da6-ab4b-d6b94f3557da",
                new SplitRequest()
                    .withQuantities(Arrays.asList(1, 2))
                    .withReservationId(
                        "/providers/Microsoft.Capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/bcae77cd-3119-4766-919f-b50d36c75c7a"),
                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 split_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_split(
        reservation_order_id="276e7ae4-84d0-4da6-ab4b-d6b94f3557da",
        body={
            "properties": {
                "quantities": [1, 2],
                "reservationId": "/providers/Microsoft.Capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/bcae77cd-3119-4766-919f-b50d36c75c7a",
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/reservations/resource-manager/Microsoft.Capacity/stable/2022-11-01/examples/SplitReservation.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armreservations_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/reservations/armreservations/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1e7b408f3323e7f5424745718fe62c7a043a2337/specification/reservations/resource-manager/Microsoft.Capacity/stable/2022-11-01/examples/SplitReservation.json
func ExampleReservationClient_BeginSplit() {
	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().BeginSplit(ctx, "276e7ae4-84d0-4da6-ab4b-d6b94f3557da", armreservations.SplitRequest{
		Properties: &armreservations.SplitProperties{
			Quantities: []*int32{
				to.Ptr[int32](1),
				to.Ptr[int32](2)},
			ReservationID: to.Ptr("/providers/Microsoft.Capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/bcae77cd-3119-4766-919f-b50d36c75c7a"),
		},
	}, 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.ReservationResponseArray = []*armreservations.ReservationResponse{
	// 	{
	// 		Name: to.Ptr("00238563-7312-4c20-a134-8c030bf938a7"),
	// 		Type: to.Ptr("Microsoft.Capacity/reservationOrders/reservations"),
	// 		ID: to.Ptr("/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/00238563-7312-4c20-a134-8c030bf938a7"),
	// 		Etag: to.Ptr[int32](2),
	// 		Location: to.Ptr("eastus"),
	// 		Properties: &armreservations.Properties{
	// 			AppliedScopeProperties: &armreservations.AppliedScopeProperties{
	// 				DisplayName: to.Ptr("Azure subscription 1"),
	// 				SubscriptionID: to.Ptr("/subscriptions/98df3792-7962-4f18-8be2-d5576f122de3"),
	// 			},
	// 			AppliedScopeType: to.Ptr(armreservations.AppliedScopeTypeSingle),
	// 			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-22T01:00:30.925Z"); 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-22T01:00:30.925Z"); return t}()),
	// 			InstanceFlexibility: to.Ptr(armreservations.InstanceFlexibilityOff),
	// 			LastUpdatedDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-09-22T01:00:36.319Z"); return t}()),
	// 			ProvisioningState: to.Ptr(armreservations.ProvisioningStateSucceeded),
	// 			Quantity: to.Ptr[int32](1),
	// 			Renew: to.Ptr(false),
	// 			ReservedResourceType: to.Ptr(armreservations.ReservedResourceTypeVirtualMachines),
	// 			SKUDescription: to.Ptr("D1 v2"),
	// 			SplitProperties: &armreservations.ReservationSplitProperties{
	// 				SplitSource: to.Ptr("/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/bcae77cd-3119-4766-919f-b50d36c75c7a"),
	// 			},
	// 		},
	// 		SKU: &armreservations.SKUName{
	// 			Name: to.Ptr("Standard_DS1_v2"),
	// 		},
	// 	},
	// 	{
	// 		Name: to.Ptr("e0e4b4f5-77ea-4984-9ee4-6bf9850ee6de"),
	// 		Type: to.Ptr("Microsoft.Capacity/reservationOrders/reservations"),
	// 		ID: to.Ptr("/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/e0e4b4f5-77ea-4984-9ee4-6bf9850ee6de"),
	// 		Etag: to.Ptr[int32](2),
	// 		Location: to.Ptr("eastus"),
	// 		Properties: &armreservations.Properties{
	// 			AppliedScopeProperties: &armreservations.AppliedScopeProperties{
	// 				DisplayName: to.Ptr("Azure subscription 1"),
	// 				SubscriptionID: to.Ptr("/subscriptions/98df3792-7962-4f18-8be2-d5576f122de3"),
	// 			},
	// 			AppliedScopeType: to.Ptr(armreservations.AppliedScopeTypeSingle),
	// 			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-22T01:00:30.925Z"); 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-22T01:00:30.925Z"); return t}()),
	// 			InstanceFlexibility: to.Ptr(armreservations.InstanceFlexibilityOff),
	// 			LastUpdatedDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-09-22T01:00:36.319Z"); return t}()),
	// 			ProvisioningState: to.Ptr(armreservations.ProvisioningStateSucceeded),
	// 			Quantity: to.Ptr[int32](2),
	// 			Renew: to.Ptr(false),
	// 			ReservedResourceType: to.Ptr(armreservations.ReservedResourceTypeVirtualMachines),
	// 			SKUDescription: to.Ptr("D1 v2"),
	// 			SplitProperties: &armreservations.ReservationSplitProperties{
	// 				SplitSource: to.Ptr("/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/bcae77cd-3119-4766-919f-b50d36c75c7a"),
	// 			},
	// 		},
	// 		SKU: &armreservations.SKUName{
	// 			Name: to.Ptr("Standard_DS1_v2"),
	// 		},
	// 	},
	// 	{
	// 		Name: to.Ptr("bcae77cd-3119-4766-919f-b50d36c75c7a"),
	// 		Type: to.Ptr("Microsoft.Capacity/reservationOrders/reservations"),
	// 		ID: to.Ptr("/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/bcae77cd-3119-4766-919f-b50d36c75c7a"),
	// 		Etag: to.Ptr[int32](10),
	// 		Location: to.Ptr("eastus"),
	// 		Properties: &armreservations.Properties{
	// 			AppliedScopeProperties: &armreservations.AppliedScopeProperties{
	// 				DisplayName: to.Ptr("Azure subscription 1"),
	// 				SubscriptionID: to.Ptr("/subscriptions/98df3792-7962-4f18-8be2-d5576f122de3"),
	// 			},
	// 			AppliedScopeType: to.Ptr(armreservations.AppliedScopeTypeSingle),
	// 			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-22T01:00:30.925Z"); 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-22T01:00:30.925Z"); return t}()),
	// 			ExtendedStatusInfo: &armreservations.ExtendedStatusInfo{
	// 				Message: to.Ptr("This reservation was split and is no longer active."),
	// 				StatusCode: to.Ptr(armreservations.ReservationStatusCodeSplit),
	// 			},
	// 			InstanceFlexibility: to.Ptr(armreservations.InstanceFlexibilityOff),
	// 			LastUpdatedDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-09-22T01:00:36.319Z"); return t}()),
	// 			ProvisioningState: to.Ptr(armreservations.ProvisioningStateSucceeded),
	// 			Quantity: to.Ptr[int32](3),
	// 			Renew: to.Ptr(false),
	// 			ReservedResourceType: to.Ptr(armreservations.ReservedResourceTypeVirtualMachines),
	// 			SKUDescription: to.Ptr("D1 v2"),
	// 			SplitProperties: &armreservations.ReservationSplitProperties{
	// 				SplitDestinations: []*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")},
	// 				},
	// 			},
	// 			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

JavaScript

const { AzureReservationAPI } = require("@azure/arm-reservations");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Split a `Reservation` into two `Reservation`s with specified quantity distribution.
 *
 * @summary Split a `Reservation` into two `Reservation`s with specified quantity distribution.
 * x-ms-original-file: specification/reservations/resource-manager/Microsoft.Capacity/stable/2022-11-01/examples/SplitReservation.json
 */
async function split() {
  const reservationOrderId = "276e7ae4-84d0-4da6-ab4b-d6b94f3557da";
  const body = {
    quantities: [1, 2],
    reservationId:
      "/providers/Microsoft.Capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/bcae77cd-3119-4766-919f-b50d36c75c7a",
  };
  const credential = new DefaultAzureCredential();
  const client = new AzureReservationAPI(credential);
  const result = await client.reservation.beginSplitAndWait(reservationOrderId, body);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Reservations;
using Azure.ResourceManager.Reservations.Models;

// Generated from example definition: specification/reservations/resource-manager/Microsoft.Capacity/stable/2022-11-01/examples/SplitReservation.json
// this example is just showing the usage of "Reservation_Split" 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 ReservationOrderResource created on azure
// for more information of creating ReservationOrderResource, please refer to the document of ReservationOrderResource
Guid reservationOrderId = Guid.Parse("276e7ae4-84d0-4da6-ab4b-d6b94f3557da");
ResourceIdentifier reservationOrderResourceId = ReservationOrderResource.CreateResourceIdentifier(reservationOrderId);
ReservationOrderResource reservationOrder = client.GetReservationOrderResource(reservationOrderResourceId);

// invoke the operation
SplitContent content = new SplitContent()
{
    Quantities =
    {
    1,2
    },
    ReservationId = new ResourceIdentifier("/providers/Microsoft.Capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/bcae77cd-3119-4766-919f-b50d36c75c7a"),
};
ArmOperation<IList<ReservationDetailData>> lro = await reservationOrder.SplitReservationAsync(WaitUntil.Completed, content);
IList<ReservationDetailData> result = lro.Value;

Console.WriteLine($"Succeeded: {result}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

[
  {
    "sku": {
      "name": "Standard_DS1_v2"
    },
    "id": "/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/00238563-7312-4c20-a134-8c030bf938a7",
    "type": "Microsoft.Capacity/reservationOrders/reservations",
    "name": "00238563-7312-4c20-a134-8c030bf938a7",
    "etag": 2,
    "location": "eastus",
    "properties": {
      "appliedScopeProperties": {
        "subscriptionId": "/subscriptions/98df3792-7962-4f18-8be2-d5576f122de3",
        "displayName": "Azure subscription 1"
      },
      "renew": false,
      "billingScopeId": "/subscriptions/19376483-64b8-49e4-a931-d5248828720a",
      "appliedScopeType": "Single",
      "quantity": 1,
      "provisioningState": "Succeeded",
      "expiryDate": "2018-09-22",
      "expiryDateTime": "2018-09-22T01:00:30.9253826Z",
      "displayName": "cabri_test",
      "billingPlan": "Monthly",
      "effectiveDateTime": "2017-09-22T01:00:30.9253826Z",
      "lastUpdatedDateTime": "2017-09-22T01:00:36.3191627Z",
      "reservedResourceType": "VirtualMachines",
      "instanceFlexibility": "Off",
      "skuDescription": "D1 v2",
      "splitProperties": {
        "splitSource": "/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/bcae77cd-3119-4766-919f-b50d36c75c7a"
      }
    }
  },
  {
    "sku": {
      "name": "Standard_DS1_v2"
    },
    "id": "/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/e0e4b4f5-77ea-4984-9ee4-6bf9850ee6de",
    "type": "Microsoft.Capacity/reservationOrders/reservations",
    "name": "e0e4b4f5-77ea-4984-9ee4-6bf9850ee6de",
    "etag": 2,
    "location": "eastus",
    "properties": {
      "appliedScopeProperties": {
        "subscriptionId": "/subscriptions/98df3792-7962-4f18-8be2-d5576f122de3",
        "displayName": "Azure subscription 1"
      },
      "renew": false,
      "billingScopeId": "/subscriptions/19376483-64b8-49e4-a931-d5248828720a",
      "appliedScopeType": "Single",
      "quantity": 2,
      "provisioningState": "Succeeded",
      "expiryDate": "2018-09-22",
      "expiryDateTime": "2018-09-22T01:00:30.9253826Z",
      "displayName": "cabri_test",
      "billingPlan": "Monthly",
      "effectiveDateTime": "2017-09-22T01:00:30.9253826Z",
      "lastUpdatedDateTime": "2017-09-22T01:00:36.3191627Z",
      "reservedResourceType": "VirtualMachines",
      "instanceFlexibility": "Off",
      "skuDescription": "D1 v2",
      "splitProperties": {
        "splitSource": "/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/bcae77cd-3119-4766-919f-b50d36c75c7a"
      }
    }
  },
  {
    "sku": {
      "name": "Standard_DS1_v2"
    },
    "id": "/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/bcae77cd-3119-4766-919f-b50d36c75c7a",
    "type": "Microsoft.Capacity/reservationOrders/reservations",
    "name": "bcae77cd-3119-4766-919f-b50d36c75c7a",
    "etag": 10,
    "location": "eastus",
    "properties": {
      "appliedScopeProperties": {
        "subscriptionId": "/subscriptions/98df3792-7962-4f18-8be2-d5576f122de3",
        "displayName": "Azure subscription 1"
      },
      "renew": false,
      "billingScopeId": "/subscriptions/19376483-64b8-49e4-a931-d5248828720a",
      "appliedScopeType": "Single",
      "quantity": 3,
      "provisioningState": "Cancelled",
      "expiryDate": "2018-09-22",
      "expiryDateTime": "2018-09-22T01:00:30.9253826Z",
      "displayName": "cabri_test",
      "billingPlan": "Monthly",
      "effectiveDateTime": "2017-09-22T01:00:30.9253826Z",
      "extendedStatusInfo": {
        "statusCode": "Split",
        "message": "This reservation was split and is no longer active."
      },
      "lastUpdatedDateTime": "2017-09-22T01:00:36.3191627Z",
      "reservedResourceType": "VirtualMachines",
      "instanceFlexibility": "Off",
      "skuDescription": "D1 v2",
      "splitProperties": {
        "splitDestinations": [
          "/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"
        ]
      }
    }
  }
]

Status code:

202

Location: https://management.azure.com/providers/Microsoft.Capacity/reservationorders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/splitoperationresults/bcae77cd-3119-4766-919f-b50d36c75c7a_10?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 sugli errori
ErrorResponseCode	Codice di errore che descrive il motivo per cui il servizio non è in grado di elaborare la richiesta in ingresso
ExtendedErrorInfo	Informazioni estese sull'errore, inclusi il codice di errore e il messaggio di errore
ExtendedStatusInfo
InstanceFlexibility	Se si attiva questa opzione, lo sconto per la prenotazione verrà applicato 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.
PricingCurrencyTotal	Importo usato da Microsoft per il record. Usato durante il rimborso per calcolare il limite di rimborso. L'imposta non è inclusa. Questo prezzo è bloccato 30 giorni prima della scadenza.
ProvisioningState	Rappresenta lo stato corrente della prenotazione.
PurchaseRequest	Richiesta di acquisto della prenotazione
RenewPropertiesResponse	Proprietà di rinnovo per una prenotazione.
ReservationBillingPlan	Rappresentare i piani di fatturazione.
ReservationMergeProperties	Proprietà dell'unione delle 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 per ogni tipo di risorsa riservata. Non obbligatorio se non applicabile.
ReservedResourceType	Tipo della risorsa riservata.
SkuName	Nome dello SKU
SplitRequest	La richiesta di divisione della prenotazione
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.
Utilization	Utilizzo delle prenotazioni

AppliedScopeProperties

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

Tipo dell'ambito applicato.

Nome	Tipo	Descrizione
ManagementGroup	string
Shared	string
Single	string

BillingCurrencyTotal

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 usata da questo record di acquisto.

createdByType

Tipo di identità che ha creato la risorsa.

Nome	Tipo	Descrizione
Application	string
Key	string
ManagedIdentity	string
User	string

Error

Informazioni sugli errori

Nome	Tipo	Descrizione
error	ExtendedErrorInfo	Informazioni estese sull'errore, inclusi il codice di errore e il messaggio di errore

ErrorResponseCode

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

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

ExtendedErrorInfo

Informazioni estese sull'errore, 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

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

InstanceFlexibility

Se si attiva questa opzione, lo sconto per la prenotazione verrà applicato ad altre macchine virtuali nello stesso gruppo di dimensioni della macchina virtuale. Specificare solo per il tipo di risorsa riservata VirtualMachines.

Nome	Tipo	Descrizione
Off	string
On	string

Kind

Tipo di provider di risorse da riservare.

Nome	Tipo	Descrizione
Microsoft.Compute	string

PricingCurrencyTotal

Importo usato da Microsoft per il record. Usato durante il rimborso per calcolare il limite di rimborso. L'imposta non è inclusa. Questo prezzo è bloccato 30 giorni prima della scadenza.

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

ProvisioningState

Rappresenta lo stato corrente della prenotazione.

Nome	Tipo	Descrizione
BillingFailed	string
Cancelled	string
ConfirmedBilling	string
ConfirmedResourceHold	string
Created	string
Creating	string
Expired	string
Failed	string
Merged	string
PendingBilling	string
PendingResourceHold	string
Split	string
Succeeded	string

PurchaseRequest

Richiesta di acquisto della prenotazione

Nome	Tipo	Valore predefinito	Descrizione
location	string		Area di Azure in cui vive 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 che verranno applicate al vantaggio. Non specificare se AppliedScopeType è condiviso. Questa proprietà verrà deprecata e sostituita da appliedScopeProperties invece per Single AppliedScopeType.
properties.billingPlan	ReservationBillingPlan		Rappresentare i piani di fatturazione.
properties.billingScopeId	string		Sottoscrizione che verrà addebitata per l'acquisto di prenotazione o piano di risparmio
properties.displayName	string		Nome descrittivo della prenotazione
properties.quantity	integer		Quantità degli sku che fanno parte della prenotazione.
properties.renew	boolean	False	L'impostazione su true acquista automaticamente una nuova prenotazione all'ora di scadenza.
properties.reservedResourceProperties	ReservedResourceProperties		Proprietà specifiche per ogni tipo di risorsa riservata. Non obbligatorio se non applicabile.
properties.reservedResourceType	ReservedResourceType		Tipo della risorsa riservata.
properties.reviewDateTime	string		Si tratta della data in cui è necessario esaminare il vantaggio ibrido di Azure.
properties.term	ReservationTerm		Rappresenta il termine della prenotazione.
sku	SkuName		Nome dello sku

RenewPropertiesResponse

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	Importo usato da Microsoft per il record. Usato durante il rimborso per calcolare il limite di rimborso. L'imposta non è inclusa. Questo prezzo è bloccato 30 giorni prima della scadenza.
purchaseProperties	PurchaseRequest	Richiesta di acquisto della prenotazione

ReservationBillingPlan

Rappresentare i piani di fatturazione.

Nome	Tipo	Descrizione
Monthly	string
Upfront	string

ReservationMergeProperties

Proprietà dell'unione delle 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

Definizione della prenotazione.

Nome	Tipo	Descrizione
etag	integer
id	string	ID di 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	Azure Resource Manager metadati contenenti le informazioni createdBy e modifiedBy.
type	string	Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

ReservationSplitProperties

Proprietà della divisione della prenotazione

Nome	Tipo	Descrizione
splitDestinations	string[]	Elenco di ID risorsa di destinazione creati a causa della suddivisione. 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

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		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 Completato
effectiveDateTime	string		DateTime della prenotazione a partire da quando questa versione è valida.
expiryDate	string		Questa è la data di scadenza della prenotazione.
expiryDateTime	string		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		DateTime dell'ultima volta in cui la prenotazione è stata aggiornata.
mergeProperties	ReservationMergeProperties		Proprietà dell'unione delle prenotazioni
provisioningState	ProvisioningState		Stato corrente della prenotazione.
provisioningSubState	string		Stato secondario del provisioning della prenotazione, ad esempio Riuscito
purchaseDate	string		Questa è la data in cui è stata acquistata la prenotazione.
purchaseDateTime	string		Questa è la data in cui è stata acquistata la prenotazione.
quantity	integer		Quantità degli SKU che fanno parte della prenotazione.
renew	boolean	False	Se si imposta su true, verrà automaticamente acquistata una nuova prenotazione alla data 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		Si tratta della 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

Nome	Tipo	Descrizione
Active	string
Expired	string
Merged	string
None	string
PaymentInstrumentError	string
Pending	string
Processing	string
PurchaseError	string
Split	string
Succeeded	string

ReservationSwapProperties

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

Rappresenta il termine della prenotazione.

Nome	Tipo	Descrizione
P1Y	string
P3Y	string
P5Y	string

ReservationUtilizationAggregates

Valori aggregati dell'utilizzo della prenotazione

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

ReservedResourceProperties

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

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

ReservedResourceType

Tipo della risorsa riservata.

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

SkuName

Nome dello SKU

Nome	Tipo	Descrizione
name	string

SplitRequest

La richiesta di divisione della prenotazione

Nome	Tipo	Descrizione
properties.quantities	integer[]	Elenco delle quantità nelle nuove prenotazioni da creare.
properties.reservationId	string	ID risorsa della prenotazione da dividere. Il formato dell'ID risorsa deve essere /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}

systemData

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

Nome	Tipo	Descrizione
createdAt	string	Timestamp della creazione di risorse (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string	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

Utilizzo delle prenotazioni

Nome	Tipo	Descrizione
aggregates	ReservationUtilizationAggregates[]	Matrice di aggregazioni dell'utilizzo di una prenotazione
trend	string	ultimo 7 giorno di tendenza di utilizzo per una prenotazione