Reservation - Update

Service:

Reserved VM Instances

API Version:

2022-11-01

Aktualizacje .Reservation
Aktualizacje zastosowanych zakresów obiektu Reservation.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
reservationId	path	True	string	Identyfikator elementu rezerwacji
reservationOrderId	path	True	string	Identyfikator zamówienia rezerwacji
api-version	query	True	string	Obsługiwana wersja.

Treść żądania

Nazwa	Typ	Opis
properties.appliedScopeProperties	AppliedScopeProperties	Właściwości specyficzne dla zastosowanego typu zakresu. Nie jest wymagane, jeśli nie ma zastosowania. Wymagane i należy podać identyfikator tenantId i managementGroupId, jeśli AppliedScopeType jest ManagementGroup
properties.appliedScopeType	AppliedScopeType	Typ zastosowanego zakresu.
properties.appliedScopes	string[]	Lista subskrypcji, dla których zostanie zastosowana korzyść. Nie należy określać, czy parametr AppliedScopeType jest udostępniony. Ta właściwość będzie przestarzała i zastąpiona przez appliedScopeProperties zamiast elementu Single AppliedScopeType.
properties.instanceFlexibility	InstanceFlexibility	Włączenie tej opcji spowoduje zastosowanie rabatu za rezerwację do innych maszyn wirtualnych w tej samej grupie rozmiarów maszyn wirtualnych. Określ tylko typ zasobu zarezerwowanego virtualmachines.
properties.name	string	Nazwa wyświetlana rezerwacji
properties.renew	boolean	Ustawienie wartości true spowoduje automatyczne zakup nowej rezerwacji w dniu wygaśnięcia.
properties.renewProperties	RenewProperties
properties.reviewDateTime	string	Jest to data i godzina przeglądu korzyści użycia hybrydowego platformy Azure.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ReservationResponse	Zwraca zaktualizowany Reservationelement .
202 Accepted		Żądanie jest akceptowane i przetwarzane Headers Azure-AsyncOperation: string Location: string Retry-After: integer
Other Status Codes	Error	Nieoczekiwany błąd

Przykłady

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

Definicje

Nazwa	Opis
AppliedScopeProperties	Właściwości specyficzne dla zastosowanego typu zakresu. Nie jest wymagane, jeśli nie ma zastosowania. Wymagane i należy podać identyfikator tenantId i managementGroupId, jeśli AppliedScopeType to ManagementGroup
AppliedScopeType	Typ zastosowanego zakresu.
BillingCurrencyTotal	Waluta i kwota, jaką klient będzie pobierał w lokalnej walucie klienta w celu zakupu odnowienia. Podatek nie jest uwzględniany.
createdByType	Typ tożsamości, która utworzyła zasób.
Error	Informacje o błędzie
ErrorResponseCode	Kod błędu opisujący przyczynę, dla którego usługa nie może przetworzyć żądania przychodzącego
ExtendedErrorInfo	Rozszerzone informacje o błędzie, w tym kod błędu i komunikat o błędzie
ExtendedStatusInfo
InstanceFlexibility	Włączenie tej opcji spowoduje zastosowanie rabatu za rezerwację do innych maszyn wirtualnych w tej samej grupie rozmiarów maszyn wirtualnych. Określ tylko typ zasobu zarezerwowanego virtualmachines.
Kind	Typ dostawcy zasobów, który ma być zarezerwowany.
Patch	Żądanie poprawki rezerwacji
PricingCurrencyTotal	Kwota używana przez firmę Microsoft dla rekordu. Używany podczas obliczania limitu zwrotu kosztów. Podatek nie jest uwzględniany. Jest to zablokowana cena 30 dni przed wygaśnięciem.
ProvisioningState	Reprezentuje bieżący stan rezerwacji.
PurchaseRequest	Żądanie zakupu rezerwacji
RenewProperties
RenewPropertiesResponse	Właściwości odnawiania rezerwacji.
ReservationBillingPlan	Przedstawianie planów rozliczeniowych.
ReservationMergeProperties	Właściwości scalania rezerwacji
ReservationResponse	Definicja rezerwacji.
ReservationSplitProperties	Właściwości podziału rezerwacji
ReservationsProperties	Właściwości rezerwacji
ReservationStatusCode
ReservationSwapProperties	Właściwości zamiany rezerwacji
ReservationTerm	Reprezentuje okres rezerwacji.
ReservationUtilizationAggregates	Zagregowane wartości wykorzystania rezerwacji
ReservedResourceProperties	Właściwości specyficzne dla każdego typu zasobu zarezerwowanego. Nie jest wymagane, jeśli nie ma zastosowania.
ReservedResourceType	Typ zasobu, który jest zarezerwowany.
SkuName	Nazwa jednostki SKU
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
Utilization	Wykorzystanie rezerwacji

AppliedScopeProperties

Właściwości specyficzne dla zastosowanego typu zakresu. Nie jest wymagane, jeśli nie ma zastosowania. Wymagane i należy podać identyfikator tenantId i managementGroupId, jeśli AppliedScopeType to ManagementGroup

Nazwa	Typ	Opis
displayName	string	Nazwa wyświetlana
managementGroupId	string	W pełni kwalifikowany identyfikator grupy zarządzania, w której należy zastosować korzyść.
resourceGroupId	string	W pełni kwalifikowany identyfikator grupy zasobów.
subscriptionId	string	W pełni kwalifikowany identyfikator subskrypcji.
tenantId	string	Identyfikator dzierżawy, w którym plan oszczędności powinien mieć zastosowanie.

AppliedScopeType

Typ zastosowanego zakresu.

Nazwa	Typ	Opis
ManagementGroup	string
Shared	string
Single	string

BillingCurrencyTotal

Waluta i kwota, jaką klient będzie pobierał w lokalnej walucie klienta w celu zakupu odnowienia. Podatek nie jest uwzględniany.

Nazwa	Typ	Opis
amount	number
currencyCode	string	Kod waluty ISO 4217 3-literowy dla waluty używanej przez ten rekord zakupu.

createdByType

Typ tożsamości, która utworzyła zasób.

Nazwa	Typ	Opis
Application	string
Key	string
ManagedIdentity	string
User	string

Error

Informacje o błędzie

Nazwa	Typ	Opis
error	ExtendedErrorInfo	Rozszerzone informacje o błędzie, w tym kod błędu i komunikat o błędzie

ErrorResponseCode

Kod błędu opisujący przyczynę, dla którego usługa nie może przetworzyć żądania przychodzącego

Nazwa	Typ	Opis
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

Rozszerzone informacje o błędzie, w tym kod błędu i komunikat o błędzie

Nazwa	Typ	Opis
code	ErrorResponseCode	Kod błędu opisujący przyczynę, dla którego usługa nie może przetworzyć żądania przychodzącego
message	string

ExtendedStatusInfo

Nazwa	Typ	Opis
message	string	Komunikat zawierający szczegółowe informacje o kodzie stanu.
statusCode	ReservationStatusCode

InstanceFlexibility

Włączenie tej opcji spowoduje zastosowanie rabatu za rezerwację do innych maszyn wirtualnych w tej samej grupie rozmiarów maszyn wirtualnych. Określ tylko typ zasobu zarezerwowanego virtualmachines.

Nazwa	Typ	Opis
Off	string
On	string

Kind

Typ dostawcy zasobów, który ma być zarezerwowany.

Nazwa	Typ	Opis
Microsoft.Compute	string

Patch

Żądanie poprawki rezerwacji

Nazwa	Typ	Wartość domyślna	Opis
properties.appliedScopeProperties	AppliedScopeProperties		Właściwości specyficzne dla zastosowanego typu zakresu. Nie jest wymagane, jeśli nie ma zastosowania. Wymagane i należy podać identyfikator tenantId i managementGroupId, jeśli AppliedScopeType to ManagementGroup
properties.appliedScopeType	AppliedScopeType		Typ zastosowanego zakresu.
properties.appliedScopes	string[]		Lista subskrypcji, które będą stosowane dla korzyści. Nie należy określać, czy parametr AppliedScopeType jest udostępniony. Ta właściwość zostanie wycofana i zastąpiona przez appliedScopeProperties zamiast elementu Single AppliedScopeType.
properties.instanceFlexibility	InstanceFlexibility		Włączenie tej opcji spowoduje zastosowanie rabatu za rezerwację do innych maszyn wirtualnych w tej samej grupie rozmiarów maszyn wirtualnych. Określ tylko typ zasobu zarezerwowanego VirtualMachines.
properties.name	string		Nazwa wyświetlana rezerwacji
properties.renew	boolean	False	Ustawienie wartości true spowoduje automatyczne zakup nowej rezerwacji o dacie wygaśnięcia.
properties.renewProperties	RenewProperties
properties.reviewDateTime	string		Jest to data-godzina przeglądu korzyści użycia hybrydowego platformy Azure.

PricingCurrencyTotal

Kwota używana przez firmę Microsoft dla rekordu. Używany podczas obliczania limitu zwrotu kosztów. Podatek nie jest uwzględniany. Jest to zablokowana cena 30 dni przed wygaśnięciem.

Nazwa	Typ	Opis
amount	number
currencyCode	string	Kod waluty ISO 4217 3-literowy dla waluty używanej przez ten rekord zakupu.

ProvisioningState

Reprezentuje bieżący stan rezerwacji.

Nazwa	Typ	Opis
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

Żądanie zakupu rezerwacji

Nazwa	Typ	Wartość domyślna	Opis
location	string		Region świadczenia usługi Azure, w którym znajduje się zasób zarezerwowany.
properties.appliedScopeProperties	AppliedScopeProperties		Właściwości specyficzne dla zastosowanego typu zakresu. Nie jest wymagane, jeśli nie ma zastosowania. Wymagane i należy podać identyfikator tenantId i managementGroupId, jeśli AppliedScopeType to ManagementGroup
properties.appliedScopeType	AppliedScopeType		Typ zastosowanego zakresu.
properties.appliedScopes	string[]		Lista subskrypcji, które będą stosowane dla korzyści. Nie należy określać, czy parametr AppliedScopeType jest udostępniony. Ta właściwość zostanie wycofana i zastąpiona przez appliedScopeProperties zamiast elementu Single AppliedScopeType.
properties.billingPlan	ReservationBillingPlan		Przedstawianie planów rozliczeniowych.
properties.billingScopeId	string		Subskrypcja, która zostanie naliczona za zakup rezerwacji lub planu oszczędnościowego
properties.displayName	string		Przyjazna nazwa rezerwacji
properties.quantity	integer		Ilość jednostek SKU, które są częścią rezerwacji.
properties.renew	boolean	False	Ustawienie wartości true spowoduje automatyczne zakup nowej rezerwacji o dacie wygaśnięcia.
properties.reservedResourceProperties	ReservedResourceProperties		Właściwości specyficzne dla każdego typu zasobu zarezerwowanego. Nie jest wymagane, jeśli nie ma zastosowania.
properties.reservedResourceType	ReservedResourceType		Typ zasobu, który jest zarezerwowany.
properties.reviewDateTime	string		Jest to data-godzina przeglądu korzyści użycia hybrydowego platformy Azure.
properties.term	ReservationTerm		Przedstawia termin rezerwacji.
sku	SkuName		Nazwa jednostki SKU

RenewProperties

Nazwa	Typ	Opis
purchaseProperties	PurchaseRequest	Żądanie zakupu rezerwacji

RenewPropertiesResponse

Właściwości odnawiania rezerwacji.

Nazwa	Typ	Opis
billingCurrencyTotal	BillingCurrencyTotal	Waluta i kwota, jaką klient będzie pobierał w lokalnej walucie klienta w celu zakupu odnowienia. Podatek nie jest uwzględniany.
pricingCurrencyTotal	PricingCurrencyTotal	Kwota używana przez firmę Microsoft dla rekordu. Używany podczas obliczania limitu zwrotu kosztów. Podatek nie jest uwzględniany. Jest to zablokowana cena 30 dni przed wygaśnięciem.
purchaseProperties	PurchaseRequest	Żądanie zakupu rezerwacji

ReservationBillingPlan

Przedstawianie planów rozliczeniowych.

Nazwa	Typ	Opis
Monthly	string
Upfront	string

ReservationMergeProperties

Właściwości scalania rezerwacji

Nazwa	Typ	Opis
mergeDestination	string	Identyfikator zasobu rezerwacji Utworzony z powodu scalania. Format identyfikatora zasobu to /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}
mergeSources	string[]	Identyfikatory zasobów scalonej rezerwacji źródłowej w celu utworzenia tej rezerwacji. Format identyfikatora zasobu to /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}

ReservationResponse

Definicja rezerwacji.

Nazwa	Typ	Opis
etag	integer
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu. Np. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind	Kind	Typ dostawcy zasobów, który ma być zarezerwowany.
location	string	Region świadczenia usługi Azure, w którym znajduje się zasób zarezerwowany.
name	string	Nazwa zasobu
properties	ReservationsProperties	Właściwości skojarzone z tą rezerwacją
sku	SkuName	Informacje o jednostce SKU skojarzone z tą rezerwacją
systemData	systemData	Metadane usługi Azure Resource Manager zawierające informacje createdBy i modifiedBy.
type	string	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

ReservationSplitProperties

Właściwości podziału rezerwacji

Nazwa	Typ	Opis
splitDestinations	string[]	Lista identyfikatorów zasobów docelowych, które zostały utworzone z powodu podziału. Format identyfikatora zasobu to /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}
splitSource	string	Identyfikator zasobu rezerwacji, z której jest on podzielony. Format identyfikatora zasobu to /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}

ReservationsProperties

Właściwości rezerwacji

Nazwa	Typ	Wartość domyślna	Opis
appliedScopeProperties	AppliedScopeProperties		Właściwości specyficzne dla zastosowanego typu zakresu. Nie jest wymagane, jeśli nie ma zastosowania. Wymagane i należy podać identyfikator tenantId i managementGroupId, jeśli AppliedScopeType to ManagementGroup
appliedScopeType	AppliedScopeType		Zastosowany typ zakresu
appliedScopes	string[]		Lista zastosowanych zakresów
archived	boolean		Wskazuje, czy rezerwacja jest zarchiwizowane
benefitStartTime	string		Jest to data/godzina rozpoczęcia świadczenia rezerwacji.
billingPlan	ReservationBillingPlan		Opcje planu rozliczeniowego dostępne dla tej jednostki SKU.
billingScopeId	string		Subskrypcja, która zostanie naliczona za zakup rezerwacji lub planu oszczędnościowego
capabilities	string		Możliwości rezerwacji
displayName	string		Przyjazna nazwa użytkownika do łatwego identyfikowania rezerwacji
displayProvisioningState	string		Stan aprowizacji rezerwacji na potrzeby wyświetlania, np. Powodzenie
effectiveDateTime	string		Data/godzina rezerwacji rozpoczynająca się od tej wersji.
expiryDate	string		Jest to data wygaśnięcia rezerwacji.
expiryDateTime	string		Jest to data wygaśnięcia rezerwacji.
extendedStatusInfo	ExtendedStatusInfo		Komunikat zawierający szczegółowe informacje o kodzie stanu.
instanceFlexibility	InstanceFlexibility		Umożliwia zastosowanie rabatu za rezerwację między jednostkami SKU w ramach tej samej grupy dopasowania automatycznego. Nie wszystkie jednostki SKU obsługują elastyczność rozmiaru wystąpienia.
lastUpdatedDateTime	string		Data/godzina ostatniej aktualizacji rezerwacji.
mergeProperties	ReservationMergeProperties		Właściwości scalania rezerwacji
provisioningState	ProvisioningState		Bieżący stan rezerwacji.
provisioningSubState	string		Stan podrzędny aprowizacji rezerwacji, np. Powodzenie
purchaseDate	string		Jest to data zakupu rezerwacji.
purchaseDateTime	string		Jest to data zakupu rezerwacji.
quantity	integer		Ilość jednostek SKU, które są częścią rezerwacji.
renew	boolean	False	Ustawienie wartości true spowoduje automatyczne zakup nowej rezerwacji o dacie wygaśnięcia.
renewDestination	string		Identyfikator rezerwacji zakupionej z powodu odnowienia. Format identyfikatora zasobu to /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}.
renewProperties	RenewPropertiesResponse		Właściwości odnawiania rezerwacji.
renewSource	string		Identyfikator rezerwacji, z której ta rezerwacja jest odnawiana. Format identyfikatora zasobu to /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}.
reservedResourceType	ReservedResourceType		Typ zasobu, który jest zarezerwowany.
reviewDateTime	string		Jest to data przeglądu Korzyść użycia hybrydowego platformy Azure.
skuDescription	string		Opis jednostki SKU w języku angielskim.
splitProperties	ReservationSplitProperties		Właściwości podziału rezerwacji
swapProperties	ReservationSwapProperties		Właściwości zamiany rezerwacji
term	ReservationTerm		Przedstawia termin rezerwacji.
userFriendlyAppliedScopeType	string		Zastosowany typ zakresu rezerwacji do wyświetlenia, np. udostępniony
userFriendlyRenewState	string		Stan odnowienia rezerwacji do wyświetlenia, np. wł.
utilization	Utilization		Wykorzystanie rezerwacji

ReservationStatusCode

Nazwa	Typ	Opis
Active	string
Expired	string
Merged	string
None	string
PaymentInstrumentError	string
Pending	string
Processing	string
PurchaseError	string
Split	string
Succeeded	string

ReservationSwapProperties

Właściwości zamiany rezerwacji

Nazwa	Typ	Opis
swapDestination	string	Identyfikator zasobu rezerwacji, do którego zostaje zamieniony oryginalny zasób. Format identyfikatora zasobu to /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}
swapSource	string	Identyfikator zasobu źródłowej rezerwacji, która zostaje zamieniona. Format identyfikatora zasobu to /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}

ReservationTerm

Reprezentuje okres rezerwacji.

Nazwa	Typ	Opis
P1Y	string
P3Y	string
P5Y	string

ReservationUtilizationAggregates

Zagregowane wartości wykorzystania rezerwacji

Nazwa	Typ	Opis
grain	number	Ziarno agregacji
grainUnit	string	Jednostka ziarna agregacji
value	number	Wartość agregacji
valueUnit	string	Jednostka wartości zagregowanej

ReservedResourceProperties

Właściwości specyficzne dla każdego typu zasobu zarezerwowanego. Nie jest wymagane, jeśli nie ma zastosowania.

Nazwa	Typ	Opis
instanceFlexibility	InstanceFlexibility	Włączenie tej opcji spowoduje zastosowanie rabatu za rezerwację do innych maszyn wirtualnych w tej samej grupie rozmiarów maszyn wirtualnych. Określ tylko typ zasobu zarezerwowanego virtualmachines.

ReservedResourceType

Typ zasobu, który jest zarezerwowany.

Nazwa	Typ	Opis
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

Nazwa jednostki SKU

Nazwa	Typ	Opis
name	string

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string	Sygnatura czasowa tworzenia zasobów (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string	Sygnatura czasowa ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.

Utilization

Wykorzystanie rezerwacji

Nazwa	Typ	Opis
aggregates	ReservationUtilizationAggregates[]	Tablica agregacji wykorzystania rezerwacji
trend	string	trend wykorzystania rezerwacji z ostatnich 7 dni