Reservation - Split

Service:

Reserved VM Instances

API Version:

2022-11-01

Divida o Reservation.
Divida a Reservation em dois Reservations com distribuição de quantidade especificada.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
reservationOrderId	path	True	string	ID da encomenda da reserva
api-version	query	True	string	Versão suportada.

Corpo do Pedido

Name	Tipo	Description
properties.quantities	integer[]	Lista das quantidades nas novas reservas a criar.
properties.reservationId	string	ID do recurso da reserva a dividir. O formato do ID do recurso deve ser /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}

Respostas

Name	Tipo	Description
200 OK	ReservationResponse[]	Lista de Reservations criados após a operação de divisão.
202 Accepted		O pedido é aceite e está a ser processado Headers Location: string Retry-After: integer
Other Status Codes	Error	Erro inesperado

Exemplos

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

Definições

Name	Description
AppliedScopeProperties	Propriedades específicas do tipo de âmbito aplicado. Não é necessário se não for aplicável. Necessário e necessário para fornecer tenantId e managementGroupId se AppliedScopeType for ManagementGroup
AppliedScopeType	Tipo do Âmbito Aplicado.
BillingCurrencyTotal	Moeda e montante a que o cliente será cobrado na moeda local do cliente para compra de renovação. O imposto não está incluído.
createdByType	O tipo de identidade que criou o recurso.
Error	Informações de erro
ErrorResponseCode	Código de erro que descreve o motivo pelo qual o serviço não consegue processar o pedido recebido
ExtendedErrorInfo	Informações de erro expandidas, incluindo código de erro e mensagem de erro
ExtendedStatusInfo
InstanceFlexibility	Ativar esta opção aplicará o desconto de reserva a outras VMs no mesmo grupo de tamanho de VM. Especifique apenas para o tipo de recurso reservado VirtualMachines.
Kind	Tipo de Fornecedor de Recursos a ser reservado.
PricingCurrencyTotal	Montante que a Microsoft utiliza para registo. Utilizado durante o reembolso para calcular o limite de reembolso. O imposto não está incluído. Este preço está bloqueado 30 dias antes de expirar.
ProvisioningState	Representar o estado atual da Reserva.
PurchaseRequest	O pedido de compra de reserva
RenewPropertiesResponse	As propriedades de renovação de uma reserva.
ReservationBillingPlan	Representar os planos de faturação.
ReservationMergeProperties	Propriedades da intercalação de reservas
ReservationResponse	A definição da reserva.
ReservationSplitProperties	Propriedades da divisão da reserva
ReservationsProperties	As propriedades das reservas
ReservationStatusCode
ReservationSwapProperties	Propriedades da troca de reserva
ReservationTerm	Representar o termo da reserva.
ReservationUtilizationAggregates	Os valores agregados da utilização da reserva
ReservedResourceProperties	Propriedades específicas de cada tipo de recurso reservado. Não é necessário se não for aplicável.
ReservedResourceType	O tipo de recurso que está a ser reservado.
SkuName	O nome do SKU
SplitRequest	O pedido de divisão da reserva
systemData	Metadados relativos à criação e última modificação do recurso.
Utilization	Utilização da reserva

AppliedScopeProperties

Propriedades específicas do tipo de âmbito aplicado. Não é necessário se não for aplicável. Necessário e necessário para fornecer tenantId e managementGroupId se AppliedScopeType for ManagementGroup

Name	Tipo	Description
displayName	string	Nome a apresentar
managementGroupId	string	Identificador completamente qualificado do grupo de gestão onde o benefício tem de ser aplicado.
resourceGroupId	string	Identificador completamente qualificado do grupo de recursos.
subscriptionId	string	Identificador completamente qualificado da subscrição.
tenantId	string	ID do inquilino onde o plano de poupança deve aplicar benefícios.

AppliedScopeType

Tipo do Âmbito Aplicado.

Name	Tipo	Description
ManagementGroup	string
Shared	string
Single	string

BillingCurrencyTotal

Moeda e montante a que o cliente será cobrado na moeda local do cliente para compra de renovação. O imposto não está incluído.

Name	Tipo	Description
amount	number
currencyCode	string	O código de moeda iso 4217 de 3 letras para a moeda utilizada por este registo de compra.

createdByType

O tipo de identidade que criou o recurso.

Name	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

Error

Informações de erro

Name	Tipo	Description
error	ExtendedErrorInfo	Informações de erro expandidas, incluindo código de erro e mensagem de erro

ErrorResponseCode

Código de erro que descreve o motivo pelo qual o serviço não consegue processar o pedido recebido

Name	Tipo	Description
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

Informações de erro expandidas, incluindo código de erro e mensagem de erro

Name	Tipo	Description
code	ErrorResponseCode	Código de erro que descreve o motivo pelo qual o serviço não consegue processar o pedido recebido
message	string

ExtendedStatusInfo

Name	Tipo	Description
message	string	A mensagem que fornece informações detalhadas sobre o código de estado.
statusCode	ReservationStatusCode

InstanceFlexibility

Ativar esta opção aplicará o desconto de reserva a outras VMs no mesmo grupo de tamanho de VM. Especifique apenas para o tipo de recurso reservado VirtualMachines.

Name	Tipo	Description
Off	string
On	string

Kind

Tipo de Fornecedor de Recursos a ser reservado.

Name	Tipo	Description
Microsoft.Compute	string

PricingCurrencyTotal

Montante que a Microsoft utiliza para registo. Utilizado durante o reembolso para calcular o limite de reembolso. O imposto não está incluído. Este preço está bloqueado 30 dias antes de expirar.

Name	Tipo	Description
amount	number
currencyCode	string	O código de moeda iso 4217 de 3 letras para a moeda utilizada por este registo de compra.

ProvisioningState

Representar o estado atual da Reserva.

Name	Tipo	Description
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

O pedido de compra de reserva

Name	Tipo	Valor Predefinido	Description
location	string		A região do Azure onde reside o recurso reservado.
properties.appliedScopeProperties	AppliedScopeProperties		Propriedades específicas do tipo de âmbito aplicado. Não é necessário se não for aplicável. Necessário e necessário para fornecer tenantId e managementGroupId se AppliedScopeType for ManagementGroup
properties.appliedScopeType	AppliedScopeType		Tipo do Âmbito Aplicado.
properties.appliedScopes	string[]		Lista das subscrições às quais o benefício será aplicado. Não especifique se AppliedScopeType é Partilhado. Esta propriedade será preterida e substituída por appliedScopeProperties em vez de Single AppliedScopeType.
properties.billingPlan	ReservationBillingPlan		Representar os planos de faturação.
properties.billingScopeId	string		Subscrição que será cobrada pela compra de reserva ou plano de poupança
properties.displayName	string		Nome amigável da reserva
properties.quantity	integer		Quantidade de skUs que fazem parte da reserva.
properties.renew	boolean	False	Definir isto como verdadeiro comprará automaticamente uma nova reserva na data de expiração.
properties.reservedResourceProperties	ReservedResourceProperties		Propriedades específicas de cada tipo de recurso reservado. Não é necessário se não for aplicável.
properties.reservedResourceType	ReservedResourceType		O tipo de recurso que está a ser reservado.
properties.reviewDateTime	string		Esta é a data-hora em que o benefício híbrido do Azure precisa de ser revisto.
properties.term	ReservationTerm		Representar o termo da reserva.
sku	SkuName		O nome do SKU

RenewPropertiesResponse

As propriedades de renovação de uma reserva.

Name	Tipo	Description
billingCurrencyTotal	BillingCurrencyTotal	Moeda e montante a que o cliente será cobrado na moeda local do cliente para compra de renovação. O imposto não está incluído.
pricingCurrencyTotal	PricingCurrencyTotal	Montante que a Microsoft utiliza para registo. Utilizado durante o reembolso para calcular o limite de reembolso. O imposto não está incluído. Este preço está bloqueado 30 dias antes de expirar.
purchaseProperties	PurchaseRequest	O pedido de compra de reserva

ReservationBillingPlan

Representar os planos de faturação.

Name	Tipo	Description
Monthly	string
Upfront	string

ReservationMergeProperties

Propriedades da intercalação de reservas

Name	Tipo	Description
mergeDestination	string	ID do recurso de reserva Criado devido à intercalação. O formato do ID do recurso é /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}
mergeSources	string[]	IDs de recursos da reserva de origem intercalados para formar esta reserva. O formato do ID do recurso é /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}

ReservationResponse

A definição da reserva.

Name	Tipo	Description
etag	integer
id	string	ID de recurso completamente qualificado para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind	Kind	Tipo de Fornecedor de Recursos a ser reservado.
location	string	A região do Azure onde reside o recurso reservado.
name	string	O nome do recurso
properties	ReservationsProperties	As propriedades associadas a esta reserva
sku	SkuName	As informações do SKU associadas a esta reserva
systemData	systemData	O Azure Resource Manager metadados que contêm createdBy e modifiedBy information.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

ReservationSplitProperties

Propriedades da divisão da reserva

Name	Tipo	Description
splitDestinations	string[]	Lista do ID de recurso de destino que são criados devido à divisão. O formato do ID do recurso é /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}
splitSource	string	ID do recurso da reserva a partir da qual esta está dividida. O formato do ID do recurso é /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}

ReservationsProperties

As propriedades das reservas

Name	Tipo	Valor Predefinido	Description
appliedScopeProperties	AppliedScopeProperties		Propriedades específicas do tipo de âmbito aplicado. Não é necessário se não for aplicável. Necessário e necessário para fornecer tenantId e managementGroupId se AppliedScopeType for ManagementGroup
appliedScopeType	AppliedScopeType		O tipo de âmbito aplicado
appliedScopes	string[]		A lista de âmbitos aplicados
archived	boolean		Indica se a reserva está arquivada
benefitStartTime	string		Este é o DateTime quando o benefício da reserva começou.
billingPlan	ReservationBillingPlan		As opções do plano de faturação disponíveis para este SKU.
billingScopeId	string		Subscrição que será cobrada pela compra de reserva ou plano de poupança
capabilities	string		Capacidades da reserva
displayName	string		Nome amigável para o utilizador identificar facilmente a reserva
displayProvisioningState	string		O estado de aprovisionamento da reserva para apresentação, por exemplo, Com êxito
effectiveDateTime	string		DateTime da reserva a partir da qual esta versão é eficaz.
expiryDate	string		Esta é a data em que a reserva irá expirar.
expiryDateTime	string		Esta é a data-hora em que a reserva irá expirar.
extendedStatusInfo	ExtendedStatusInfo		A mensagem que fornece informações detalhadas sobre o código de estado.
instanceFlexibility	InstanceFlexibility		Permite que o desconto de reserva seja aplicado entre skUs dentro do mesmo grupo de ajuste automático. Nem todos os skUs suportam a flexibilidade de tamanho de instância.
lastUpdatedDateTime	string		DateTime da última vez que a reserva foi atualizada.
mergeProperties	ReservationMergeProperties		Propriedades da intercalação de reservas
provisioningState	ProvisioningState		Estado atual da reserva.
provisioningSubState	string		O subestado de aprovisionamento da reserva, por exemplo, Com êxito
purchaseDate	string		Esta é a data em que a reserva foi comprada.
purchaseDateTime	string		Esta é a data-hora em que a reserva foi comprada.
quantity	integer		Quantidade de skUs que fazem parte da reserva.
renew	boolean	False	Definir isto como verdadeiro comprará automaticamente uma nova reserva na data de expiração.
renewDestination	string		ID de reserva da reserva comprada por causa da renovação. O formato do ID do recurso é /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}.
renewProperties	RenewPropertiesResponse		As propriedades de renovação de uma reserva.
renewSource	string		ID de reserva da reserva a partir da qual esta reserva é renovada. O formato do ID do recurso é /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}.
reservedResourceType	ReservedResourceType		O tipo de recurso que está a ser reservado.
reviewDateTime	string		Esta é a data-hora em que o Benefício Híbrido do Azure tem de ser revisto.
skuDescription	string		Descrição do SKU em inglês.
splitProperties	ReservationSplitProperties		Propriedades da divisão da reserva
swapProperties	ReservationSwapProperties		Propriedades da troca de reserva
term	ReservationTerm		Representar o termo da reserva.
userFriendlyAppliedScopeType	string		O tipo de âmbito aplicado da reserva para apresentação, por exemplo, Partilhado
userFriendlyRenewState	string		O estado de renovação da reserva para apresentação, por exemplo, Ativado
utilization	Utilization		Utilização da reserva

ReservationStatusCode

Name	Tipo	Description
Active	string
Expired	string
Merged	string
None	string
PaymentInstrumentError	string
Pending	string
Processing	string
PurchaseError	string
Split	string
Succeeded	string

ReservationSwapProperties

Propriedades da troca de reserva

Name	Tipo	Description
swapDestination	string	ID do recurso de reserva para o qual o recurso original é trocado. O formato do ID do recurso é /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}
swapSource	string	ID do recurso da reserva de origem que é trocada. O formato do ID do recurso é /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}

ReservationTerm

Representar o termo da reserva.

Name	Tipo	Description
P1Y	string
P3Y	string
P5Y	string

ReservationUtilizationAggregates

Os valores agregados da utilização da reserva

Name	Tipo	Description
grain	number	O grão da agregação
grainUnit	string	A unidade de agregação
value	number	O valor agregado
valueUnit	string	A unidade de valor agregado

ReservedResourceProperties

Propriedades específicas de cada tipo de recurso reservado. Não é necessário se não for aplicável.

Name	Tipo	Description
instanceFlexibility	InstanceFlexibility	Ativar esta opção aplicará o desconto de reserva a outras VMs no mesmo grupo de tamanho de VM. Especifique apenas para o tipo de recurso reservado VirtualMachines.

ReservedResourceType

O tipo de recurso que está a ser reservado.

Name	Tipo	Description
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

O nome do SKU

Name	Tipo	Description
name	string

SplitRequest

O pedido de divisão da reserva

Name	Tipo	Description
properties.quantities	integer[]	Lista das quantidades nas novas reservas a criar.
properties.reservationId	string	ID do recurso da reserva a dividir. O formato do ID do recurso deve ser /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}

systemData

Metadados relativos à criação e última modificação do recurso.

Name	Tipo	Description
createdAt	string	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

Utilization

Utilização da reserva

Name	Tipo	Description
aggregates	ReservationUtilizationAggregates[]	A matriz de agregações da utilização de uma reserva
trend	string	Última tendência de utilização de 7 dias para uma reserva