Reservation - Split

Tjänst:

Reserved VM Instances

API-version:

2022-11-01

Dela upp Reservation.
Dela upp en Reservation i två Reservationmed angiven kvantitetsfördelning.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
reservationOrderId	path	True	string	Beställnings-ID för reservationen
api-version	query	True	string	Version som stöds.

Begärandetext

Name	Typ	Description
properties.quantities	integer[] (int32)	Lista över kvantiteterna i de nya reservationer som ska skapas.
properties.reservationId	string	Resurs-ID för reservationen som ska delas. Formatet för resurs-ID:t ska vara /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}

Svar

Name	Typ	Description
200 OK	ReservationResponse[]	Lista över Reservationsom har skapats efter delningsåtgärden.
202 Accepted		Begäran godkänns och bearbetas Sidhuvuden Location: string Retry-After: integer
Other Status Codes	Error	Oväntat fel

Exempel

Split

Exempelbegäran

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 Azure;
using Azure.ResourceManager;
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Reservations.Models;
using Azure.ResourceManager.Reservations;

// Generated from example definition: specification/reservations/resource-manager/Microsoft.Capacity/stable/2022-11-01/examples/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

Exempelsvar

Statuskod:

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

Statuskod:

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

Definitioner

Name	Description
AppliedScopeProperties	Egenskaper som är specifika för tillämpad omfångstyp. Krävs inte om det inte är tillämpligt. Krävs och måste ange tenantId och managementGroupId om AppliedScopeType är ManagementGroup
AppliedScopeType	Typ av tillämpat omfång.
BillingCurrencyTotal	Valuta och belopp som kunden debiteras i kundens lokala valuta för förnyelseköp. Skatt ingår inte.
createdByType	Den typ av identitet som skapade resursen.
Error	Felinformation
ErrorResponseCode	Felkod som beskriver orsaken till att tjänsten inte kan bearbeta den inkommande begäran
ExtendedErrorInfo	Utökad felinformation, inklusive felkod och felmeddelande
ExtendedStatusInfo
InstanceFlexibility	Om du aktiverar detta tillämpas reservationsrabatten på andra virtuella datorer i samma vm-storleksgrupp. Ange endast reserverad resurstyp för VirtualMachines.
Kind	Resursprovidertyp som ska reserveras.
PricingCurrencyTotal	Belopp som Microsoft använder för post. Används under återbetalningen för att beräkna återbetalningsgränsen. Skatt ingår inte. Detta är låst pris 30 dagar före förfallodatum.
ProvisioningState	Representerar det aktuella tillståndet för reservationen.
PurchaseRequest	Begäran om reservationsköp
RenewPropertiesResponse	Förnyelseegenskaperna för en reservation.
ReservationBillingPlan	Representera faktureringsplanerna.
ReservationMergeProperties	Egenskaper för reservationssammanslagning
ReservationResponse	Definitionen av reservationen.
ReservationSplitProperties	Egenskaper för reservationsdelning
ReservationsProperties	Egenskaperna för reservationerna
ReservationStatusCode
ReservationSwapProperties	Egenskaper för reservationsbyte
ReservationTerm	Representera reservationsperioden.
ReservationUtilizationAggregates	Aggregerade värden för reservationsanvändning
ReservedResourceProperties	Egenskaper som är specifika för varje reserverad resurstyp. Krävs inte om det inte är tillämpligt.
ReservedResourceType	Typen av resurs som reserveras.
SkuName	Namnet på sku
SplitRequest	Begäran om reservationsdelning
systemData	Metadata som rör skapande och senaste ändring av resursen.
Utilization	Reservationsanvändning

AppliedScopeProperties

Objekt

Egenskaper som är specifika för tillämpad omfångstyp. Krävs inte om det inte är tillämpligt. Krävs och måste ange tenantId och managementGroupId om AppliedScopeType är ManagementGroup

Name	Typ	Description
displayName	string	Visningsnamn
managementGroupId	string	Fullständigt kvalificerad identifierare för den hanteringsgrupp där förmånen måste tillämpas.
resourceGroupId	string	Fullständigt kvalificerad identifierare för resursgruppen.
subscriptionId	string	Fullständigt kvalificerad identifierare för prenumerationen.
tenantId	string	Klientorganisations-ID där sparplanen ska tillämpa förmånen.

AppliedScopeType

Uppräkning

Typ av tillämpat omfång.

Värde	Description
ManagementGroup
Shared
Single

BillingCurrencyTotal

Objekt

Valuta och belopp som kunden debiteras i kundens lokala valuta för förnyelseköp. Skatt ingår inte.

Name	Typ	Description
amount	number
currencyCode	string	ISO 4217 3-bokstavs valutakod för den valuta som används av den här inköpsposten.

createdByType

Uppräkning

Den typ av identitet som skapade resursen.

Värde	Description
Application
Key
ManagedIdentity
User

Error

Objekt

Felinformation

Name	Typ	Description
error	ExtendedErrorInfo	Utökad felinformation, inklusive felkod och felmeddelande

ErrorResponseCode

Uppräkning

Felkod som beskriver orsaken till att tjänsten inte kan bearbeta den inkommande begäran

Värde	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

Objekt

Utökad felinformation, inklusive felkod och felmeddelande

Name	Typ	Description
code	ErrorResponseCode	Felkod som beskriver orsaken till att tjänsten inte kan bearbeta den inkommande begäran
message	string

ExtendedStatusInfo

Objekt

Name	Typ	Description
message	string	Meddelandet med detaljerad information om statuskoden.
statusCode	ReservationStatusCode

InstanceFlexibility

Uppräkning

Om du aktiverar detta tillämpas reservationsrabatten på andra virtuella datorer i samma vm-storleksgrupp. Ange endast reserverad resurstyp för VirtualMachines.

Värde	Description
Off
On

Kind

Uppräkning

Resursprovidertyp som ska reserveras.

Värde	Description
Microsoft.Compute

PricingCurrencyTotal

Objekt

Belopp som Microsoft använder för post. Används under återbetalningen för att beräkna återbetalningsgränsen. Skatt ingår inte. Detta är låst pris 30 dagar före förfallodatum.

Name	Typ	Description
amount	number
currencyCode	string	ISO 4217 3-bokstavs valutakod för den valuta som används av den här inköpsposten.

ProvisioningState

Uppräkning

Representerar det aktuella tillståndet för reservationen.

Värde	Description
BillingFailed
Cancelled
ConfirmedBilling
ConfirmedResourceHold
Created
Creating
Expired
Failed
Merged
PendingBilling
PendingResourceHold
Split
Succeeded

PurchaseRequest

Objekt

Begäran om reservationsköp

Name	Typ	Standardvärde	Description
location	string		Den Azure-region där den reserverade resursen finns.
properties.appliedScopeProperties	AppliedScopeProperties		Egenskaper som är specifika för tillämpad omfångstyp. Krävs inte om det inte är tillämpligt. Krävs och måste ange tenantId och managementGroupId om AppliedScopeType är ManagementGroup
properties.appliedScopeType	AppliedScopeType		Typ av tillämpat omfång.
properties.appliedScopes	string[]		Lista över de prenumerationer som förmånen ska tillämpas på. Ange inte om AppliedScopeType är Delat. Den här egenskapen kommer att bli inaktuell och ersättas av appliedScopeProperties i stället för Single AppliedScopeType.
properties.billingPlan	ReservationBillingPlan		Representera faktureringsplanerna.
properties.billingScopeId	string		Prenumeration som debiteras för köp av reservation eller sparplan
properties.displayName	string		Eget namn på reservationen
properties.quantity	integer (int32)		Antal sku:er som ingår i reservationen.
properties.renew	boolean	False	Om du anger värdet true köps automatiskt en ny reservation på förfallodatumtiden.
properties.reservedResourceProperties	ReservedResourceProperties		Egenskaper som är specifika för varje reserverad resurstyp. Krävs inte om det inte är tillämpligt.
properties.reservedResourceType	ReservedResourceType		Typen av resurs som reserveras.
properties.reviewDateTime	string (date-time)		Det här är den tidpunkt då Azure-hybridförmånen måste granskas.
properties.term	ReservationTerm		Representera reservationsperioden.
sku	SkuName		Namnet på sku

RenewPropertiesResponse

Objekt

Förnyelseegenskaperna för en reservation.

Name	Typ	Description
billingCurrencyTotal	BillingCurrencyTotal	Valuta och belopp som kunden debiteras i kundens lokala valuta för förnyelseköp. Skatt ingår inte.
pricingCurrencyTotal	PricingCurrencyTotal	Belopp som Microsoft använder för post. Används under återbetalningen för att beräkna återbetalningsgränsen. Skatt ingår inte. Detta är låst pris 30 dagar före förfallodatum.
purchaseProperties	PurchaseRequest	Begäran om reservationsköp

ReservationBillingPlan

Uppräkning

Representera faktureringsplanerna.

Värde	Description
Monthly
Upfront

ReservationMergeProperties

Objekt

Egenskaper för reservationssammanslagning

Name	Typ	Description
mergeDestination	string	Reservationsresurs-ID skapat på grund av sammanfogningen. Formatet för resurs-ID:t är /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}
mergeSources	string[]	Resurs-ID:t för källreservationen sammanfogas för att bilda den här reservationen. Formatet för resurs-ID:t är /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}

ReservationResponse

Objekt

Definitionen av reservationen.

Name	Typ	Description
etag	integer (int32)
id	string (arm-id)	Fullständigt kvalificerat resurs-ID för resursen. Till exempel "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind	Kind	Resursprovidertyp som ska reserveras.
location	string	Den Azure-region där den reserverade resursen finns.
name	string	Namnet på resursen
properties	ReservationsProperties	De egenskaper som är associerade med den här reservationen
sku	SkuName	SKU-informationen som är kopplad till den här reservationen
systemData	systemData	Azure Resource Manager-metadata som innehåller createdBy och modifiedBy information.
type	string	Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

ReservationSplitProperties

Objekt

Egenskaper för reservationsdelning

Name	Typ	Description
splitDestinations	string[]	Lista över målresurs-ID som skapas på grund av delning. Formatet för resurs-ID:t är /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}
splitSource	string	Resurs-ID för reservationen som detta delas från. Formatet för resurs-ID:t är /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}

ReservationsProperties

Objekt

Egenskaperna för reservationerna

Name	Typ	Standardvärde	Description
appliedScopeProperties	AppliedScopeProperties		Egenskaper som är specifika för tillämpad omfångstyp. Krävs inte om det inte är tillämpligt. Krävs och måste ange tenantId och managementGroupId om AppliedScopeType är ManagementGroup
appliedScopeType	AppliedScopeType		Den tillämpade omfångstypen
appliedScopes	string[]		Listan över tillämpade omfång
archived	boolean		Anger om reservationen är arkiverad
benefitStartTime	string (date-time)		Det här är DateTime när reservationsförmånen startade.
billingPlan	ReservationBillingPlan		De alternativ för faktureringsplan som är tillgängliga för den här sku:n.
billingScopeId	string		Prenumeration som debiteras för köp av reservation eller sparplan
capabilities	string		Reservationens funktioner
displayName	string		Eget namn för användare för att enkelt identifiera reservationen
displayProvisioningState	string		Etableringstillståndet för reservationen för visning, t.ex. Lyckades
effectiveDateTime	string (date-time)		DateTime för reservationen som börjar när den här versionen gäller från.
expiryDate	string (date)		Det här är det datum då reservationen upphör att gälla.
expiryDateTime	string (date-time)		Det här är den tidpunkt då reservationen upphör att gälla.
extendedStatusInfo	ExtendedStatusInfo		Meddelandet med detaljerad information om statuskoden.
instanceFlexibility	InstanceFlexibility		Tillåter att reservationsrabatt tillämpas mellan sku:er i samma grupp för automatisk anpassning. Det är inte alla sku:er som har stöd för flexibel instansstorlek.
lastUpdatedDateTime	string (date-time)		DateTime för den senaste gången reservationen uppdaterades.
mergeProperties	ReservationMergeProperties		Egenskaper för reservationssammanslagning
provisioningState	ProvisioningState		Aktuellt tillstånd för reservationen.
provisioningSubState	string		Etableringens undertillstånd för reservationen, t.ex. Lyckades
purchaseDate	string (date)		Det här är datumet då reservationen köptes.
purchaseDateTime	string (date-time)		Det här är den tidpunkt då reservationen köptes.
quantity	integer (int32)		Antal sku:er som ingår i reservationen.
renew	boolean	False	Om du anger värdet true köps automatiskt en ny reservation på förfallodatumtiden.
renewDestination	string		Reservations-ID för reservationen som köps på grund av förnyelse. Formatet för resurs-ID:t är /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}.
renewProperties	RenewPropertiesResponse		Förnyelseegenskaperna för en reservation.
renewSource	string		Reservations-ID för reservationen som reservationen förnyas från. Formatet för resurs-ID:t är /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}.
reservedResourceType	ReservedResourceType		Typen av resurs som reserveras.
reviewDateTime	string (date-time)		Det här är den datum då Azure Hybrid-förmånen måste granskas.
skuDescription	string		Beskrivning av sku:n på engelska.
splitProperties	ReservationSplitProperties		Egenskaper för reservationsdelning
swapProperties	ReservationSwapProperties		Egenskaper för reservationsbyte
term	ReservationTerm		Representera reservationsperioden.
userFriendlyAppliedScopeType	string		Den tillämpade omfångstypen för reservationen för visning, t.ex. Delad
userFriendlyRenewState	string		Förnyelsetillståndet för reservationen för visning, t.ex. På
utilization	Utilization		Reservationsanvändning

ReservationStatusCode

Uppräkning

Värde	Description
Active
Expired
Merged
None
PaymentInstrumentError
Pending
Processing
PurchaseError
Split
Succeeded

ReservationSwapProperties

Objekt

Egenskaper för reservationsbyte

Name	Typ	Description
swapDestination	string	Reservationsresurs-ID som den ursprungliga resursen växlas till. Formatet för resurs-ID:t är /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}
swapSource	string	Resurs-ID för källreservationen som byts ut. Formatet för resurs-ID:t är /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}

ReservationTerm

Uppräkning

Representera reservationsperioden.

Värde	Description
P1Y
P3Y
P5Y

ReservationUtilizationAggregates

Objekt

Aggregerade värden för reservationsanvändning

Name	Typ	Description
grain	number	Kornet för aggregerade
grainUnit	string	Kornenheten för aggregerade
value	number	Aggregeringsvärdet
valueUnit	string	Den sammanställda värdeenheten

ReservedResourceProperties

Objekt

Egenskaper som är specifika för varje reserverad resurstyp. Krävs inte om det inte är tillämpligt.

Name	Typ	Description
instanceFlexibility	InstanceFlexibility	Om du aktiverar detta tillämpas reservationsrabatten på andra virtuella datorer i samma vm-storleksgrupp. Ange endast reserverad resurstyp för VirtualMachines.

ReservedResourceType

Uppräkning

Typen av resurs som reserveras.

Värde	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

Objekt

Namnet på sku

Name	Typ	Description
name	string

SplitRequest

Objekt

Begäran om reservationsdelning

Name	Typ	Description
properties.quantities	integer[] (int32)	Lista över kvantiteterna i de nya reservationer som ska skapas.
properties.reservationId	string	Resurs-ID för reservationen som ska delas. Formatet för resurs-ID:t ska vara /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}

systemData

Objekt

Metadata som rör skapande och senaste ändring av resursen.

Name	Typ	Description
createdAt	string (date-time)	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string (date-time)	Tidsstämpeln för resursens senaste ändring (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.

Utilization

Objekt

Reservationsanvändning

Name	Typ	Description
aggregates	ReservationUtilizationAggregates[]	Matrisen med aggregeringar av en reservations användning
trend	string	senaste 7 dagarnas användningstrend för en reservation