Reservation Order - Purchase

Tjänst:

Reserved VM Instances

API-version:

2022-11-01

Köp ReservationOrder och skapa resurs under den angivna URI:n.

PUT https://management.azure.com/providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}?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
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 Delad. 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	Antal sku:er som ingår i reservationen.
properties.renew	boolean	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	Det här är den tidpunkt då Azure Hybrid-förmånen behöver granskas.
properties.term	ReservationTerm	Representerar reservationsperioden.
sku	SkuName	Namnet på sku

Svar

Name	Typ	Description
200 OK	ReservationOrderResponse	Resursen har skapats
202 Accepted	ReservationOrderResponse	Begäran godkänns och bearbetas. Åtgärdsresultatlänken finns i platsrubriken. Sidhuvuden Location: string Retry-After: integer
Other Status Codes	Error	Oväntat fel

Exempel

Purchase

Exempelbegäran

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

Exempelsvar

Statuskod:

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

Statuskod:

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

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 för reserverad resurstyp för VirtualMachines.
Kind	Resursprovidertyp som ska reserveras.
PaymentDetail	Information om betalning relaterad till en reservationsbeställning.
PaymentStatus	Beskriver om betalningen slutförs, misslyckas, avbryts eller schemaläggs i framtiden.
Price	Prisinformation som innehåller beloppet och valutakoden
PricingCurrencyTotal	Belopp som Microsoft använder för posten. Används under återbetalning för att beräkna återbetalningsgränsen. Skatt ingår inte. Det här är låst pris 30 dagar innan det upphör att gälla.
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
ReservationOrderBillingPlanInformation	Information som beskriver typen av faktureringsplan för den här reservationen.
ReservationOrderResponse	Information om en reservationsbeställning som returneras.
ReservationResponse	Definitionen av reservationen.
ReservationSplitProperties	Egenskaper för reservationsdelning
ReservationsProperties	Egenskaperna för reservationerna
ReservationStatusCode
ReservationSwapProperties	Egenskaper för reservationsväxling
ReservationTerm	Representerar 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
systemData	Metadata som rör skapande och senaste ändring av resursen.
Utilization	Reservationsanvändning

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

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

Typ av tillämpat omfång.

Name	Typ	Description
ManagementGroup	string
Shared	string
Single	string

BillingCurrencyTotal

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

Den typ av identitet som skapade resursen.

Name	Typ	Description
Application	string
Key	string
ManagedIdentity	string
User	string

Error

Felinformation

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

ErrorResponseCode

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

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

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

Name	Typ	Description
message	string	Meddelandet innehåller detaljerad information om statuskoden.
statusCode	ReservationStatusCode

InstanceFlexibility

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

Name	Typ	Description
Off	string
On	string

Kind

Resursprovidertyp som ska reserveras.

Name	Typ	Description
Microsoft.Compute	string

PaymentDetail

Information om betalning relaterad till en reservationsbeställning.

Name	Typ	Description
billingAccount	string	Visar det konto som debiteras för den här betalningen.
billingCurrencyTotal	Price	Belopp som debiteras i faktureringsvalutan. Skatt ingår inte. Är null för framtida betalningar
dueDate	string	Datum då betalningen måste göras.
extendedStatusInfo	ExtendedStatusInfo
paymentDate	string	Datum då transaktionen har slutförts. Är null när det är schemalagt.
pricingCurrencyTotal	Price	Belopp i prisvaluta. Skatt ingår inte.
status	PaymentStatus	Beskriver om betalningen slutförs, misslyckas, avbryts eller schemaläggs i framtiden.

PaymentStatus

Beskriver om betalningen slutförs, misslyckas, avbryts eller schemaläggs i framtiden.

Name	Typ	Description
Cancelled	string
Failed	string
Scheduled	string
Succeeded	string

Price

Prisinformation som innehåller beloppet och valutakoden

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.

PricingCurrencyTotal

Belopp som Microsoft använder för posten. Används under återbetalning för att beräkna återbetalningsgränsen. Skatt ingår inte. Det här är låst pris 30 dagar innan det upphör att gälla.

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

Representerar det aktuella tillståndet för reservationen.

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

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 Delad. 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		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		Det här är den tidpunkt då Azure Hybrid-förmånen behöver granskas.
properties.term	ReservationTerm		Representerar reservationsperioden.
sku	SkuName		Namnet på sku

RenewPropertiesResponse

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 posten. Används under återbetalning för att beräkna återbetalningsgränsen. Skatt ingår inte. Det här är låst pris 30 dagar innan det upphör att gälla.
purchaseProperties	PurchaseRequest	Begäran om reservationsköp

ReservationBillingPlan

Representera faktureringsplanerna.

Name	Typ	Description
Monthly	string
Upfront	string

ReservationMergeProperties

Egenskaper för reservationssammanslagning

Name	Typ	Description
mergeDestination	string	Reservationsresurs-ID har skapats 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 som sammanfogats för att skapa den här reservationen. Formatet för resurs-ID:t är /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}

ReservationOrderBillingPlanInformation

Information som beskriver typen av faktureringsplan för den här reservationen.

Name	Typ	Description
nextPaymentDueDate	string	För återkommande faktureringsplaner anger det datum då nästa betalning kommer att bearbetas. Null när totalsumman betalas.
pricingCurrencyTotal	Price	Belopp som ska betalas för ordern. Skatt ingår inte.
startDate	string	Datum då faktureringsplanen har startats.
transactions	PaymentDetail[]	Information om betalning relaterad till en reservationsbeställning.

ReservationOrderResponse

Information om en reservationsbeställning som returneras.

Name	Typ	Description
etag	integer
id	string	ID för reservationen
name	string	Namn på reservationen
properties.benefitStartTime	string	Det här är DateTime när reservationsförmånen startade.
properties.billingPlan	ReservationBillingPlan	Representera faktureringsplanerna.
properties.createdDateTime	string	Det här är DateTime när reservationen skapades.
properties.displayName	string	Eget namn som användaren enkelt kan identifiera reservationen med.
properties.expiryDate	string	Det här är det datum då reservationen upphör att gälla.
properties.expiryDateTime	string	Det här är den tidpunkt då reservationen upphör att gälla.
properties.originalQuantity	integer	Totalt antal sku:er som köpts i reservationen.
properties.planInformation	ReservationOrderBillingPlanInformation	Information som beskriver typen av faktureringsplan för den här reservationen.
properties.provisioningState	ProvisioningState	Aktuellt tillstånd för reservationen.
properties.requestDateTime	string	Det här är DateTime när reservationen ursprungligen begärdes för köp.
properties.reservations	ReservationResponse[]	Definitionen av reservationen.
properties.reviewDateTime	string	Det här är den tidpunkt då Azure Hybrid-förmån behöver granskas.
properties.term	ReservationTerm	Representerar reservationsperioden.
systemData	systemData	Metadata som rör skapande och senaste ändring av resursen.
type	string	Typ av resurs. "Microsoft.Capacity/reservations"

ReservationResponse

Definitionen av reservationen.

Name	Typ	Description
etag	integer
id	string	Fullständigt kvalificerat resurs-ID för resursen. T.ex. "/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	Egenskaperna som är kopplade till den här reservationen
sku	SkuName	SKU-informationen som är associerad med 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

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

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		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 som enkelt kan identifiera reservationen
displayProvisioningState	string		Etableringstillståndet för reservationen för visning, t.ex. Lyckades
effectiveDateTime	string		DateTime för reservationen som börjar när den här versionen gäller från.
expiryDate	string		Det här är det datum då reservationen upphör att gälla.
expiryDateTime	string		Det här är den tidpunkt då reservationen upphör att gälla.
extendedStatusInfo	ExtendedStatusInfo		Meddelandet innehåller detaljerad information om statuskoden.
instanceFlexibility	InstanceFlexibility		Tillåter att reservationsrabatt tillämpas på sku:er inom samma grupp för automatisk anpassning. Det är inte alla sku:er som stöder flexibel instansstorlek.
lastUpdatedDateTime	string		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		Undertillståndet för reservationen, t.ex. Lyckades
purchaseDate	string		Det här är datumet då reservationen köptes.
purchaseDateTime	string		Det här är den tidpunkt då reservationen köptes.
quantity	integer		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 den reservation 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		Det här är den tidpunkt då Azure Hybrid-förmån behöver granskas.
skuDescription	string		Beskrivning av SKU:n på engelska.
splitProperties	ReservationSplitProperties		Egenskaper för reservationsdelning
swapProperties	ReservationSwapProperties		Egenskaper för reservationsväxling
term	ReservationTerm		Representerar 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

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

ReservationSwapProperties

Egenskaper för reservationsväxling

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

Representerar reservationsperioden.

Name	Typ	Description
P1Y	string
P3Y	string
P5Y	string

ReservationUtilizationAggregates

Aggregerade värden för reservationsanvändning

Name	Typ	Description
grain	number	Kornigheten för aggregeringen
grainUnit	string	Kornenheten för aggregeringen
value	number	Aggregeringsvärdet
valueUnit	string	Aggregerad värdeenhet

ReservedResourceProperties

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 för reserverad resurstyp för VirtualMachines.

ReservedResourceType

Typen av resurs som reserveras.

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

Namnet på sku

Name	Typ	Description
name	string

systemData

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

Name	Typ	Description
createdAt	string	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string	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

Reservationsanvändning

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