Reservation Order - Purchase

Service:

Reserved VM Instances

API Version:

2022-11-01

Приобретите ReservationOrder и создайте ресурс по указанному универсальному коду ресурса (URI).

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
reservationOrderId	path	True	string	Идентификатор заказа резервирования
api-version	query	True	string	Поддерживаемая версия.

Текст запроса

Имя	Тип	Описание
location	string	Регион Azure, в котором находится зарезервированный ресурс.
properties.appliedScopeProperties	AppliedScopeProperties	Свойства, относящиеся к примененным область типу. Не требуется, если неприменимо. Требуется и необходимо предоставить tenantId и managementGroupId, если AppliedScopeType имеет значение ManagementGroup
properties.appliedScopeType	AppliedScopeType	Тип примененной области.
properties.appliedScopes	string[]	Список подписок, к которым будет применено преимущество. Не указывайте, является ли AppliedScopeType общим. Это свойство будет нерекомендуемым и заменено на appliedScopeProperties вместо single AppliedScopeType.
properties.billingPlan	ReservationBillingPlan	Представлять планы выставления счетов.
properties.billingScopeId	string	Подписка, которая будет взиматься за приобретение резервирования или накопительного плана
properties.displayName	string	Понятное имя резервирования
properties.quantity	integer	Количество номеров SKU, которые являются частью резервирования.
properties.renew	boolean	Если задать для этого параметра значение true, будет автоматически приобретено новое резервирование в дату окончания срока действия.
properties.reservedResourceProperties	ReservedResourceProperties	Свойства, относящиеся к каждому типу зарезервированного ресурса. Не требуется, если неприменимо.
properties.reservedResourceType	ReservedResourceType	Тип зарезервированного ресурса.
properties.reviewDateTime	string	Это дата и время, когда необходимо проверить преимущество гибридного использования Azure.
properties.term	ReservationTerm	Представляет термин резервирования.
sku	SkuName	Имя SKU

Ответы

Имя	Тип	Описание
200 OK	ReservationOrderResponse	Ресурс создан
202 Accepted	ReservationOrderResponse	Запрос принимается и обрабатывается. Ссылка на результат операции находится в заголовке расположения. Headers Location: string Retry-After: integer
Other Status Codes	Error	Непредвиденная ошибка.

Примеры

Purchase

Sample Request

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

Sample Response

Status code:

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

Status code:

202

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

Response Body

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

Определения

Имя	Описание
AppliedScopeProperties	Свойства, относящиеся к примененным область типу. Не требуется, если это не применимо. Требуется и требуется указать tenantId и managementGroupId, если AppliedScopeType имеет значение ManagementGroup.
AppliedScopeType	Тип примененной области.
BillingCurrencyTotal	Валюта и сумма, которые клиент будет взимать в местной валюте клиента для продления покупки. Налог не включен.
createdByType	Тип удостоверения, создавшего ресурс.
Error	Сведения об ошибках.
ErrorResponseCode	Код ошибки, описывающий причину, по которой служба не может обработать входящий запрос
ExtendedErrorInfo	Расширенные сведения об ошибке, включая код ошибки и сообщение об ошибке
ExtendedStatusInfo
InstanceFlexibility	При включении этого параметра скидка на резервирование применяется к другим виртуальным машинам в той же группе размера виртуальных машин. Укажите только для типа зарезервированного ресурса VirtualMachines.
Kind	Зарезервированный тип поставщика ресурсов.
PaymentDetail	Сведения об оплате, связанной с заказом на резервирование.
PaymentStatus	Описывает, будет ли платеж завершен, не выполнен, отменен или запланирован в будущем.
Price	Сведения о ценах, содержащие сумму и код валюты
PricingCurrencyTotal	Сумма, которую корпорация Майкрософт использует для записи. Используется при возврате средств для расчета лимита возмещения. Налог не включен. Эта цена заблокирована за 30 дней до истечения срока действия.
ProvisioningState	Представляет текущее состояние резервирования.
PurchaseRequest	Запрос на покупку резервирования
RenewPropertiesResponse	Свойства продления для резервирования.
ReservationBillingPlan	Представляет планы выставления счетов.
ReservationMergeProperties	Свойства слияния резервирования
ReservationOrderBillingPlanInformation	Сведения, описывающие тип плана выставления счетов для этого резервирования.
ReservationOrderResponse	Сведения о возвращаемом заказе на резервирование.
ReservationResponse	Определение резервирования.
ReservationSplitProperties	Свойства разделения резервирования
ReservationsProperties	Свойства резервирований
ReservationStatusCode
ReservationSwapProperties	Свойства переключения резервирования
ReservationTerm	Представляет срок резервирования.
ReservationUtilizationAggregates	Агрегированные значения использования резервирования
ReservedResourceProperties	Свойства, относящиеся к каждому типу зарезервированного ресурса. Не требуется, если это не применимо.
ReservedResourceType	Тип зарезервированного ресурса.
SkuName	Имя SKU
systemData	Метаданные, относящиеся к созданию и последнему изменению ресурса.
Utilization	Использование резервирования

AppliedScopeProperties

Свойства, относящиеся к примененным область типу. Не требуется, если это не применимо. Требуется и требуется указать tenantId и managementGroupId, если AppliedScopeType имеет значение ManagementGroup.

Имя	Тип	Описание
displayName	string	Отображаемое имя
managementGroupId	string	Полный идентификатор группы управления, в которой должно применяться преимущество.
resourceGroupId	string	Полный идентификатор группы ресурсов.
subscriptionId	string	Полный идентификатор подписки.
tenantId	string	Идентификатор клиента, к которому должен применяться накопительный план.

AppliedScopeType

Тип примененной области.

Имя	Тип	Описание
ManagementGroup	string
Shared	string
Single	string

BillingCurrencyTotal

Валюта и сумма, которые клиент будет взимать в местной валюте клиента для продления покупки. Налог не включен.

Имя	Тип	Описание
amount	number
currencyCode	string	Трехбуквенный код валюты ISO 4217 для валюты, используемой в этой записи покупки.

createdByType

Тип удостоверения, создавшего ресурс.

Имя	Тип	Описание
Application	string
Key	string
ManagedIdentity	string
User	string

Error

Сведения об ошибках.

Имя	Тип	Описание
error	ExtendedErrorInfo	Расширенные сведения об ошибке, включая код ошибки и сообщение об ошибке

ErrorResponseCode

Код ошибки, описывающий причину, по которой служба не может обработать входящий запрос

Имя	Тип	Описание
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

Расширенные сведения об ошибке, включая код ошибки и сообщение об ошибке

Имя	Тип	Описание
code	ErrorResponseCode	Код ошибки, описывающий причину, по которой служба не может обработать входящий запрос
message	string

ExtendedStatusInfo

Имя	Тип	Описание
message	string	Сообщение с подробными сведениями о коде состояния.
statusCode	ReservationStatusCode

InstanceFlexibility

При включении этого параметра скидка на резервирование применяется к другим виртуальным машинам в той же группе размера виртуальных машин. Укажите только для типа зарезервированного ресурса VirtualMachines.

Имя	Тип	Описание
Off	string
On	string

Kind

Зарезервированный тип поставщика ресурсов.

Имя	Тип	Описание
Microsoft.Compute	string

PaymentDetail

Сведения об оплате, связанной с заказом на резервирование.

Имя	Тип	Описание
billingAccount	string	Отображает учетную запись, которая взимается за этот платеж.
billingCurrencyTotal	Price	Сумма, взимаемая в валюте выставления счетов. Налог не включен. Имеет значение NULL для будущих платежей.
dueDate	string	Дата, когда необходимо выполнить платеж.
extendedStatusInfo	ExtendedStatusInfo
paymentDate	string	Дата завершения транзакции. Имеет значение NULL при планировании.
pricingCurrencyTotal	Price	Сумма в валюте ценообразования. Налог не включен.
status	PaymentStatus	Описывает, будет ли платеж завершен, не выполнен, отменен или запланирован в будущем.

PaymentStatus

Описывает, будет ли платеж завершен, не выполнен, отменен или запланирован в будущем.

Имя	Тип	Описание
Cancelled	string
Failed	string
Scheduled	string
Succeeded	string

Price

Сведения о ценах, содержащие сумму и код валюты

Имя	Тип	Описание
amount	number
currencyCode	string	3-буквенный код валюты ISO 4217 для валюты, используемой в этой записи покупки.

PricingCurrencyTotal

Сумма, которую корпорация Майкрософт использует для записи. Используется при возврате средств для расчета лимита возмещения. Налог не включен. Эта цена заблокирована за 30 дней до истечения срока действия.

Имя	Тип	Описание
amount	number
currencyCode	string	Трехбуквенный код валюты ISO 4217 для валюты, используемой в этой записи покупки.

ProvisioningState

Представляет текущее состояние резервирования.

Имя	Тип	Описание
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

Запрос на покупку резервирования

Имя	Тип	Значение по умолчанию	Описание
location	string		Регион Azure, в котором находится зарезервированный ресурс.
properties.appliedScopeProperties	AppliedScopeProperties		Свойства, относящиеся к примененным область типу. Не требуется, если это не применимо. Требуется и требуется указать tenantId и managementGroupId, если AppliedScopeType имеет значение ManagementGroup.
properties.appliedScopeType	AppliedScopeType		Тип примененной области.
properties.appliedScopes	string[]		Список подписок, к которым будет применено преимущество. Не указывайте, является ли AppliedScopeType общим. Это свойство будет нерекомендуемым и заменено на appliedScopeProperties вместо single AppliedScopeType.
properties.billingPlan	ReservationBillingPlan		Представляет планы выставления счетов.
properties.billingScopeId	string		Подписка, с которую будет взиматься плата за приобретение резервирования или накопительного плана
properties.displayName	string		Понятное имя резервирования
properties.quantity	integer		Количество номеров SKU, которые являются частью резервирования.
properties.renew	boolean	False	Если задать для этого параметра значение true, новое резервирование будет автоматически приобретено в дату окончания срока действия.
properties.reservedResourceProperties	ReservedResourceProperties		Свойства, относящиеся к каждому типу зарезервированного ресурса. Не требуется, если это не применимо.
properties.reservedResourceType	ReservedResourceType		Тип зарезервированного ресурса.
properties.reviewDateTime	string		Это дата, когда необходимо проверить преимущество гибридного использования Azure.
properties.term	ReservationTerm		Представляет срок резервирования.
sku	SkuName		Имя SKU

RenewPropertiesResponse

Свойства продления для резервирования.

Имя	Тип	Описание
billingCurrencyTotal	BillingCurrencyTotal	Валюта и сумма, которые клиент будет взимать в местной валюте клиента для продления покупки. Налог не включен.
pricingCurrencyTotal	PricingCurrencyTotal	Сумма, которую корпорация Майкрософт использует для записи. Используется при возврате средств для расчета лимита возмещения. Налог не включен. Эта цена заблокирована за 30 дней до истечения срока действия.
purchaseProperties	PurchaseRequest	Запрос на покупку резервирования

ReservationBillingPlan

Представляет планы выставления счетов.

Имя	Тип	Описание
Monthly	string
Upfront	string

ReservationMergeProperties

Свойства слияния резервирования

Имя	Тип	Описание
mergeDestination	string	Идентификатор ресурса резервирования создан из-за слияния. Формат идентификатора ресурса: /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}
mergeSources	string[]	Идентификаторы ресурсов исходного резервирования, объединенные для формирования этого резервирования. Формат идентификатора ресурса: /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}

ReservationOrderBillingPlanInformation

Сведения, описывающие тип плана выставления счетов для этого резервирования.

Имя	Тип	Описание
nextPaymentDueDate	string	Для планов периодического выставления счетов указывает дату обработки следующего платежа. Значение NULL при выплате итогового значения.
pricingCurrencyTotal	Price	Сумма денег, выплачиваемая за Заказ. Налог не включается.
startDate	string	Дата запуска плана выставления счетов.
transactions	PaymentDetail[]	Сведения об оплате, связанной с заказом на резервирование.

ReservationOrderResponse

Сведения о возвращаемом заказе на резервирование.

Имя	Тип	Описание
etag	integer
id	string	Идентификатор резервирования
name	string	Имя резервирования
properties.benefitStartTime	string	Это дата и время начала резервирования.
properties.billingPlan	ReservationBillingPlan	Представляет планы выставления счетов.
properties.createdDateTime	string	Это дата и время создания резервирования.
properties.displayName	string	Понятное имя для пользователя, который легко идентифицировал резервирование.
properties.expiryDate	string	Это дата истечения срока действия резервирования.
properties.expiryDateTime	string	Это дата и время истечения срока действия резервирования.
properties.originalQuantity	integer	Общее количество номеров SKU, приобретенных в резервировании.
properties.planInformation	ReservationOrderBillingPlanInformation	Сведения, описывающие тип плана выставления счетов для этого резервирования.
properties.provisioningState	ProvisioningState	Текущее состояние резервирования.
properties.requestDateTime	string	Это дата и время первоначального запроса резервирования для покупки.
properties.reservations	ReservationResponse[]	Определение резервирования.
properties.reviewDateTime	string	Это дата и время, когда необходимо проверить Преимущество гибридного использования Azure.
properties.term	ReservationTerm	Представляет срок резервирования.
systemData	systemData	Метаданные, относящиеся к созданию и последнему изменению ресурса.
type	string	Тип ресурса. Microsoft.Capacity/reservations

ReservationResponse

Определение резервирования.

Имя	Тип	Описание
etag	integer
id	string	Полный идентификатор ресурса. Например, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind	Kind	Тип поставщика ресурсов, который требуется зарезервировать.
location	string	Регион Azure, в котором находится зарезервированный ресурс.
name	string	Имя ресурса.
properties	ReservationsProperties	Свойства, связанные с этим резервированием
sku	SkuName	Сведения о номере SKU, связанные с этим резервированием
systemData	systemData	Azure Resource Manager метаданные, содержащие сведения createdBy и modifiedBy.
type	string	Тип ресурса. Например, Microsoft.Compute/virtualMachines или Microsoft.Storage/storageAccounts.

ReservationSplitProperties

Свойства разделения резервирования

Имя	Тип	Описание
splitDestinations	string[]	Список идентификаторов целевого ресурса, созданных из-за разделения. Формат идентификатора ресурса: /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}
splitSource	string	Идентификатор ресурса резервирования, от которого отделен этот объект. Формат идентификатора ресурса: /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}

ReservationsProperties

Свойства резервирований

Имя	Тип	Значение по умолчанию	Описание
appliedScopeProperties	AppliedScopeProperties		Свойства, относящиеся к примененным область типу. Не требуется, если неприменимо. Требуется и необходимо предоставить tenantId и managementGroupId, если AppliedScopeType имеет значение ManagementGroup
appliedScopeType	AppliedScopeType		Примененный тип область
appliedScopes	string[]		Список примененных областей
archived	boolean		Указывает, архивировано ли резервирование.
benefitStartTime	string		Это дата и время начала резервирования.
billingPlan	ReservationBillingPlan		Параметры плана выставления счетов, доступные для этого номера SKU.
billingScopeId	string		Подписка, которая будет взиматься за приобретение резервирования или накопительного плана
capabilities	string		Возможности резервирования
displayName	string		Понятное имя для пользователя, чтобы легко идентифицировать резервирование
displayProvisioningState	string		Состояние подготовки резервирования для отображения, например Успешно
effectiveDateTime	string		Дата и время резервирования, начиная с момента вступления в силу этой версии.
expiryDate	string		Это дата истечения срока действия резервирования.
expiryDateTime	string		Это дата и время истечения срока действия резервирования.
extendedStatusInfo	ExtendedStatusInfo		Сообщение с подробными сведениями о коде состояния.
instanceFlexibility	InstanceFlexibility		Позволяет применять скидку на резервирование по номерам SKU в одной группе автоматического размещения. Не все номера SKU поддерживают гибкость размера экземпляра.
lastUpdatedDateTime	string		DateTime последнего обновления резервирования.
mergeProperties	ReservationMergeProperties		Свойства слияния резервирования
provisioningState	ProvisioningState		Текущее состояние резервирования.
provisioningSubState	string		Подчиненное состояние подготовки резервирования, например Выполнено
purchaseDate	string		Это дата приобретения резервирования.
purchaseDateTime	string		Это дата и время приобретения резервирования.
quantity	integer		Количество номеров SKU, которые являются частью резервирования.
renew	boolean	False	Если задать для этого параметра значение true, будет автоматически приобретено новое резервирование в дату окончания срока действия.
renewDestination	string		Идентификатор резервирования резервирования, приобретенного в связи с продлением. Формат идентификатора ресурса : /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}.
renewProperties	RenewPropertiesResponse		Свойства продления для резервирования.
renewSource	string		Идентификатор резервирования резервирования, с которого это резервирование продлевается. Формат идентификатора ресурса : /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}.
reservedResourceType	ReservedResourceType		Тип зарезервированного ресурса.
reviewDateTime	string		Это дата и время, когда необходимо проверить Преимущество гибридного использования Azure.
skuDescription	string		Описание SKU на английском языке.
splitProperties	ReservationSplitProperties		Свойства разделения резервирования
swapProperties	ReservationSwapProperties		Свойства переключения резервирования
term	ReservationTerm		Представляет термин резервирования.
userFriendlyAppliedScopeType	string		Примененный область тип резервирования для отображения, например Общий
userFriendlyRenewState	string		Состояние продления резервирования для отображения, например On
utilization	Utilization		Использование резервирования

ReservationStatusCode

Имя	Тип	Описание
Active	string
Expired	string
Merged	string
None	string
PaymentInstrumentError	string
Pending	string
Processing	string
PurchaseError	string
Split	string
Succeeded	string

ReservationSwapProperties

Свойства переключения резервирования

Имя	Тип	Описание
swapDestination	string	Идентификатор ресурса резервирования, на который переключается исходный ресурс. Формат идентификатора ресурса: /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}
swapSource	string	Идентификатор ресурса исходного резервирования, которое переключается. Формат идентификатора ресурса: /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}

ReservationTerm

Представляет срок резервирования.

Имя	Тип	Описание
P1Y	string
P3Y	string
P5Y	string

ReservationUtilizationAggregates

Агрегированные значения использования резервирования

Имя	Тип	Описание
grain	number	Зернистая часть агрегата
grainUnit	string	Единица детализации агрегата
value	number	Агрегированное значение
valueUnit	string	Единица агрегированного значения

ReservedResourceProperties

Свойства, относящиеся к каждому типу зарезервированного ресурса. Не требуется, если это не применимо.

Имя	Тип	Описание
instanceFlexibility	InstanceFlexibility	При включении этого параметра скидка на резервирование применяется к другим виртуальным машинам в той же группе размера виртуальных машин. Укажите только для типа зарезервированного ресурса VirtualMachines.

ReservedResourceType

Тип зарезервированного ресурса.

Имя	Тип	Описание
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

Имя SKU

Имя	Тип	Описание
name	string

systemData

Метаданные, относящиеся к созданию и последнему изменению ресурса.

Имя	Тип	Описание
createdAt	string	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string	Метка времени последнего изменения ресурса (UTC)
lastModifiedBy	string	Удостоверение, которое последним изменял ресурс.
lastModifiedByType	createdByType	Тип удостоверения, которое последним изменял ресурс.

Utilization

Использование резервирования

Имя	Тип	Описание
aggregates	ReservationUtilizationAggregates[]	Массив статистических выражений использования резервирования
trend	string	Тенденция использования резервирования за последние 7 дней