Reservation - Update

Service:

Reserved VM Instances

API Version:

2022-11-01

Frissítések.Reservation
Frissítések az alkalmazott hatóköröket.Reservation

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
reservationId	path	True	string	A foglalási elem azonosítója
reservationOrderId	path	True	string	A foglalás rendelésazonosítója
api-version	query	True	string	Támogatott verzió.

Kérelem törzse

Name	Típus	Description
properties.appliedScopeProperties	AppliedScopeProperties	Az alkalmazott hatókörtípusra jellemző tulajdonságok. Nem kötelező, ha nem alkalmazható. Kötelező, és meg kell adnia a tenantId és a managementGroupId azonosítót, ha az AppliedScopeType a ManagementGroup
properties.appliedScopeType	AppliedScopeType	Az Alkalmazott hatókör típusa.
properties.appliedScopes	string[]	Azoknak az előfizetéseknek a listája, amelyeket az előny alkalmaz. Ne adja meg, hogy az AppliedScopeType meg van-e osztva. Ez a tulajdonság elavult lesz, és az appliedScopeProperties helyett az AppliedScopeType lesz lecserélve.
properties.instanceFlexibility	InstanceFlexibility	Ha bekapcsolja ezt a beállítást, a foglalási kedvezményt az ugyanazon virtuálisgép-méretcsoportban lévő többi virtuális gépre alkalmazza. Csak a VirtualMachines fenntartott erőforrástípusát adja meg.
properties.name	string	A foglalás megjelenítendő neve
properties.renew	boolean	Ha ezt igaz értékre állítja, a rendszer automatikusan megvásárol egy új foglalást a lejárati dátumon.
properties.renewProperties	RenewProperties
properties.reviewDateTime	string	Ez az a dátum-idő, amikor felül kell vizsgálni az Azure hibrid előnyét.

Válaszok

Name	Típus	Description
200 OK	ReservationResponse	A frissített Reservationértéket adja vissza.
202 Accepted		A kérés elfogadásra kerül, és feldolgozás alatt áll Headers Azure-AsyncOperation: string Location: string Retry-After: integer
Other Status Codes	Error	Váratlan hiba

Példák

PatchReservation

Sample Request

HTTP

PATCH https://management.azure.com/providers/Microsoft.Capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/6ef59113-3482-40da-8d79-787f823e34bc?api-version=2022-11-01

{
  "properties": {
    "appliedScopeType": "Shared",
    "instanceFlexibility": "Off"
  }
}

Java

import com.azure.resourcemanager.reservations.models.AppliedScopeType;
import com.azure.resourcemanager.reservations.models.InstanceFlexibility;
import com.azure.resourcemanager.reservations.models.PatchModel;

/** Samples for Reservation Update. */
public final class Main {
    /*
     * x-ms-original-file: specification/reservations/resource-manager/Microsoft.Capacity/stable/2022-11-01/examples/UpdateReservation.json
     */
    /**
     * Sample code: PatchReservation.
     *
     * @param manager Entry point to ReservationsManager.
     */
    public static void patchReservation(com.azure.resourcemanager.reservations.ReservationsManager manager) {
        manager
            .reservations()
            .update(
                "276e7ae4-84d0-4da6-ab4b-d6b94f3557da",
                "6ef59113-3482-40da-8d79-787f823e34bc",
                new PatchModel()
                    .withAppliedScopeType(AppliedScopeType.SHARED)
                    .withInstanceFlexibility(InstanceFlexibility.OFF),
                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 update_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_update(
        reservation_order_id="276e7ae4-84d0-4da6-ab4b-d6b94f3557da",
        reservation_id="6ef59113-3482-40da-8d79-787f823e34bc",
        parameters={"properties": {"appliedScopeType": "Shared", "instanceFlexibility": "Off"}},
    ).result()
    print(response)


# x-ms-original-file: specification/reservations/resource-manager/Microsoft.Capacity/stable/2022-11-01/examples/UpdateReservation.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/UpdateReservation.json
func ExampleReservationClient_BeginUpdate() {
	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().BeginUpdate(ctx, "276e7ae4-84d0-4da6-ab4b-d6b94f3557da", "6ef59113-3482-40da-8d79-787f823e34bc", armreservations.Patch{
		Properties: &armreservations.PatchProperties{
			AppliedScopeType:    to.Ptr(armreservations.AppliedScopeTypeShared),
			InstanceFlexibility: to.Ptr(armreservations.InstanceFlexibilityOff),
		},
	}, 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.ReservationResponse = armreservations.ReservationResponse{
	// 	Name: to.Ptr("6ef59113-3482-40da-8d79-787f823e34bc"),
	// 	Type: to.Ptr("Microsoft.Capacity/reservationOrders/reservations"),
	// 	ID: to.Ptr("/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/6ef59113-3482-40da-8d79-787f823e34bc"),
	// 	Etag: to.Ptr[int32](4),
	// 	Location: to.Ptr("eastus"),
	// 	Properties: &armreservations.Properties{
	// 		AppliedScopeType: to.Ptr(armreservations.AppliedScopeTypeShared),
	// 		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-22T23:57:48.189Z"); 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-22T23:57:48.189Z"); return t}()),
	// 		InstanceFlexibility: to.Ptr(armreservations.InstanceFlexibilityOff),
	// 		LastUpdatedDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-09-22T23:57:54.376Z"); return t}()),
	// 		MergeProperties: &armreservations.ReservationMergeProperties{
	// 			MergeSources: []*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")},
	// 			},
	// 			ProvisioningState: to.Ptr(armreservations.ProvisioningStateSucceeded),
	// 			Quantity: to.Ptr[int32](3),
	// 			Renew: to.Ptr(false),
	// 			ReservedResourceType: to.Ptr(armreservations.ReservedResourceTypeVirtualMachines),
	// 			SKUDescription: to.Ptr("D1 v2"),
	// 		},
	// 		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 Updates the applied scopes of the `Reservation`.
 *
 * @summary Updates the applied scopes of the `Reservation`.
 * x-ms-original-file: specification/reservations/resource-manager/Microsoft.Capacity/stable/2022-11-01/examples/UpdateReservation.json
 */
async function patchReservation() {
  const reservationOrderId = "276e7ae4-84d0-4da6-ab4b-d6b94f3557da";
  const reservationId = "6ef59113-3482-40da-8d79-787f823e34bc";
  const parameters = {
    appliedScopeType: "Shared",
    instanceFlexibility: "Off",
  };
  const credential = new DefaultAzureCredential();
  const client = new AzureReservationAPI(credential);
  const result = await client.reservation.beginUpdateAndWait(
    reservationOrderId,
    reservationId,
    parameters
  );
  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/UpdateReservation.json
// this example is just showing the usage of "Reservation_Update" 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 ReservationDetailResource created on azure
// for more information of creating ReservationDetailResource, please refer to the document of ReservationDetailResource
Guid reservationOrderId = Guid.Parse("276e7ae4-84d0-4da6-ab4b-d6b94f3557da");
Guid reservationId = Guid.Parse("6ef59113-3482-40da-8d79-787f823e34bc");
ResourceIdentifier reservationDetailResourceId = ReservationDetailResource.CreateResourceIdentifier(reservationOrderId, reservationId);
ReservationDetailResource reservationDetail = client.GetReservationDetailResource(reservationDetailResourceId);

// invoke the operation
ReservationDetailPatch patch = new ReservationDetailPatch()
{
    AppliedScopeType = AppliedScopeType.Shared,
    InstanceFlexibility = InstanceFlexibility.Off,
};
ArmOperation<ReservationDetailResource> lro = await reservationDetail.UpdateAsync(WaitUntil.Completed, patch);
ReservationDetailResource 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
ReservationDetailData 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

Sample Response

Status code:

200

{
  "sku": {
    "name": "Standard_DS1_v2"
  },
  "id": "/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/6ef59113-3482-40da-8d79-787f823e34bc",
  "type": "Microsoft.Capacity/reservationOrders/reservations",
  "name": "6ef59113-3482-40da-8d79-787f823e34bc",
  "etag": 4,
  "location": "eastus",
  "properties": {
    "appliedScopeType": "Shared",
    "renew": false,
    "billingScopeId": "/subscriptions/19376483-64b8-49e4-a931-d5248828720a",
    "quantity": 3,
    "provisioningState": "Succeeded",
    "expiryDate": "2018-09-22",
    "expiryDateTime": "2018-09-22T23:57:48.1891638Z",
    "displayName": "cabri_test",
    "billingPlan": "Monthly",
    "effectiveDateTime": "2017-09-22T23:57:48.1891638Z",
    "lastUpdatedDateTime": "2017-09-22T23:57:54.3768768Z",
    "reservedResourceType": "VirtualMachines",
    "instanceFlexibility": "Off",
    "skuDescription": "D1 v2",
    "mergeProperties": {
      "mergeSources": [
        "/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"
      ]
    }
  }
}

Status code:

202

Azure-AsyncOperation: https://management.azure.com/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/6ef59113-3482-40da-8d79-787f823e34bc?api-version=2022-11-01
Location: https://management.azure.com/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/6ef59113-3482-40da-8d79-787f823e34bc?api-version=2022-11-01
Retry-After: 120

Definíciók

Name	Description
AppliedScopeProperties	Az alkalmazott hatókörtípusra jellemző tulajdonságok. Nem kötelező, ha nem alkalmazható. Kötelező, és meg kell adnia a tenantId és a managementGroupId azonosítót, ha az AppliedScopeType a ManagementGroup
AppliedScopeType	Az Alkalmazott hatókör típusa.
BillingCurrencyTotal	A megújítási vásárlásért az ügyfél helyi pénznemében felszámított pénznem és összeg. Az adó nem tartalmazza az adót.
createdByType	Az erőforrást létrehozó identitás típusa.
Error	Hibainformációk
ErrorResponseCode	Hibakód, amely leírja, hogy a szolgáltatás miért nem tudja feldolgozni a bejövő kérést
ExtendedErrorInfo	Bővített hibainformációk, beleértve a hibakódot és a hibaüzenetet
ExtendedStatusInfo
InstanceFlexibility	Ha bekapcsolja ezt a beállítást, a foglalási kedvezményt az ugyanazon virtuálisgép-méretcsoportban lévő többi virtuális gépre alkalmazza. Csak a VirtualMachines fenntartott erőforrástípusát adja meg.
Kind	Fenntartott erőforrás-szolgáltató típusa.
Patch	A foglalási javítás kérése
PricingCurrencyTotal	A Microsoft által a rekordhoz használt mennyiség. A visszatérítés során a visszatérítési korlát kiszámításához használatos. Az adó nem tartalmazza az adót. Ez 30 nappal a lejárat előtt zárolt ár.
ProvisioningState	A Foglalás aktuális állapotát jelöli.
PurchaseRequest	Foglalásvásárlási kérelem
RenewProperties
RenewPropertiesResponse	A foglalás megújítási tulajdonságai.
ReservationBillingPlan	A számlázási csomagok ábrázolása.
ReservationMergeProperties	A foglalások egyesítésének tulajdonságai
ReservationResponse	A foglalás definíciója.
ReservationSplitProperties	Foglalás felosztásának tulajdonságai
ReservationsProperties	A foglalások tulajdonságai
ReservationStatusCode
ReservationSwapProperties	A foglalás felcserélésének tulajdonságai
ReservationTerm	A foglalás időtartamát jelöli.
ReservationUtilizationAggregates	A foglalás kihasználtságának összesített értékei
ReservedResourceProperties	Az egyes fenntartott erőforrástípusokra jellemző tulajdonságok. Nem kötelező, ha nem alkalmazható.
ReservedResourceType	A lefoglalt erőforrás típusa.
SkuName	A termékváltozat neve
systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.
Utilization	Foglalás kihasználtsága

AppliedScopeProperties

Az alkalmazott hatókörtípusra jellemző tulajdonságok. Nem kötelező, ha nem alkalmazható. Kötelező, és meg kell adnia a tenantId és a managementGroupId azonosítót, ha az AppliedScopeType a ManagementGroup

Name	Típus	Description
displayName	string	Megjelenített név
managementGroupId	string	Annak a felügyeleti csoportnak a teljes azonosítója, ahol a kedvezményt alkalmazni kell.
resourceGroupId	string	Az erőforráscsoport teljes azonosítója.
subscriptionId	string	Az előfizetés teljes azonosítója.
tenantId	string	Bérlőazonosító, ahol a megtakarítási csomagnak előnyösnek kell lennie.

AppliedScopeType

Az Alkalmazott hatókör típusa.

Name	Típus	Description
ManagementGroup	string
Shared	string
Single	string

BillingCurrencyTotal

A megújítási vásárlásért az ügyfél helyi pénznemében felszámított pénznem és összeg. Az adó nem tartalmazza az adót.

Name	Típus	Description
amount	number
currencyCode	string	Az iso 4217 3 betűs pénznemkód a vásárlási rekord által használt pénznemhez.

createdByType

Az erőforrást létrehozó identitás típusa.

Name	Típus	Description
Application	string
Key	string
ManagedIdentity	string
User	string

Error

Hibainformációk

Name	Típus	Description
error	ExtendedErrorInfo	Bővített hibainformációk, beleértve a hibakódot és a hibaüzenetet

ErrorResponseCode

Hibakód, amely leírja, hogy a szolgáltatás miért nem tudja feldolgozni a bejövő kérést

Name	Típus	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

Bővített hibainformációk, beleértve a hibakódot és a hibaüzenetet

Name	Típus	Description
code	ErrorResponseCode	Hibakód, amely leírja, hogy a szolgáltatás miért nem tudja feldolgozni a bejövő kérést
message	string

ExtendedStatusInfo

Name	Típus	Description
message	string	Az állapotkódra vonatkozó részletes információkat tartalmazó üzenet.
statusCode	ReservationStatusCode

InstanceFlexibility

Ha bekapcsolja ezt a beállítást, a foglalási kedvezményt az ugyanazon virtuálisgép-méretcsoportban lévő többi virtuális gépre alkalmazza. Csak a VirtualMachines fenntartott erőforrástípusát adja meg.

Name	Típus	Description
Off	string
On	string

Kind

Fenntartott erőforrás-szolgáltató típusa.

Name	Típus	Description
Microsoft.Compute	string

Patch

A foglalási javítás kérése

Name	Típus	Alapértelmezett érték	Description
properties.appliedScopeProperties	AppliedScopeProperties		Az alkalmazott hatókörtípusra jellemző tulajdonságok. Nem kötelező, ha nem alkalmazható. Kötelező, és meg kell adnia a tenantId és a managementGroupId azonosítót, ha az AppliedScopeType a ManagementGroup
properties.appliedScopeType	AppliedScopeType		Az Alkalmazott hatókör típusa.
properties.appliedScopes	string[]		Azoknak az előfizetéseknek a listája, amelyeket az előny alkalmaz. Ne adja meg, hogy az AppliedScopeType meg van-e osztva. Ez a tulajdonság elavult lesz, és az appliedScopeProperties helyett az AppliedScopeType lesz lecserélve.
properties.instanceFlexibility	InstanceFlexibility		Ha bekapcsolja ezt a beállítást, a foglalási kedvezményt az ugyanazon virtuálisgép-méretcsoportban lévő többi virtuális gépre alkalmazza. Csak a VirtualMachines fenntartott erőforrástípusát adja meg.
properties.name	string		A foglalás megjelenítendő neve
properties.renew	boolean	False	Ha ezt igaz értékre állítja, a rendszer automatikusan megvásárol egy új foglalást a lejárati dátumon.
properties.renewProperties	RenewProperties
properties.reviewDateTime	string		Ez az a dátum-idő, amikor felül kell vizsgálni az Azure hibrid előnyét.

PricingCurrencyTotal

A Microsoft által a rekordhoz használt mennyiség. A visszatérítés során a visszatérítési korlát kiszámításához használatos. Az adó nem tartalmazza az adót. Ez 30 nappal a lejárat előtt zárolt ár.

Name	Típus	Description
amount	number
currencyCode	string	Az iso 4217 3 betűs pénznemkód a vásárlási rekord által használt pénznemhez.

ProvisioningState

A Foglalás aktuális állapotát jelöli.

Name	Típus	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

Foglalásvásárlási kérelem

Name	Típus	Alapértelmezett érték	Description
location	string		Az Azure-régió, ahol a fenntartott erőforrás található.
properties.appliedScopeProperties	AppliedScopeProperties		Az alkalmazott hatókörtípusra jellemző tulajdonságok. Nem kötelező, ha nem alkalmazható. Kötelező, és meg kell adnia a tenantId és a managementGroupId azonosítót, ha az AppliedScopeType a ManagementGroup
properties.appliedScopeType	AppliedScopeType		Az Alkalmazott hatókör típusa.
properties.appliedScopes	string[]		Azoknak az előfizetéseknek a listája, amelyeket az előny alkalmaz. Ne adja meg, hogy az AppliedScopeType meg van-e osztva. Ez a tulajdonság elavult lesz, és az appliedScopeProperties helyett az AppliedScopeType lesz lecserélve.
properties.billingPlan	ReservationBillingPlan		A számlázási csomagok ábrázolása.
properties.billingScopeId	string		Foglalás vagy megtakarítási csomag megvásárlásáért felszámított előfizetés
properties.displayName	string		A foglalás rövid neve
properties.quantity	integer		A foglalás részét képező termékváltozatok mennyisége.
properties.renew	boolean	False	Ha ezt igaz értékre állítja, a rendszer automatikusan megvásárol egy új foglalást a lejárati dátumon.
properties.reservedResourceProperties	ReservedResourceProperties		Az egyes fenntartott erőforrástípusokra jellemző tulajdonságok. Nem kötelező, ha nem alkalmazható.
properties.reservedResourceType	ReservedResourceType		A lefoglalt erőforrás típusa.
properties.reviewDateTime	string		Ez az a dátum-idő, amikor felül kell vizsgálni az Azure hibrid előnyét.
properties.term	ReservationTerm		A foglalás időtartamát jelöli.
sku	SkuName		A termékváltozat neve

RenewProperties

Name	Típus	Description
purchaseProperties	PurchaseRequest	Foglalásvásárlási kérelem

RenewPropertiesResponse

A foglalás megújítási tulajdonságai.

Name	Típus	Description
billingCurrencyTotal	BillingCurrencyTotal	A megújítási vásárlásért az ügyfél helyi pénznemében felszámított pénznem és összeg. Az adó nem tartalmazza az adót.
pricingCurrencyTotal	PricingCurrencyTotal	A Microsoft által a rekordhoz használt mennyiség. A visszatérítés során a visszatérítési korlát kiszámításához használatos. Az adó nem tartalmazza az adót. Ez 30 nappal a lejárat előtt zárolt ár.
purchaseProperties	PurchaseRequest	Foglalásvásárlási kérelem

ReservationBillingPlan

A számlázási csomagok ábrázolása.

Name	Típus	Description
Monthly	string
Upfront	string

ReservationMergeProperties

A foglalások egyesítésének tulajdonságai

Name	Típus	Description
mergeDestination	string	Foglalási erőforrás azonosítója Létrehozva az egyesítés miatt. Az erőforrás-azonosító formátuma : /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}
mergeSources	string[]	A forrásfoglalás egyesített erőforrás-azonosítói a foglalás létrehozásához. Az erőforrás-azonosító formátuma : /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}

ReservationResponse

A foglalás definíciója.

Name	Típus	Description
etag	integer
id	string	Az erőforrás teljes erőforrás-azonosítója. Például: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind	Kind	Fenntartott erőforrás-szolgáltató típusa.
location	string	Az Azure-régió, ahol a fenntartott erőforrás található.
name	string	Az erőforrás neve
properties	ReservationsProperties	A foglaláshoz társított tulajdonságok
sku	SkuName	A foglaláshoz társított termékváltozat-információk
systemData	systemData	Az Azure Resource Manager createdBy és modifiedBy adatokat tartalmazó metaadatok.
type	string	Az erőforrás típusa. Például "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

ReservationSplitProperties

Foglalás felosztásának tulajdonságai

Name	Típus	Description
splitDestinations	string[]	A felosztás miatt létrehozott célerőforrás-azonosítók listája. Az erőforrás-azonosító formátuma : /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}
splitSource	string	Annak a foglalásnak az erőforrás-azonosítója, amelyből ez fel van osztva. Az erőforrás-azonosító formátuma : /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}

ReservationsProperties

A foglalások tulajdonságai

Name	Típus	Alapértelmezett érték	Description
appliedScopeProperties	AppliedScopeProperties		Az alkalmazott hatókörtípusra jellemző tulajdonságok. Nem kötelező, ha nem alkalmazható. Kötelező, és meg kell adnia a tenantId és a managementGroupId azonosítót, ha az AppliedScopeType a ManagementGroup
appliedScopeType	AppliedScopeType		Az alkalmazott hatókör típusa
appliedScopes	string[]		Az alkalmazott hatókörök listája
archived	boolean		Azt jelzi, hogy a foglalás archiválva van-e
benefitStartTime	string		Ez az a DateTime időpont, amikor a foglalási előny elindult.
billingPlan	ReservationBillingPlan		A termékváltozathoz elérhető számlázási csomag beállításai.
billingScopeId	string		Foglalás vagy megtakarítási csomag megvásárlásáért felszámított előfizetés
capabilities	string		A foglalás képességei
displayName	string		A felhasználó rövid neve a foglalás egyszerű azonosításához
displayProvisioningState	string		A foglalás kiépítési állapota megjelenítésre, pl. Sikeres
effectiveDateTime	string		A foglalás DateTime időpontja, amikor ez a verzió érvényes.
expiryDate	string		Ez az a dátum, amikor a foglalás lejár.
expiryDateTime	string		Ez az a dátum-idő, amikor a foglalás lejár.
extendedStatusInfo	ExtendedStatusInfo		Az állapotkódra vonatkozó részletes információkat tartalmazó üzenet.
instanceFlexibility	InstanceFlexibility		Lehetővé teszi, hogy a foglalási kedvezmény ugyanazon az automatikus illesztéscsoporton belül a termékváltozatok között legyen alkalmazva. Nem minden termékváltozat támogatja a példányméret rugalmasságát.
lastUpdatedDateTime	string		A foglalás legutóbbi frissítésének dateTime időpontja.
mergeProperties	ReservationMergeProperties		A foglalások egyesítésének tulajdonságai
provisioningState	ProvisioningState		A foglalás aktuális állapota.
provisioningSubState	string		A foglalás kiépítési alállapota, pl. Sikeres
purchaseDate	string		Ez a foglalás megvásárlásának dátuma.
purchaseDateTime	string		Ez a foglalás megvásárlásának dátuma.
quantity	integer		A foglalás részét képező termékváltozatok mennyisége.
renew	boolean	False	Ha ezt igaz értékre állítja, a rendszer automatikusan megvásárol egy új foglalást a lejárati dátumon.
renewDestination	string		A megújítás miatt vásárolt foglalás foglalásazonosítója. Az erőforrás-azonosító formátuma a /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}.
renewProperties	RenewPropertiesResponse		A foglalás megújítási tulajdonságai.
renewSource	string		Annak a foglalásnak a foglalása, amelyből a foglalás megújult. Az erőforrás-azonosító formátuma a /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}.
reservedResourceType	ReservedResourceType		A lefoglalt erőforrás típusa.
reviewDateTime	string		Ez az a dátum-idő, amikor a Azure Hybrid Benefit felül kell vizsgálni.
skuDescription	string		A termékváltozat leírása angol nyelven.
splitProperties	ReservationSplitProperties		Foglalás felosztásának tulajdonságai
swapProperties	ReservationSwapProperties		A foglalás felcserélésének tulajdonságai
term	ReservationTerm		A foglalás időtartamát jelöli.
userFriendlyAppliedScopeType	string		A megjelenítésre szolgáló foglalás alkalmazott hatókörtípusa, például megosztott
userFriendlyRenewState	string		A foglalás megújítási állapota megjelenítésre, pl. Be
utilization	Utilization		Foglalás kihasználtsága

ReservationStatusCode

Name	Típus	Description
Active	string
Expired	string
Merged	string
None	string
PaymentInstrumentError	string
Pending	string
Processing	string
PurchaseError	string
Split	string
Succeeded	string

ReservationSwapProperties

A foglalás felcserélésének tulajdonságai

Name	Típus	Description
swapDestination	string	Foglalási erőforrás azonosítója, amellyel az eredeti erőforrás felcserélve lesz. Az erőforrás-azonosító formátuma : /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}
swapSource	string	A felcserélt forrásfoglalás erőforrás-azonosítója. Az erőforrás-azonosító formátuma : /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}

ReservationTerm

A foglalás időtartamát jelöli.

Name	Típus	Description
P1Y	string
P3Y	string
P5Y	string

ReservationUtilizationAggregates

A foglalás kihasználtságának összesített értékei

Name	Típus	Description
grain	number	Az aggregátum szemcséje
grainUnit	string	Az aggregátum gabonaegysége
value	number	Az összesített érték
valueUnit	string	Az összesített értékegység

ReservedResourceProperties

Az egyes fenntartott erőforrástípusokra jellemző tulajdonságok. Nem kötelező, ha nem alkalmazható.

Name	Típus	Description
instanceFlexibility	InstanceFlexibility	Ha bekapcsolja ezt a beállítást, a foglalási kedvezményt az ugyanazon virtuálisgép-méretcsoportban lévő többi virtuális gépre alkalmazza. Csak a VirtualMachines fenntartott erőforrástípusát adja meg.

ReservedResourceType

A lefoglalt erőforrás típusa.

Name	Típus	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

A termékváltozat neve

Name	Típus	Description
name	string

systemData

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name	Típus	Description
createdAt	string	Az erőforrás-létrehozás időbélyege (UTC).
createdBy	string	Az erőforrást létrehozó identitás.
createdByType	createdByType	Az erőforrást létrehozó identitás típusa.
lastModifiedAt	string	Az erőforrás utolsó módosításának időbélyege (UTC)
lastModifiedBy	string	Az az identitás, amely legutóbb módosította az erőforrást.
lastModifiedByType	createdByType	Az erőforrást legutóbb módosító identitás típusa.

Utilization

Foglalás kihasználtsága

Name	Típus	Description
aggregates	ReservationUtilizationAggregates[]	A foglalás kihasználtságának összesítéseinek tömbje
trend	string	foglalás legutóbbi 7 napos kihasználtsági trendje