Reservation - Split

Service:

Reserved VM Instances

API-versie:

2022-11-01

Splits de Reservation.
Splits een Reservation in twee Reservations met de opgegeven hoeveelheidsdistributie.

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

URI-parameters

Name	In	Vereist	Type	Description
reservationOrderId	path	True	string	Order-id van de reservering
api-version	query	True	string	Ondersteunde versie.

Aanvraagbody

Name	Type	Description
properties.quantities	integer[]	Lijst met de hoeveelheden in de nieuwe reserveringen die moeten worden gemaakt.
properties.reservationId	string	Resource-id van de reservering die moet worden gesplitst. Indeling van de resource-id moet /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} zijn

Antwoorden

Name	Type	Description
200 OK	ReservationResponse[]	Lijst met Reservations die zijn gemaakt na de splitsingsbewerking.
202 Accepted		De aanvraag wordt geaccepteerd en wordt verwerkt Kopteksten Location: string Retry-After: integer
Other Status Codes	Error	Onverwachte fout

Voorbeelden

Split

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:

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

Statuscode:

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

Definities

Name	Description
AppliedScopeProperties	Eigenschappen die specifiek zijn voor het toegepaste bereiktype. Niet vereist als dit niet van toepassing is. Vereist en moet tenantId en managementGroupId opgeven als AppliedScopeType ManagementGroup is
AppliedScopeType	Type van het toegepaste bereik.
BillingCurrencyTotal	De valuta en het bedrag dat in de lokale valuta van de klant in rekening wordt gebracht voor verlengingsaankopen. Belasting is niet inbegrepen.
createdByType	Het type identiteit waarmee de resource is gemaakt.
Error	Foutinformatie
ErrorResponseCode	Foutcode waarin de reden wordt beschreven waarom de service de binnenkomende aanvraag niet kan verwerken
ExtendedErrorInfo	Uitgebreide foutinformatie, inclusief foutcode en foutbericht
ExtendedStatusInfo
InstanceFlexibility	Als u dit inschakelt, wordt de reserveringskorting toegepast op andere VM's in dezelfde VM-groottegroep. Geef alleen het gereserveerde resourcetype VirtualMachines op.
Kind	Type resourceprovider dat moet worden gereserveerd.
PricingCurrencyTotal	Het bedrag dat Microsoft gebruikt voor de record. Gebruikt tijdens restitutie voor het berekenen van de restitutielimiet. Belasting is niet inbegrepen. Dit is vergrendelde prijs 30 dagen voor de vervaldatum.
ProvisioningState	Hiermee wordt de huidige status van de reservering opgegeven.
PurchaseRequest	De aanvraag voor reserveringsaankoop
RenewPropertiesResponse	De vernieuwingseigenschappen voor een reservering.
ReservationBillingPlan	De factureringsplannen vertegenwoordigen.
ReservationMergeProperties	Eigenschappen van reserveringssamenvoeging
ReservationResponse	De definitie van de reservering.
ReservationSplitProperties	Eigenschappen van reserveringssplitsing
ReservationsProperties	De eigenschappen van de reserveringen
ReservationStatusCode
ReservationSwapProperties	Eigenschappen van reserveringswisseling
ReservationTerm	De duur van de reservering vertegenwoordigen.
ReservationUtilizationAggregates	De geaggregeerde waarden van het reserveringsgebruik
ReservedResourceProperties	Eigenschappen die specifiek zijn voor elk gereserveerd resourcetype. Niet vereist als dit niet van toepassing is.
ReservedResourceType	Het type resource dat wordt gereserveerd.
SkuName	De naam van de SKU
SplitRequest	De aanvraag voor het splitsen van de reservering
systemData	Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.
Utilization	Reserveringsgebruik

AppliedScopeProperties

Eigenschappen die specifiek zijn voor het toegepaste bereiktype. Niet vereist als dit niet van toepassing is. Vereist en moet tenantId en managementGroupId opgeven als AppliedScopeType ManagementGroup is

Name	Type	Description
displayName	string	Weergavenaam
managementGroupId	string	Volledig gekwalificeerde id van de beheergroep waar het voordeel moet worden toegepast.
resourceGroupId	string	Volledig gekwalificeerde id van de resourcegroep.
subscriptionId	string	Volledig gekwalificeerde id van het abonnement.
tenantId	string	Tenant-id waar het besparingsplan voordeel moet toepassen.

AppliedScopeType

Type van het toegepaste bereik.

Name	Type	Description
ManagementGroup	string
Shared	string
Single	string

BillingCurrencyTotal

De valuta en het bedrag dat in de lokale valuta van de klant in rekening wordt gebracht voor verlengingsaankopen. Belasting is niet inbegrepen.

Name	Type	Description
amount	number
currencyCode	string	De ISO 4217-valutacode van 3 letters voor de valuta die door deze aankooprecord wordt gebruikt.

createdByType

Het type identiteit waarmee de resource is gemaakt.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

Error

Foutinformatie

Name	Type	Description
error	ExtendedErrorInfo	Uitgebreide foutinformatie, inclusief foutcode en foutbericht

ErrorResponseCode

Foutcode waarin de reden wordt beschreven waarom de service de binnenkomende aanvraag niet kan verwerken

Name	Type	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

Uitgebreide foutinformatie, inclusief foutcode en foutbericht

Name	Type	Description
code	ErrorResponseCode	Foutcode waarin de reden wordt beschreven waarom de service de binnenkomende aanvraag niet kan verwerken
message	string

ExtendedStatusInfo

Name	Type	Description
message	string	Het bericht met gedetailleerde informatie over de statuscode.
statusCode	ReservationStatusCode

InstanceFlexibility

Als u dit inschakelt, wordt de reserveringskorting toegepast op andere VM's in dezelfde VM-groottegroep. Geef alleen het gereserveerde resourcetype VirtualMachines op.

Name	Type	Description
Off	string
On	string

Kind

Type resourceprovider dat moet worden gereserveerd.

Name	Type	Description
Microsoft.Compute	string

PricingCurrencyTotal

Het bedrag dat Microsoft gebruikt voor de record. Gebruikt tijdens restitutie voor het berekenen van de restitutielimiet. Belasting is niet inbegrepen. Dit is vergrendelde prijs 30 dagen voor de vervaldatum.

Name	Type	Description
amount	number
currencyCode	string	De ISO 4217-valutacode van 3 letters voor de valuta die door deze aankooprecord wordt gebruikt.

ProvisioningState

Hiermee wordt de huidige status van de reservering opgegeven.

Name	Type	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

De aanvraag voor reserveringsaankoop

Name	Type	Default value	Description
location	string		De Azure-regio waar de gereserveerde resource zich bevindt.
properties.appliedScopeProperties	AppliedScopeProperties		Eigenschappen die specifiek zijn voor het toegepaste bereiktype. Niet vereist als dit niet van toepassing is. Vereist en moet tenantId en managementGroupId opgeven als AppliedScopeType ManagementGroup is
properties.appliedScopeType	AppliedScopeType		Type van het toegepaste bereik.
properties.appliedScopes	string[]		Lijst met de abonnementen waarvoor het voordeel wordt toegepast. Geef niet op of AppliedScopeType Gedeeld is. Deze eigenschap wordt afgeschaft en vervangen door appliedScopeProperties in plaats daarvan voor Single AppliedScopeType.
properties.billingPlan	ReservationBillingPlan		De factureringsplannen vertegenwoordigen.
properties.billingScopeId	string		Abonnement dat in rekening wordt gebracht voor het kopen van een reserverings- of spaarplan
properties.displayName	string		Beschrijvende naam van de reservering
properties.quantity	integer		Hoeveelheid van de SKU's die deel uitmaken van de reservering.
properties.renew	boolean	False	Als u dit instelt op true, wordt er automatisch een nieuwe reservering aangeschaft op de vervaldatumtijd.
properties.reservedResourceProperties	ReservedResourceProperties		Eigenschappen die specifiek zijn voor elk gereserveerd resourcetype. Niet vereist als dit niet van toepassing is.
properties.reservedResourceType	ReservedResourceType		Het type resource dat wordt gereserveerd.
properties.reviewDateTime	string		Dit is de datum/tijd waarop het Hybride Azure-voordeel moet worden beoordeeld.
properties.term	ReservationTerm		De duur van de reservering vertegenwoordigen.
sku	SkuName		De naam van de SKU

RenewPropertiesResponse

De vernieuwingseigenschappen voor een reservering.

Name	Type	Description
billingCurrencyTotal	BillingCurrencyTotal	De valuta en het bedrag dat in de lokale valuta van de klant in rekening wordt gebracht voor verlengingsaankopen. Belasting is niet inbegrepen.
pricingCurrencyTotal	PricingCurrencyTotal	Het bedrag dat Microsoft gebruikt voor de record. Gebruikt tijdens restitutie voor het berekenen van de restitutielimiet. Belasting is niet inbegrepen. Dit is vergrendelde prijs 30 dagen voor de vervaldatum.
purchaseProperties	PurchaseRequest	De aanvraag voor reserveringsaankoop

ReservationBillingPlan

De factureringsplannen vertegenwoordigen.

Name	Type	Description
Monthly	string
Upfront	string

ReservationMergeProperties

Eigenschappen van reserveringssamenvoeging

Name	Type	Description
mergeDestination	string	Reserveringsresource-id Gemaakt vanwege de samenvoeging. Indeling van de resource-id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}
mergeSources	string[]	Resource-id's van de samengevoegde bronreservering om deze reservering te vormen. Indeling van de resource-id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}

ReservationResponse

De definitie van de reservering.

Name	Type	Description
etag	integer
id	string	Volledig gekwalificeerde resource-id voor de resource. Bijvoorbeeld "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind	Kind	Type resourceprovider dat moet worden gereserveerd.
location	string	De Azure-regio waar de gereserveerde resource zich bevindt.
name	string	De naam van de resource
properties	ReservationsProperties	De eigenschappen die aan deze reservering zijn gekoppeld
sku	SkuName	De SKU-gegevens die zijn gekoppeld aan deze reservering
systemData	systemData	Azure Resource Manager metagegevens met informatie over createdBy en modifiedBy.
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

ReservationSplitProperties

Eigenschappen van reserveringssplitsing

Name	Type	Description
splitDestinations	string[]	Lijst met doelresource-id die is gemaakt vanwege splitsing. Indeling van de resource-id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}
splitSource	string	Resource-id van de reservering waaruit deze is gesplitst. Indeling van de resource-id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}

ReservationsProperties

De eigenschappen van de reserveringen

Name	Type	Default value	Description
appliedScopeProperties	AppliedScopeProperties		Eigenschappen die specifiek zijn voor het toegepaste bereiktype. Niet vereist als dit niet van toepassing is. Vereist en moet tenantId en managementGroupId opgeven als AppliedScopeType ManagementGroup is
appliedScopeType	AppliedScopeType		Het toegepaste bereiktype
appliedScopes	string[]		De lijst met toegepaste bereiken
archived	boolean		Geeft aan of de reservering is gearchiveerd
benefitStartTime	string		Dit is de datum/tijd waarop het reserveringsvoordeel is gestart.
billingPlan	ReservationBillingPlan		De opties voor het factureringsplan die beschikbaar zijn voor deze SKU.
billingScopeId	string		Abonnement dat in rekening wordt gebracht voor het kopen van een reserverings- of spaarplan
capabilities	string		Mogelijkheden van de reservering
displayName	string		Beschrijvende naam voor de gebruiker om de reservering gemakkelijk te identificeren
displayProvisioningState	string		De inrichtingsstatus van de reservering voor weergave, bijvoorbeeld Geslaagd
effectiveDateTime	string		Datum/tijd van de reservering die begint wanneer deze versie van kracht is vanaf.
expiryDate	string		Dit is de datum waarop de reservering verloopt.
expiryDateTime	string		Dit is de datum/tijd waarop de reservering verloopt.
extendedStatusInfo	ExtendedStatusInfo		Het bericht met gedetailleerde informatie over de statuscode.
instanceFlexibility	InstanceFlexibility		Hiermee kan reserveringskorting worden toegepast op SKU's binnen dezelfde groep voor automatisch aanpassen. Niet alle SKU's ondersteunen flexibiliteit van instantiegrootte.
lastUpdatedDateTime	string		Datum/tijd van de laatste keer dat de reservering is bijgewerkt.
mergeProperties	ReservationMergeProperties		Eigenschappen van reserveringssamenvoeging
provisioningState	ProvisioningState		Huidige status van de reservering.
provisioningSubState	string		De substatus van de inrichting van de reservering, bijvoorbeeld Geslaagd
purchaseDate	string		Dit is de datum waarop de reservering is gekocht.
purchaseDateTime	string		Dit is de datum/tijd waarop de reservering is gekocht.
quantity	integer		Hoeveelheid van de SKU's die deel uitmaken van de reservering.
renew	boolean	False	Als u dit instelt op true, wordt er automatisch een nieuwe reservering aangeschaft op de vervaldatumtijd.
renewDestination	string		Reserverings-id van de reservering die is aangeschaft vanwege verlenging. Indeling van de resource-id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}.
renewProperties	RenewPropertiesResponse		De vernieuwingseigenschappen voor een reservering.
renewSource	string		Reserverings-id van de reservering van waaruit deze reservering wordt verlengd. Indeling van de resource-id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}.
reservedResourceType	ReservedResourceType		Het type resource dat wordt gereserveerd.
reviewDateTime	string		Dit is de datum/tijd waarop de Azure Hybrid Benefit moet worden gecontroleerd.
skuDescription	string		Beschrijving van de SKU in het Engels.
splitProperties	ReservationSplitProperties		Eigenschappen van reserveringssplitsing
swapProperties	ReservationSwapProperties		Eigenschappen van reserveringswisseling
term	ReservationTerm		De duur van de reservering vertegenwoordigen.
userFriendlyAppliedScopeType	string		Het toegepaste bereiktype van de reservering voor weergave, bijvoorbeeld Gedeeld
userFriendlyRenewState	string		De verlengingsstatus van de reservering voor weergave, bijvoorbeeld Aan
utilization	Utilization		Reserveringsgebruik

ReservationStatusCode

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

ReservationSwapProperties

Eigenschappen van reserveringswisseling

Name	Type	Description
swapDestination	string	De resource-id van de reservering waarnaar de oorspronkelijke resource wordt gewisseld. Indeling van de resource-id is /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}
swapSource	string	Resource-id van de bronreservering die wordt verwisseld. Indeling van de resource-id is /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}

ReservationTerm

De duur van de reservering vertegenwoordigen.

Name	Type	Description
P1Y	string
P3Y	string
P5Y	string

ReservationUtilizationAggregates

De geaggregeerde waarden van het reserveringsgebruik

Name	Type	Description
grain	number	De korrel van de aggregatie
grainUnit	string	De korreleenheid van de aggregatie
value	number	De geaggregeerde waarde
valueUnit	string	De eenheid van de aggregatiewaarde

ReservedResourceProperties

Eigenschappen die specifiek zijn voor elk gereserveerd resourcetype. Niet vereist als dit niet van toepassing is.

Name	Type	Description
instanceFlexibility	InstanceFlexibility	Als u dit inschakelt, wordt de reserveringskorting toegepast op andere VM's in dezelfde VM-groottegroep. Geef alleen het gereserveerde resourcetype VirtualMachines op.

ReservedResourceType

Het type resource dat wordt gereserveerd.

Name	Type	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

De naam van de SKU

Name	Type	Description
name	string

SplitRequest

De aanvraag voor het splitsen van de reservering

Name	Type	Description
properties.quantities	integer[]	Lijst met de hoeveelheden in de nieuwe reserveringen die moeten worden gemaakt.
properties.reservationId	string	Resource-id van de reservering die moet worden gesplitst. Indeling van de resource-id moet /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} zijn

systemData

Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.

Name	Type	Description
createdAt	string	Het tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit waarmee de resource is gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string	De tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy	string	De identiteit die de resource het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource het laatst heeft gewijzigd.

Utilization

Reserveringsgebruik

Name	Type	Description
aggregates	ReservationUtilizationAggregates[]	De matrix met aggregaties van het gebruik van een reservering
trend	string	Gebruikstrend van afgelopen 7 dagen voor een reservering