Reservation - Split

Serviço:

Reserved VM Instances

Versão da API:

2022-11-01

Divida o Reservation.
Divida um 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[] (int32)	Lista das quantidades nas novas reservas a criar.
properties.reservationId	string	ID do recurso da reserva a ser dividida. O formato da 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 Cabeçalhos Location: string Retry-After: integer
Other Status Codes	Error	Erro inesperado

Exemplos

Split

Pedido de amostra

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

Resposta da amostra

Código de estado:

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"
        ]
      }
    }
  }
]

Código de estado:

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 escopo aplicado. Não obrigatório se não for aplicável. Necessário e necessário para fornecer tenantId e managementGroupId se AppliedScopeType for ManagementGroup
AppliedScopeType	Tipo do Escopo Aplicado.
BillingCurrencyTotal	Moeda e valor que o cliente será cobrado na moeda local do cliente para a compra de renovação. IVA não 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 é capaz de processar a solicitação de entrada
ExtendedErrorInfo	Informações de erro estendidas, incluindo código de erro e mensagem de erro
ExtendedStatusInfo
InstanceFlexibility	Ativar isso 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 provedor de recursos a ser reservado.
PricingCurrencyTotal	Valor que a Microsoft usa para registro. Usado durante o reembolso para calcular o limite de reembolso. IVA não incluído. Este é o preço bloqueado 30 dias antes do vencimento.
ProvisioningState	Representar o estado atual da Reserva.
PurchaseRequest	O pedido de compra de reserva
RenewPropertiesResponse	A renovação de propriedades para uma reserva.
ReservationBillingPlan	Representar os planos de faturação.
ReservationMergeProperties	Propriedades de fusão de reservas
ReservationResponse	A definição da reserva.
ReservationSplitProperties	Propriedades de reserva dividida
ReservationsProperties	As propriedades das reservas
ReservationStatusCode
ReservationSwapProperties	Propriedades de troca de reserva
ReservationTerm	Representar o termo de reserva.
ReservationUtilizationAggregates	Os valores agregados de utilização de reservas
ReservedResourceProperties	Propriedades específicas para cada tipo de recurso reservado. Não obrigatório se não for aplicável.
ReservedResourceType	O tipo de recurso que está sendo reservado.
SkuName	O nome do sku
SplitRequest	O pedido de reserva divide-se
systemData	Metadados referentes à criação e última modificação do recurso.
Utilization	Utilização de reservas

AppliedScopeProperties

Object

Propriedades específicas do tipo de escopo aplicado. Não obrigató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 de exibição
managementGroupId	string	Identificador totalmente qualificado do grupo de gestão em que o benefício deve ser aplicado.
resourceGroupId	string	Identificador totalmente qualificado do grupo de recursos.
subscriptionId	string	Identificador totalmente qualificado da assinatura.
tenantId	string	ID do inquilino onde o plano de poupança deve aplicar o benefício.

AppliedScopeType

Enumeração

Tipo do Escopo Aplicado.

Valor	Description
ManagementGroup
Shared
Single

BillingCurrencyTotal

Object

Moeda e valor que o cliente será cobrado na moeda local do cliente para a compra de renovação. IVA não incluído.

Name	Tipo	Description
amount	number
currencyCode	string	O código de moeda ISO 4217 de 3 letras para a moeda usada por este registro de compra.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
Application
Key
ManagedIdentity
User

Error

Object

Informações de erro

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

ErrorResponseCode

Enumeração

Código de erro que descreve o motivo pelo qual o serviço não é capaz de processar a solicitação de entrada

Valor	Description
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

Informações de erro estendidas, 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 é capaz de processar a solicitação de entrada
message	string

ExtendedStatusInfo

Object

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

InstanceFlexibility

Enumeração

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

Valor	Description
Off
On

Kind

Enumeração

Tipo de provedor de recursos a ser reservado.

Valor	Description
Microsoft.Compute

PricingCurrencyTotal

Object

Valor que a Microsoft usa para registro. Usado durante o reembolso para calcular o limite de reembolso. IVA não incluído. Este é o preço bloqueado 30 dias antes do vencimento.

Name	Tipo	Description
amount	number
currencyCode	string	O código de moeda ISO 4217 de 3 letras para a moeda usada por este registro de compra.

ProvisioningState

Enumeração

Representar o estado atual da Reserva.

Valor	Description
BillingFailed
Cancelled
ConfirmedBilling
ConfirmedResourceHold
Created
Creating
Expired
Failed
Merged
PendingBilling
PendingResourceHold
Split
Succeeded

PurchaseRequest

Object

O pedido de compra de reserva

Name	Tipo	Default value	Description
location	string		A região do Azure onde reside o recurso reservado.
properties.appliedScopeProperties	AppliedScopeProperties		Propriedades específicas do tipo de escopo aplicado. Não obrigató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 Escopo Aplicado.
properties.appliedScopes	string[]		Lista das subscrições em que o benefício será aplicado. Não especifique se AppliedScopeType é compartilhado. Essa 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 (int32)		Quantidade dos skus que fazem parte da reserva.
properties.renew	boolean	False	Definir isso como true comprará automaticamente uma nova reserva no horário da data de validade.
properties.reservedResourceProperties	ReservedResourceProperties		Propriedades específicas para cada tipo de recurso reservado. Não obrigatório se não for aplicável.
properties.reservedResourceType	ReservedResourceType		O tipo de recurso que está sendo reservado.
properties.reviewDateTime	string (date-time)		Esta é a data e hora em que o benefício híbrido do Azure precisa ser revisado.
properties.term	ReservationTerm		Representar o termo de reserva.
sku	SkuName		O nome do sku

RenewPropertiesResponse

Object

A renovação de propriedades para uma reserva.

Name	Tipo	Description
billingCurrencyTotal	BillingCurrencyTotal	Moeda e valor que o cliente será cobrado na moeda local do cliente para a compra de renovação. IVA não incluído.
pricingCurrencyTotal	PricingCurrencyTotal	Valor que a Microsoft usa para registro. Usado durante o reembolso para calcular o limite de reembolso. IVA não incluído. Este é o preço bloqueado 30 dias antes do vencimento.
purchaseProperties	PurchaseRequest	O pedido de compra de reserva

ReservationBillingPlan

Enumeração

Representar os planos de faturação.

Valor	Description
Monthly
Upfront

ReservationMergeProperties

Object

Propriedades de fusão de reservas

Name	Tipo	Description
mergeDestination	string	ID do recurso de reserva Criado devido à mesclagem. O formato da id do recurso é /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}
mergeSources	string[]	IDs de recursos da reserva de origem mesclados para formar essa reserva. O formato da id do recurso é /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}

ReservationResponse

Object

A definição da reserva.

Name	Tipo	Description
etag	integer (int32)
id	string (arm-id)	ID de recurso totalmente qualificado para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind	Kind	Tipo de provedor 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	Os imóveis associados a esta reserva
sku	SkuName	As informações de sku associadas a esta reserva
systemData	systemData	Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

ReservationSplitProperties

Object

Propriedades de reserva dividida

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

ReservationsProperties

Object

As propriedades das reservas

Name	Tipo	Default value	Description
appliedScopeProperties	AppliedScopeProperties		Propriedades específicas do tipo de escopo aplicado. Não obrigató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 escopo aplicado
appliedScopes	string[]		A lista de escopos aplicados
archived	boolean		Indica se a reserva está arquivada
benefitStartTime	string (date-time)		Este é o DateTime quando o benefício de reserva começou.
billingPlan	ReservationBillingPlan		As opções de plano de faturamento 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 usuário identificar facilmente a reserva
displayProvisioningState	string		O estado de provisionamento da reserva para exibição, por exemplo, bem-sucedido
effectiveDateTime	string (date-time)		DataHora da reserva a partir do momento em que esta versão entra em vigor.
expiryDate	string (date)		Esta é a data em que a reserva expirará.
expiryDateTime	string (date-time)		Esta é a data-hora em que a reserva expirará.
extendedStatusInfo	ExtendedStatusInfo		A mensagem com informações detalhadas sobre o código de status.
instanceFlexibility	InstanceFlexibility		Permite que o desconto de reserva seja aplicado em todos os skus dentro do mesmo grupo de ajuste automático. Nem todos os skus suportam flexibilidade de tamanho de instância.
lastUpdatedDateTime	string (date-time)		DataHora da última vez que a reserva foi atualizada.
mergeProperties	ReservationMergeProperties		Propriedades de fusão de reservas
provisioningState	ProvisioningState		Estado atual da reserva.
provisioningSubState	string		O subestado de provisionamento da reserva, por exemplo, Sucedido
purchaseDate	string (date)		Esta é a data em que a reserva foi comprada.
purchaseDateTime	string (date-time)		Esta é a data-hora em que a reserva foi comprada.
quantity	integer (int32)		Quantidade dos skus que fazem parte da reserva.
renew	boolean	False	Definir isso como true comprará automaticamente uma nova reserva no horário da data de validade.
renewDestination	string		ID de reserva da reserva que é comprada por causa da renovação. O formato do ID do recurso é /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}.
renewProperties	RenewPropertiesResponse		A renovação de propriedades para uma reserva.
renewSource	string		ID 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á sendo reservado.
reviewDateTime	string (date-time)		Esta é a data e hora em que o Benefício Híbrido do Azure precisa ser revisado.
skuDescription	string		Descrição do sku em inglês.
splitProperties	ReservationSplitProperties		Propriedades de reserva dividida
swapProperties	ReservationSwapProperties		Propriedades de troca de reserva
term	ReservationTerm		Representar o termo de reserva.
userFriendlyAppliedScopeType	string		O tipo de escopo aplicado da reserva para exibição, por exemplo, Compartilhado
userFriendlyRenewState	string		O estado de renovação da reserva para exibição, por exemplo, On
utilization	Utilization		Utilização de reservas

ReservationStatusCode

Enumeração

Valor	Description
Active
Expired
Merged
None
PaymentInstrumentError
Pending
Processing
PurchaseError
Split
Succeeded

ReservationSwapProperties

Object

Propriedades de troca de reserva

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

ReservationTerm

Enumeração

Representar o termo de reserva.

Valor	Description
P1Y
P3Y
P5Y

ReservationUtilizationAggregates

Object

Os valores agregados de utilização de reservas

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

ReservedResourceProperties

Object

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

Name	Tipo	Description
instanceFlexibility	InstanceFlexibility	Ativar isso 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

Enumeração

O tipo de recurso que está sendo reservado.

Valor	Description
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

O nome do sku

Name	Tipo	Description
name	string

SplitRequest

Object

O pedido de reserva divide-se

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

systemData

Object

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

Name	Tipo	Description
createdAt	string (date-time)	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 (date-time)	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

Object

Utilização de reservas

Name	Tipo	Description
aggregates	ReservationUtilizationAggregates[]	A matriz de agregados da utilização de uma reserva
trend	string	Tendência de utilização dos últimos 7 dias para uma reserva