Reservation Order - Purchase

Service:

Reserved VM Instances

API-versie:

2022-11-01

Koop ReservationOrder en maak een resource onder de opgegeven URI.

PUT https://management.azure.com/providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}?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
location	string	De Azure-regio waar de gereserveerde resource zich bevindt.
properties.appliedScopeProperties	AppliedScopeProperties	Eigenschappen die specifiek zijn voor het toegepaste bereiktype. Niet vereist indien niet van toepassing. 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 waarop het voordeel wordt toegepast. Geef niet op of AppliedScopeType gedeeld is. Deze eigenschap wordt afgeschaft en vervangen door appliedScopeProperties voor Single AppliedScopeType.
properties.billingPlan	ReservationBillingPlan	Vertegenwoordig de factureringsplannen.
properties.billingScopeId	string	Abonnement dat wordt in rekening gebracht voor het aanschaffen van een reservering of spaarplan
properties.displayName	string	Beschrijvende naam van de reservering
properties.quantity	integer (int32)	Hoeveelheid van de SKU's die deel uitmaken van de reservering.
properties.renew	boolean	Als u dit instelt op True, wordt automatisch een nieuwe reservering aangeschaft op de vervaldatum.
properties.reservedResourceProperties	ReservedResourceProperties	Eigenschappen die specifiek zijn voor elk gereserveerd resourcetype. Niet vereist indien niet van toepassing.
properties.reservedResourceType	ReservedResourceType	Het type resource dat wordt gereserveerd.
properties.reviewDateTime	string (date-time)	Dit is de datum en tijd waarop het Hybride Azure-voordeel moet worden gecontroleerd.
properties.term	ReservationTerm	Vertegenwoordig de reserveringstermijn.
sku	SkuName	De naam van de SKU

Antwoorden

Name	Type	Description
200 OK	ReservationOrderResponse	De resource is gemaakt
202 Accepted	ReservationOrderResponse	De aanvraag wordt geaccepteerd en wordt verwerkt. De koppeling naar het resultaat van de bewerking bevindt zich in de locatiekoptekst. Kopteksten Location: string Retry-After: integer
Other Status Codes	Error	Onverwachte fout

Voorbeelden

Purchase

Voorbeeldaanvraag

HTTP

PUT https://management.azure.com/providers/Microsoft.Capacity/reservationOrders/a075419f-44cc-497f-b68a-14ee811d48b9?api-version=2022-11-01

{
  "sku": {
    "name": "standard_D1"
  },
  "location": "westus",
  "properties": {
    "reservedResourceType": "VirtualMachines",
    "billingScopeId": "/subscriptions/ed3a1871-612d-abcd-a849-c2542a68be83",
    "term": "P1Y",
    "billingPlan": "Monthly",
    "quantity": 1,
    "displayName": "TestReservationOrder",
    "appliedScopes": null,
    "appliedScopeType": "Shared",
    "reservedResourceProperties": {
      "instanceFlexibility": "On"
    },
    "renew": false
  }
}

Java

import com.azure.resourcemanager.reservations.models.AppliedScopeType;
import com.azure.resourcemanager.reservations.models.InstanceFlexibility;
import com.azure.resourcemanager.reservations.models.PurchaseRequest;
import com.azure.resourcemanager.reservations.models.PurchaseRequestPropertiesReservedResourceProperties;
import com.azure.resourcemanager.reservations.models.ReservationBillingPlan;
import com.azure.resourcemanager.reservations.models.ReservationTerm;
import com.azure.resourcemanager.reservations.models.ReservedResourceType;
import com.azure.resourcemanager.reservations.models.SkuName;

/**
 * Samples for ReservationOrder Purchase.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/reservations/resource-manager/Microsoft.Capacity/stable/2022-11-01/examples/
     * PurchaseReservationOrder.json
     */
    /**
     * Sample code: Purchase.
     * 
     * @param manager Entry point to ReservationsManager.
     */
    public static void purchase(com.azure.resourcemanager.reservations.ReservationsManager manager) {
        manager.reservationOrders().purchase("a075419f-44cc-497f-b68a-14ee811d48b9",
            new PurchaseRequest().withSku(new SkuName().withName("standard_D1")).withLocation("westus")
                .withReservedResourceType(ReservedResourceType.VIRTUAL_MACHINES)
                .withBillingScopeId("/subscriptions/ed3a1871-612d-abcd-a849-c2542a68be83").withTerm(ReservationTerm.P1Y)
                .withBillingPlan(ReservationBillingPlan.MONTHLY).withQuantity(1).withDisplayName("TestReservationOrder")
                .withAppliedScopeType(AppliedScopeType.SHARED).withRenew(false)
                .withReservedResourceProperties(new PurchaseRequestPropertiesReservedResourceProperties()
                    .withInstanceFlexibility(InstanceFlexibility.ON)),
            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 purchase_reservation_order.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_order.begin_purchase(
        reservation_order_id="a075419f-44cc-497f-b68a-14ee811d48b9",
        body={
            "location": "westus",
            "properties": {
                "appliedScopeType": "Shared",
                "appliedScopes": None,
                "billingPlan": "Monthly",
                "billingScopeId": "/subscriptions/ed3a1871-612d-abcd-a849-c2542a68be83",
                "displayName": "TestReservationOrder",
                "quantity": 1,
                "renew": False,
                "reservedResourceProperties": {"instanceFlexibility": "On"},
                "reservedResourceType": "VirtualMachines",
                "term": "P1Y",
            },
            "sku": {"name": "standard_D1"},
        },
    ).result()
    print(response)


# x-ms-original-file: specification/reservations/resource-manager/Microsoft.Capacity/stable/2022-11-01/examples/PurchaseReservationOrder.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/PurchaseReservationOrder.json
func ExampleReservationOrderClient_BeginPurchase() {
	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.NewReservationOrderClient().BeginPurchase(ctx, "a075419f-44cc-497f-b68a-14ee811d48b9", armreservations.PurchaseRequest{
		Location: to.Ptr("westus"),
		Properties: &armreservations.PurchaseRequestProperties{
			AppliedScopeType: to.Ptr(armreservations.AppliedScopeTypeShared),
			BillingPlan:      to.Ptr(armreservations.ReservationBillingPlanMonthly),
			BillingScopeID:   to.Ptr("/subscriptions/ed3a1871-612d-abcd-a849-c2542a68be83"),
			DisplayName:      to.Ptr("TestReservationOrder"),
			Quantity:         to.Ptr[int32](1),
			Renew:            to.Ptr(false),
			ReservedResourceProperties: &armreservations.PurchaseRequestPropertiesReservedResourceProperties{
				InstanceFlexibility: to.Ptr(armreservations.InstanceFlexibilityOn),
			},
			ReservedResourceType: to.Ptr(armreservations.ReservedResourceTypeVirtualMachines),
			Term:                 to.Ptr(armreservations.ReservationTermP1Y),
		},
		SKU: &armreservations.SKUName{
			Name: to.Ptr("standard_D1"),
		},
	}, 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.ReservationOrderResponse = armreservations.ReservationOrderResponse{
	// 	Name: to.Ptr("1f14354c-dc12-4c8d-8090-6f295a3a34aa"),
	// 	Type: to.Ptr("Microsoft.Capacity/reservationOrders"),
	// 	Etag: to.Ptr[int32](7),
	// 	ID: to.Ptr("/providers/microsoft.capacity/reservationOrders/1f14354c-dc12-4c8d-8090-6f295a3a34aa"),
	// 	Properties: &armreservations.ReservationOrderProperties{
	// 		BillingPlan: to.Ptr(armreservations.ReservationBillingPlanMonthly),
	// 		CreatedDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-08-30T03:51:49.808Z"); return t}()),
	// 		DisplayName: to.Ptr("cabri"),
	// 		ExpiryDate: to.Ptr(func() time.Time { t, _ := time.Parse("2006-01-02", "2018-08-30"); return t}()),
	// 		ExpiryDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-08-30T03:51:49.808Z"); return t}()),
	// 		OriginalQuantity: to.Ptr[int32](7),
	// 		ProvisioningState: to.Ptr(armreservations.ProvisioningStateSucceeded),
	// 		RequestDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-08-30T03:49:19.025Z"); return t}()),
	// 		Reservations: []*armreservations.ReservationResponse{
	// 			{
	// 				ID: to.Ptr("/providers/microsoft.capacity/reservationOrders/1f14354c-dc12-4c8d-8090-6f295a3a34aa/reservations/c8c926bd-fc5d-4e29-9d43-b68340ac23a6"),
	// 		}},
	// 		Term: to.Ptr(armreservations.ReservationTermP1Y),
	// 	},
	// }
}

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 Purchase `ReservationOrder` and create resource under the specified URI.
 *
 * @summary Purchase `ReservationOrder` and create resource under the specified URI.
 * x-ms-original-file: specification/reservations/resource-manager/Microsoft.Capacity/stable/2022-11-01/examples/PurchaseReservationOrder.json
 */
async function purchase() {
  const reservationOrderId = "a075419f-44cc-497f-b68a-14ee811d48b9";
  const body = {
    appliedScopeType: "Shared",
    appliedScopes: [],
    billingPlan: "Monthly",
    billingScopeId: "/subscriptions/ed3a1871-612d-abcd-a849-c2542a68be83",
    displayName: "TestReservationOrder",
    location: "westus",
    quantity: 1,
    renew: false,
    reservedResourceProperties: { instanceFlexibility: "On" },
    reservedResourceType: "VirtualMachines",
    sku: { name: "standard_D1" },
    term: "P1Y",
  };
  const credential = new DefaultAzureCredential();
  const client = new AzureReservationAPI(credential);
  const result = await client.reservationOrder.beginPurchaseAndWait(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.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/PurchaseReservationOrder.json
// this example is just showing the usage of "ReservationOrder_Purchase" 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 TenantResource created on azure
// for more information of creating TenantResource, please refer to the document of TenantResource
var tenantResource = client.GetTenants().GetAllAsync().GetAsyncEnumerator().Current;

// get the collection of this ReservationOrderResource
ReservationOrderCollection collection = tenantResource.GetReservationOrders();

// invoke the operation
Guid reservationOrderId = Guid.Parse("a075419f-44cc-497f-b68a-14ee811d48b9");
ReservationPurchaseContent content = new ReservationPurchaseContent()
{
    SkuName = "standard_D1",
    Location = new AzureLocation("westus"),
    ReservedResourceType = ReservedResourceType.VirtualMachines,
    BillingScopeId = new ResourceIdentifier("/subscriptions/ed3a1871-612d-abcd-a849-c2542a68be83"),
    Term = ReservationTerm.P1Y,
    BillingPlan = ReservationBillingPlan.Monthly,
    Quantity = 1,
    DisplayName = "TestReservationOrder",
    AppliedScopeType = AppliedScopeType.Shared,
    AppliedScopes =
    {
    },
    IsRenewEnabled = false,
    ReservedResourceInstanceFlexibility = InstanceFlexibility.On,
};
ArmOperation<ReservationOrderResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, reservationOrderId, content);
ReservationOrderResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
ReservationOrderData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

{
  "id": "/providers/microsoft.capacity/reservationOrders/1f14354c-dc12-4c8d-8090-6f295a3a34aa",
  "type": "Microsoft.Capacity/reservationOrders",
  "name": "1f14354c-dc12-4c8d-8090-6f295a3a34aa",
  "etag": 7,
  "properties": {
    "displayName": "cabri",
    "requestDateTime": "2017-08-30T03:49:19.0252126Z",
    "createdDateTime": "2017-08-30T03:51:49.8083758Z",
    "expiryDate": "2018-08-30",
    "expiryDateTime": "2018-08-30T03:51:49.8083758Z",
    "term": "P1Y",
    "billingPlan": "Monthly",
    "provisioningState": "Succeeded",
    "reservations": [
      {
        "id": "/providers/microsoft.capacity/reservationOrders/1f14354c-dc12-4c8d-8090-6f295a3a34aa/reservations/c8c926bd-fc5d-4e29-9d43-b68340ac23a6"
      }
    ],
    "originalQuantity": 7
  }
}

Statuscode:

202

Location: https://management.azure.com/providers/microsoft.capacity/reservationOrders/1f14354c-dc12-4c8d-8090-6f295a3a34aa?api-version=2022-11-01
Retry-After: 120

{
  "id": "/providers/microsoft.capacity/reservationOrders/1f14354c-dc12-4c8d-8090-6f295a3a34aa",
  "type": "Microsoft.Capacity/reservationOrders",
  "name": "1f14354c-dc12-4c8d-8090-6f295a3a34aa",
  "etag": 7,
  "properties": {
    "displayName": "cabri",
    "billingPlan": "Monthly",
    "requestDateTime": "2017-08-30T03:49:19.0252126Z",
    "createdDateTime": "2017-08-30T03:51:49.8083758Z",
    "expiryDate": "2018-08-30",
    "expiryDateTime": "2018-08-30T03:51:49.8083758Z",
    "term": "P1Y",
    "provisioningState": "Succeeded",
    "reservations": [
      {
        "id": "/providers/microsoft.capacity/reservationOrders/1f14354c-dc12-4c8d-8090-6f295a3a34aa/reservations/c8c926bd-fc5d-4e29-9d43-b68340ac23a6"
      }
    ],
    "originalQuantity": 7
  }
}

Definities

Name	Description
AppliedScopeProperties	Eigenschappen die specifiek zijn voor het toegepaste bereiktype. Niet vereist indien niet van toepassing. Vereist en moet tenantId en managementGroupId opgeven als AppliedScopeType ManagementGroup is
AppliedScopeType	Type van het toegepaste bereik.
BillingCurrencyTotal	Valuta en bedrag dat de klant in rekening wordt gebracht in de lokale valuta van de klant voor de aankoop van verlenging. Belasting is niet inbegrepen.
createdByType	Het type identiteit waarmee de resource is gemaakt.
Error	Foutinformatie
ErrorResponseCode	Foutcode die de reden beschrijft dat 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	Het type resourceprovider dat moet worden gereserveerd.
PaymentDetail	Informatie over betaling met betrekking tot een reserveringsorder.
PaymentStatus	Beschrijft of de betaling is voltooid, mislukt, geannuleerd of gepland in de toekomst.
Price	Prijsinformatie met het bedrag en de valutacode
PricingCurrencyTotal	Het bedrag dat Microsoft gebruikt voor record. Wordt gebruikt tijdens de restitutie voor het berekenen van de restitutielimiet. Belasting is niet inbegrepen. Dit is vergrendelde prijs 30 dagen voordat de vervaldatum is verstreken.
ProvisioningState	De huidige status van de reservering weergeven.
PurchaseRequest	De aanvraag voor reserveringsaankoop
RenewPropertiesResponse	De verlengingseigenschappen voor een reservering.
ReservationBillingPlan	Vertegenwoordig de factureringsplannen.
ReservationMergeProperties	Eigenschappen van reserveringssamenvoeging
ReservationOrderBillingPlanInformation	Informatie over het type factureringsplan voor deze reservering.
ReservationOrderResponse	Details van een reserveringsorder die wordt geretourneerd.
ReservationResponse	De definitie van de reservering.
ReservationSplitProperties	Eigenschappen van reserveringssplitsing
ReservationsProperties	De eigenschappen van de reserveringen
ReservationStatusCode
ReservationSwapProperties	Eigenschappen van reserveringswisseling
ReservationTerm	Vertegenwoordig de reserveringstermijn.
ReservationUtilizationAggregates	De geaggregeerde waarden van het reserveringsgebruik
ReservedResourceProperties	Eigenschappen die specifiek zijn voor elk gereserveerd resourcetype. Niet vereist indien niet van toepassing.
ReservedResourceType	Het type resource dat wordt gereserveerd.
SkuName	De naam van de SKU
systemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.
Utilization	Reserveringsgebruik

AppliedScopeProperties

Object

Eigenschappen die specifiek zijn voor het toegepaste bereiktype. Niet vereist indien niet van toepassing. 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 waarbij het spaarplan voordeel moet toepassen.

AppliedScopeType

Inventarisatie

Type van het toegepaste bereik.

Waarde	Description
ManagementGroup
Shared
Single

BillingCurrencyTotal

Object

Valuta en bedrag dat de klant in rekening wordt gebracht in de lokale valuta van de klant voor de aankoop van verlenging. Belasting is niet inbegrepen.

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

createdByType

Inventarisatie

Het type identiteit waarmee de resource is gemaakt.

Waarde	Description
Application
Key
ManagedIdentity
User

Error

Object

Foutinformatie

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

ErrorResponseCode

Inventarisatie

Foutcode die de reden beschrijft dat de service de binnenkomende aanvraag niet kan verwerken

Waarde	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

Uitgebreide foutinformatie, inclusief foutcode en foutbericht

Name	Type	Description
code	ErrorResponseCode	Foutcode die de reden beschrijft dat de service de binnenkomende aanvraag niet kan verwerken
message	string

ExtendedStatusInfo

Object

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

InstanceFlexibility

Inventarisatie

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

Waarde	Description
Off
On

Kind

Inventarisatie

Het type resourceprovider dat moet worden gereserveerd.

Waarde	Description
Microsoft.Compute

PaymentDetail

Object

Informatie over betaling met betrekking tot een reserveringsorder.

Name	Type	Description
billingAccount	string	Toont het account dat in rekening wordt gebracht voor deze betaling.
billingCurrencyTotal	Price	Bedrag in rekening gebracht in factureringsvaluta. Belasting niet inbegrepen. Is null voor toekomstige betalingen
dueDate	string (date)	Datum waarop de betaling moet worden uitgevoerd.
extendedStatusInfo	ExtendedStatusInfo
paymentDate	string (date)	Datum waarop de transactie is voltooid. Is null wanneer deze is gepland.
pricingCurrencyTotal	Price	Bedrag in prijsvaluta. Belasting niet inbegrepen.
status	PaymentStatus	Beschrijft of de betaling is voltooid, mislukt, geannuleerd of gepland in de toekomst.

PaymentStatus

Inventarisatie

Beschrijft of de betaling is voltooid, mislukt, geannuleerd of gepland in de toekomst.

Waarde	Description
Cancelled
Failed
Scheduled
Succeeded

Price

Object

Prijsinformatie met het bedrag en de valutacode

Name	Type	Description
amount	number (double)
currencyCode	string	De ISO 4217 3-letter valutacode voor de valuta die door deze aankooprecord wordt gebruikt.

PricingCurrencyTotal

Object

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

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

ProvisioningState

Inventarisatie

De huidige status van de reservering weergeven.

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

PurchaseRequest

Object

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 indien niet van toepassing. 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 waarop het voordeel wordt toegepast. Geef niet op of AppliedScopeType gedeeld is. Deze eigenschap wordt afgeschaft en vervangen door appliedScopeProperties voor Single AppliedScopeType.
properties.billingPlan	ReservationBillingPlan		Vertegenwoordig de factureringsplannen.
properties.billingScopeId	string		Abonnement dat wordt in rekening gebracht voor het aanschaffen van een reservering of spaarplan
properties.displayName	string		Beschrijvende naam van de reservering
properties.quantity	integer (int32)		Hoeveelheid van de SKU's die deel uitmaken van de reservering.
properties.renew	boolean	False	Als u dit instelt op True, wordt automatisch een nieuwe reservering aangeschaft op de vervaldatum.
properties.reservedResourceProperties	ReservedResourceProperties		Eigenschappen die specifiek zijn voor elk gereserveerd resourcetype. Niet vereist indien niet van toepassing.
properties.reservedResourceType	ReservedResourceType		Het type resource dat wordt gereserveerd.
properties.reviewDateTime	string (date-time)		Dit is de datum en tijd waarop het Hybride Azure-voordeel moet worden gecontroleerd.
properties.term	ReservationTerm		Vertegenwoordig de reserveringstermijn.
sku	SkuName		De naam van de SKU

RenewPropertiesResponse

Object

De verlengingseigenschappen voor een reservering.

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

ReservationBillingPlan

Inventarisatie

Vertegenwoordig de factureringsplannen.

Waarde	Description
Monthly
Upfront

ReservationMergeProperties

Object

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}

ReservationOrderBillingPlanInformation

Object

Informatie over het type factureringsplan voor deze reservering.

Name	Type	Description
nextPaymentDueDate	string (date)	Voor terugkerende factureringsplannen geeft u de datum aan waarop de volgende betaling wordt verwerkt. Null wanneer het totaal wordt betaald.
pricingCurrencyTotal	Price	Bedrag dat moet worden betaald voor de Bestelling. Belasting is niet inbegrepen.
startDate	string (date)	Datum waarop het factureringsplan is gestart.
transactions	PaymentDetail[]	Informatie over betaling met betrekking tot een reserveringsorder.

ReservationOrderResponse

Object

Details van een reserveringsorder die wordt geretourneerd.

Name	Type	Description
etag	integer (int32)
id	string	Id van de reservering
name	string	Naam van de reservering
properties.benefitStartTime	string (date-time)	Dit is de datum/tijd waarop het reserveringsvoordeel is gestart.
properties.billingPlan	ReservationBillingPlan	Vertegenwoordig de factureringsplannen.
properties.createdDateTime	string (date-time)	Dit is de datum/tijd waarop de reservering is gemaakt.
properties.displayName	string	Beschrijvende naam voor de gebruiker om de reservering eenvoudig te identificeren.
properties.expiryDate	string (date)	Dit is de datum waarop de reservering verloopt.
properties.expiryDateTime	string (date-time)	Dit is de datum/tijd waarop de reservering verloopt.
properties.originalQuantity	integer (int32)	Totale hoeveelheid van de SKU's die in de reservering zijn gekocht.
properties.planInformation	ReservationOrderBillingPlanInformation	Informatie over het type factureringsplan voor deze reservering.
properties.provisioningState	ProvisioningState	Huidige status van de reservering.
properties.requestDateTime	string (date-time)	Dit is de datum/tijd waarop de reservering in eerste instantie is aangevraagd voor aankoop.
properties.reservations	ReservationResponse[]	De definitie van de reservering.
properties.reviewDateTime	string (date-time)	Dit is de datum/tijd waarop azure Hybrid Benefit moet worden gecontroleerd.
properties.term	ReservationTerm	Vertegenwoordig de reserveringstermijn.
systemData	systemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.
type	string	Type resource. "Microsoft.Capacity/reservations"

ReservationResponse

Object

De definitie van de reservering.

Name	Type	Description
etag	integer (int32)
id	string (arm-id)	Volledig gekwalificeerde resource-id voor de resource. Bijvoorbeeld /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceType}/{resourceName}"
kind	Kind	Het 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 aan deze reservering zijn gekoppeld
systemData	systemData	Azure Resource Manager-metagegevens met createdBy- en modifiedBy-gegevens.
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

ReservationSplitProperties

Object

Eigenschappen van reserveringssplitsing

Name	Type	Description
splitDestinations	string[]	Lijst met doelresource-id's die zijn 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

Object

De eigenschappen van de reserveringen

Name	Type	Default value	Description
appliedScopeProperties	AppliedScopeProperties		Eigenschappen die specifiek zijn voor het toegepaste bereiktype. Niet vereist indien niet van toepassing. 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 (date-time)		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 wordt in rekening gebracht voor het aanschaffen van een reservering of spaarplan
capabilities	string		Mogelijkheden van de reservering
displayName	string		Beschrijvende naam voor de gebruiker om de reservering eenvoudig te identificeren
displayProvisioningState	string		De inrichtingsstatus van de reservering voor weergave, bijvoorbeeld Geslaagd
effectiveDateTime	string (date-time)		De datum/tijd van de reservering die begint wanneer deze versie van kracht is.
expiryDate	string (date)		Dit is de datum waarop de reservering verloopt.
expiryDateTime	string (date-time)		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 (date-time)		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 inrichtingssubstatus van de reservering, bijvoorbeeld Geslaagd
purchaseDate	string (date)		Dit is de datum waarop de reservering is gekocht.
purchaseDateTime	string (date-time)		Dit is de datum/tijd waarop de reservering is gekocht.
quantity	integer (int32)		Hoeveelheid van de SKU's die deel uitmaken van de reservering.
renew	boolean	False	Als u dit instelt op True, wordt automatisch een nieuwe reservering aangeschaft op de vervaldatum.
renewDestination	string		Reserverings-id van de reservering die wordt aangeschaft vanwege verlenging. De indeling van de resource-id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}.
renewProperties	RenewPropertiesResponse		De verlengingseigenschappen voor een reservering.
renewSource	string		Reserverings-id van de reservering waaruit deze reservering wordt verlengd. De indeling van de resource-id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}.
reservedResourceType	ReservedResourceType		Het type resource dat wordt gereserveerd.
reviewDateTime	string (date-time)		Dit is de datum/tijd waarop 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		Vertegenwoordig de reserveringstermijn.
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

Inventarisatie

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

ReservationSwapProperties

Object

Eigenschappen van reserveringswisseling

Name	Type	Description
swapDestination	string	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 gewisseld. Indeling van de resource-id is /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}

ReservationTerm

Inventarisatie

Vertegenwoordig de reserveringstermijn.

Waarde	Description
P1Y
P3Y
P5Y

ReservationUtilizationAggregates

Object

De geaggregeerde waarden van het reserveringsgebruik

Name	Type	Description
grain	number	Het korreltje van de aggregaties
grainUnit	string	De graaneenheid van de aggregaties
value	number	De statistische waarde
valueUnit	string	De eenheid van de geaggregeerde waarde

ReservedResourceProperties

Object

Eigenschappen die specifiek zijn voor elk gereserveerd resourcetype. Niet vereist indien niet van toepassing.

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

Inventarisatie

Het type resource dat wordt gereserveerd.

Waarde	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

De naam van de SKU

Name	Type	Description
name	string

systemData

Object

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

Name	Type	Description
createdAt	string (date-time)	De 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 (date-time)	De tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy	string	De identiteit die de resource voor het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource voor het laatst heeft gewijzigd.

Utilization

Object

Reserveringsgebruik

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