你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

@azure/arm-reservations package

类

AzureReservationAPI

接口

AppliedReservationList	已应用预留的分页列表
AppliedReservations	应用的预留 API 的响应
AppliedScopeProperties	特定于所应用范围类型的属性。 如果不适用，则不需要。 如果 AppliedScopeType 为 ManagementGroup，则需要提供 tenantId 和 managementGroupId
AvailableScopeProperties	包含范围及其资格的可用范围 API 的响应。
AvailableScopeRequest	可用范围
AvailableScopeRequestProperties	可用范围请求属性
AzureReservationAPIOptionalParams	可选参数。
BillingInformation	计费信息
CalculateExchange	表示 CalculateExchange 的接口。
CalculateExchangeOperationResultResponse	CalculateExchange 操作结果
CalculateExchangePostHeaders	定义CalculateExchange_post操作的标头。
CalculateExchangePostOptionalParams	可选参数。
CalculateExchangeRequest	计算交换请求
CalculateExchangeRequestProperties	计算交换请求属性
CalculateExchangeResponseProperties	CalculateExchange 响应属性
CalculatePriceResponse	预留的计算价格的响应。
CalculatePriceResponseProperties	用于计算价格响应的属性
CalculatePriceResponsePropertiesBillingCurrencyTotal	货币和金额将按客户的本地货币收费。 不包括税款。
CalculatePriceResponsePropertiesPricingCurrencyTotal	Microsoft 用于记录的金额。 在退款期间用于计算退款限制。 不包括税款。
CalculateRefund	表示 CalculateRefund 的接口。
CalculateRefundPostOptionalParams	可选参数。
CalculateRefundRequest	包含计算退款所需的信息的请求。
CalculateRefundRequestProperties	计算退款所需的属性，包括要返回的范围和预留。
CalculateRefundResponse	包含预留退款信息的计算退款的响应
Catalog	某类型的资源的产品详细信息。
CatalogMsrp	有关 SKU 的定价信息
CatalogsResult	目录和分页信息的列表。
ChangeDirectoryRequest	更改预留目录的请求正文。
ChangeDirectoryResponse	更改目录响应
ChangeDirectoryResult	更改预留订单或预留的目录结果
Commitment	对权益的承诺。
CreateGenericQuotaRequestParameters	配额更改请求信息。
CurrentQuotaLimit	当前配额限制。
CurrentQuotaLimitBase	配额属性。
ErrorDetails	错误的详细信息。
ErrorModel	错误信息
ErrorResponse	错误响应指示服务无法处理传入请求。 错误消息中提供了原因。
ExceptionResponse	API 错误。
Exchange	表示 Exchange 的接口。
ExchangeOperationResultResponse	Exchange 操作结果
ExchangePolicyError	错误详细信息
ExchangePolicyErrors	Exchange 策略错误
ExchangePostHeaders	定义Exchange_post操作的标头。
ExchangePostOptionalParams	可选参数。
ExchangeRequest	Exchange 请求
ExchangeRequestProperties	Exchange 请求属性
ExchangeResponseProperties	Exchange 响应属性
ExtendedErrorInfo	扩展的错误信息，包括错误代码和错误消息
ExtendedStatusInfo
GetAppliedReservationListOptionalParams	可选参数。
GetCatalogNextOptionalParams	可选参数。
GetCatalogOptionalParams	可选参数。
MergeRequest	预留合并请求
Operation	表示操作的接口。
OperationDisplay	有关操作的信息
OperationList	操作的分页列表
OperationListNextOptionalParams	可选参数。
OperationListOptionalParams	可选参数。
OperationResponse	包含操作信息的响应
OperationResultError	如果状态 == 失败或状态 == 已取消，则为必需。
Patch	预留修补程序请求
PatchPropertiesRenewProperties
PaymentDetail	与预留订单相关的付款信息。
Price	包含金额和货币代码的定价信息
ProxyResource	Azure 资源管理器代理资源的资源模型定义。 它不会有标记和位置
PurchaseRequest	预留购买请求
PurchaseRequestPropertiesReservedResourceProperties	特定于每个保留资源类型的属性。 如果不适用，则不需要。
Quota	表示配额的接口。
QuotaCreateOrUpdateOptionalParams	可选参数。
QuotaGetHeaders	定义Quota_get操作的标头。
QuotaGetOptionalParams	可选参数。
QuotaLimits	配额限制。
QuotaLimitsResponse	请求响应中) (服务限制的配额。
QuotaListHeaders	定义Quota_list操作的标头。
QuotaListNextHeaders	定义Quota_listNext操作的标头。
QuotaListNextOptionalParams	可选参数。
QuotaListOptionalParams	可选参数。
QuotaProperties	资源的配额属性。
QuotaRequestDetails	配额请求详细信息。
QuotaRequestDetailsList	配额请求详细信息。
QuotaRequestOneResourceSubmitResponse	配额提交请求的响应。
QuotaRequestProperties	配额请求的详细信息。
QuotaRequestStatus	表示 QuotaRequestStatus 的接口。
QuotaRequestStatusGetOptionalParams	可选参数。
QuotaRequestStatusListNextOptionalParams	可选参数。
QuotaRequestStatusListOptionalParams	可选参数。
QuotaRequestSubmitResponse	配额提交请求的响应。
QuotaRequestSubmitResponse201	包含已接受配额请求的请求 ID 的响应。
QuotaUpdateOptionalParams	可选参数。
RefundBillingInformation	计费信息
RefundPolicyError	错误详细信息
RefundPolicyResult	退款策略结果
RefundPolicyResultProperty	退款策略结果属性
RefundRequest	包含退回预留所需的信息的请求。
RefundRequestProperties	退款请求所需的属性，包括计算退款中的会话 ID、范围、要返回的预留和退货原因。
RefundResponse	包含预留退款信息的退款请求的响应
RefundResponseProperties	预留的退款属性
RenewPropertiesResponse	预留的续订属性。
RenewPropertiesResponseBillingCurrencyTotal	续订购买时，将按客户本地货币向客户收取货币和金额。 不包括税款。
RenewPropertiesResponsePricingCurrencyTotal	Microsoft 用于记录的金额。 在退款期间用于计算退款限制。 不包括税款。 这是在到期前 30 天锁定的价格。
Reservation	表示预留的接口。
ReservationArchiveOptionalParams	可选参数。
ReservationAvailableScopesOptionalParams	可选参数。
ReservationGetOptionalParams	可选参数。
ReservationList	Reservation列表
ReservationListAllNextOptionalParams	可选参数。
ReservationListAllOptionalParams	可选参数。
ReservationListNextOptionalParams	可选参数。
ReservationListOptionalParams	可选参数。
ReservationListRevisionsNextOptionalParams	可选参数。
ReservationListRevisionsOptionalParams	可选参数。
ReservationMergeHeaders	定义Reservation_merge操作的标头。
ReservationMergeOptionalParams	可选参数。
ReservationMergeProperties	预留合并的属性
ReservationOrder	表示 ReservationOrder 的接口。
ReservationOrderBillingPlanInformation	描述此预留的计费计划类型的信息。
ReservationOrderCalculateOptionalParams	可选参数。
ReservationOrderChangeDirectoryOptionalParams	可选参数。
ReservationOrderGetOptionalParams	可选参数。
ReservationOrderList	ReservationOrder列表
ReservationOrderListNextOptionalParams	可选参数。
ReservationOrderListOptionalParams	可选参数。
ReservationOrderPurchaseHeaders	定义ReservationOrder_purchase操作的标头。
ReservationOrderPurchaseOptionalParams	可选参数。
ReservationOrderResponse	正在返回的预留订单的详细信息。
ReservationResponse	预留的定义。
ReservationSplitHeaders	定义Reservation_split操作的标头。
ReservationSplitOptionalParams	可选参数。
ReservationSplitProperties	预留拆分的属性
ReservationSummary	每个州预留的汇总计数摘要
ReservationSwapProperties	预留交换的属性
ReservationToExchange	预留退款详细信息
ReservationToPurchaseCalculateExchange	预留购买详细信息
ReservationToPurchaseExchange	预留购买详细信息
ReservationToReturn	要退回的预留
ReservationToReturnForExchange	预留退款详细信息
ReservationUnarchiveOptionalParams	可选参数。
ReservationUpdateHeaders	定义Reservation_update操作的标头。
ReservationUpdateOptionalParams	可选参数。
ReservationUtilizationAggregates	预留利用率的聚合值
ReservationsListResult	每个州预留项的列表和推出预留计数摘要。
ReservationsProperties	预留的属性
ReservationsPropertiesUtilization	预留利用率
Resource	所有 Azure 资源管理器 资源的响应中返回的常见字段
ResourceName	资源提供程序提供的资源名称。 将此属性用于 quotaRequest 参数。
Return	表示 Return 的接口。
ReturnPostHeaders	定义Return_post操作的标头。
ReturnPostOptionalParams	可选参数。
SavingsPlanPurchaseRequest	节省计划购买的请求正文
SavingsPlanToPurchaseCalculateExchange	节省计划购买详细信息
SavingsPlanToPurchaseExchange	节省计划购买详细信息
ScopeProperties	范围以及它是否有效。
ServiceError	API 错误详细信息。
ServiceErrorDetail	错误详细信息。
SkuCapability	SKU 的功能。
SkuName	SKU 的名称
SkuProperty	SKU 的属性。
SkuRestriction	SKU 的限制。
SplitRequest	预留拆分请求
SubRequest	随配额请求一起提交的子请求。
SubscriptionScopeProperties	可用范围 API 检查的范围。
SystemData	与资源的创建和上次修改相关的元数据。

类型别名

AppliedScopeType	定义 AppliedScopeType 的值。 KnownAppliedScopeType 可与 AppliedScopeType 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 单精度 共享 ManagementGroup
BillingPlan	定义 BillingPlan 的值。 KnownBillingPlan 可与 BillingPlan 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 P1M
CalculateExchangeOperationResultStatus	定义 CalculateExchangeOperationResultStatus 的值。 KnownCalculateExchangeOperationResultStatus 可与 CalculateExchangeOperationResultStatus 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 成功 已失败 已取消 挂起
CalculateExchangePostResponse	包含 post 操作的响应数据。
CalculateRefundPostResponse	包含 post 操作的响应数据。
CommitmentGrain	定义 CommitmentGrain 的值。 KnownCommitmentGrain 可与 CommitmentGrain 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 每小时
CreatedByType	定义 CreatedByType 的值。 KnownCreatedByType 可与 CreatedByType 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 用户 应用程序 ManagedIdentity 键
DisplayProvisioningState	定义 DisplayProvisioningState 的值。 KnownDisplayProvisioningState 可与 DisplayProvisioningState 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 成功 到期 已过期 挂起 Processing 已取消 已失败 警告 NoBenefit
ErrorResponseCode	定义 ErrorResponseCode 的值。 KnownErrorResponseCode 可与 ErrorResponseCode 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 NotSpecified InternalServerError ServerTimeOut AuthorizationFailed BadRequest ClientCertificateThumbprintNotSet InvalidRequestContent OperationFailed HttpMethodNotSupported InvalidRequestUri MissingTenantId InvalidTenantId InvalidReservationOrderId InvalidReservationId ReservationIdNotInReservationOrder ReservationOrderNotFound InvalidSubscriptionId InvalidAccessToken InvalidLocationId UnauthenticatedRequestsThrottled InvalidHealthCheckType 已禁止 BillingScopeIdCannotBeChanged AppliedScopesNotAssociatedWithCommerceAccount PatchValuesSameAsExisting RoleAssignmentCreationFailed ReservationOrderCreationFailed ReservationOrderNotEnabled CapacityUpdateScopesFailed UnsupportedReservationTerm ReservationOrderIdAlreadyExists RiskCheckFailed CreateQuoteFailed ActivateQuoteFailed NonsupportedAccountId PaymentInstrumentNotFound MissingAppliedScopesForSingle NoValidReservationsToReRate ReRateOnlyAllowedForEA OperationCannotBePerformedInCurrentState InvalidSingleAppliedScopesCount InvalidFulfillmentRequestParameters NotSupportedCountry InvalidRefundQuantity PurchaseError BillingCustomerInputError BillingPaymentInstrumentSoftError BillingPaymentInstrumentHardError BillingTransientError BillingError FulfillmentConfigurationError FulfillmentOutOfStockError FulfillmentTransientError FulfillmentError CalculatePriceFailed AppliedScopesSameAsExisting SelfServiceRefundNotSupported RefundLimitExceeded
ExchangeOperationResultStatus	定义 ExchangeOperationResultStatus 的值。 KnownExchangeOperationResultStatus 可与 ExchangeOperationResultStatus 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 成功 已失败 已取消 PendingRefunds PendingPurchases
ExchangePostResponse	包含发布操作的响应数据。
GetAppliedReservationListResponse	包含 getAppliedReservationList 操作的响应数据。
GetCatalogNextResponse	包含 getCatalogNext 操作的响应数据。
GetCatalogResponse	包含 getCatalog 操作的响应数据。
InstanceFlexibility	定义 InstanceFlexibility 的值。 KnownInstanceFlexibility 可与 InstanceFlexibility 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 开 关闭
Location	定义 Location 的值。 KnownLocation 可与 Location 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 westus eastus eastus2 northcentralus westus2 southcentralus centralus westeurope northeurope eastasia southeastasia japaneast japanwest brazilsouth australiaeast australiasoutheast southindia westindia centralindia canadacentral canadaeast uksouth westcentralus ukwest
OperationListNextResponse	包含 listNext 操作的响应数据。
OperationListResponse	包含列表操作的响应数据。
OperationStatus	定义 OperationStatus 的值。 KnownOperationStatus 可与 OperationStatus 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 成功 已失败 已取消 挂起
PaymentStatus	定义 PaymentStatus 的值。 KnownPaymentStatus 可与 PaymentStatus 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 成功 已失败 计划 已取消
ProvisioningState	定义 ProvisioningState 的值。 KnownProvisioningState 可与 ProvisioningState 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 Creating PendingResourceHold ConfirmedResourceHold PendingBilling ConfirmedBilling 创建时间 成功 已取消 已过期 BillingFailed 已失败 拆分 已合并
QuotaCreateOrUpdateResponse	包含 createOrUpdate 操作的响应数据。
QuotaGetResponse	包含获取操作的响应数据。
QuotaListNextResponse	包含 listNext 操作的响应数据。
QuotaListResponse	包含列表操作的响应数据。
QuotaRequestState	定义 QuotaRequestState 的值。 KnownQuotaRequestState 可与 QuotaRequestState 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 已接受 无效 成功 已失败 InProgress
QuotaRequestStatusGetResponse	包含获取操作的响应数据。
QuotaRequestStatusListNextResponse	包含 listNext 操作的响应数据。
QuotaRequestStatusListResponse	包含列表操作的响应数据。
QuotaUpdateResponse	包含更新操作的响应数据。
ReservationAvailableScopesResponse	包含 availableScopes 操作的响应数据。
ReservationBillingPlan	定义 ReservationBillingPlan 的值。 KnownReservationBillingPlan 可与 ReservationBillingPlan 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 前期 每月
ReservationGetResponse	包含获取操作的响应数据。
ReservationListAllNextResponse	包含 listAllNext 操作的响应数据。
ReservationListAllResponse	包含 listAll 操作的响应数据。
ReservationListNextResponse	包含 listNext 操作的响应数据。
ReservationListResponse	包含列表操作的响应数据。
ReservationListRevisionsNextResponse	包含 listRevisionsNext 操作的响应数据。
ReservationListRevisionsResponse	包含 listRevisions 操作的响应数据。
ReservationMergeResponse	包含合并操作的响应数据。
ReservationOrderCalculateResponse	包含计算操作的响应数据。
ReservationOrderChangeDirectoryResponse	包含 changeDirectory 操作的响应数据。
ReservationOrderGetResponse	包含获取操作的响应数据。
ReservationOrderListNextResponse	包含 listNext 操作的响应数据。
ReservationOrderListResponse	包含列表操作的响应数据。
ReservationOrderPurchaseResponse	包含购买操作的响应数据。
ReservationSplitResponse	包含拆分操作的响应数据。
ReservationStatusCode	定义 ReservationStatusCode 的值。 KnownReservationStatusCode 可与 ReservationStatusCode 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 无 挂起 Processing 活动 PurchaseError PaymentInstrumentError 拆分 已合并 已过期 成功
ReservationTerm	定义 ReservationTerm 的值。 KnownReservationTerm 可与 ReservationTerm 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 P1Y P3Y P5Y
ReservationUpdateResponse	包含更新操作的响应数据。
ReservedResourceType	定义 ReservedResourceType 的值。 KnownReservedResourceType 可与 ReservedResourceType 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 VirtualMachines SqlDatabases SuseLinux CosmosDb RedHat SqlDataWarehouse VMwareCloudSimple RedHatOsa Databricks AppService ManagedDisk BlockBlob RedisCache AzureDataExplorer MySql MariaDb PostgreSql DedicatedHost SapHana SqlAzureHybridBenefit AVS DataFactory NetAppStorage AzureFiles SqlEdge VirtualMachineSoftware
ResourceType	定义 ResourceType 的值。 KnownResourceType 可与 ResourceType 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 standard 专用 lowPriority shared serviceSpecific
ReturnPostResponse	包含 post 操作的响应数据。
SavingsPlanTerm	定义 SavingsPlanTerm 的值。 KnownSavingsPlanTerm 可与 SavingsPlanTerm 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 P1Y P3Y
UserFriendlyAppliedScopeType	定义 UserFriendlyAppliedScopeType 的值。 KnownUserFriendlyAppliedScopeType 可与 UserFriendlyAppliedScopeType 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 无 共享 单精度 ResourceGroup ManagementGroup
UserFriendlyRenewState	定义 UserFriendlyRenewState 的值。 KnownUserFriendlyRenewState 可与 UserFriendlyRenewState 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 开 关闭 更新 NotRenewed NotApplicable

枚举

KnownAppliedScopeType	服务接受的 AppliedScopeType 的已知值。
KnownBillingPlan	服务接受的 BillingPlan 的已知值。
KnownCalculateExchangeOperationResultStatus	服务接受的 CalculateExchangeOperationResultStatus 的已知值。
KnownCommitmentGrain	服务接受的 CommitmentGrain 的已知值。
KnownCreatedByType	服务接受的 CreatedByType 的已知值。
KnownDisplayProvisioningState	服务接受的 DisplayProvisioningState 的已知值。
KnownErrorResponseCode	服务接受的 ErrorResponseCode 的已知值。
KnownExchangeOperationResultStatus	服务接受的 ExchangeOperationResultStatus 的已知值。
KnownInstanceFlexibility	服务接受的 InstanceFlexibility 的已知值。
KnownLocation	服务接受 的 Location 的已知值。
KnownOperationStatus	服务接受的 OperationStatus 的已知值。
KnownPaymentStatus	服务接受的 PaymentStatus 的已知值。
KnownProvisioningState	服务接受的 ProvisioningState 的已知值。
KnownQuotaRequestState	服务接受的 QuotaRequestState 的已知值。
KnownReservationBillingPlan	服务接受的 ReservationBillingPlan 的已知值。
KnownReservationStatusCode	服务接受的 ReservationStatusCode 的已知值。
KnownReservationTerm	服务接受的 ReservationTerm 的已知值。
KnownReservedResourceType	服务接受的 ReservedResourceType 的已知值。
KnownResourceType	服务接受的 ResourceType 的已知值。
KnownSavingsPlanTerm	服务接受的 SavingsPlanTerm 的已知值。
KnownUserFriendlyAppliedScopeType	服务接受的 UserFriendlyAppliedScopeType 的已知值。
KnownUserFriendlyRenewState	服务接受的 UserFriendlyRenewState 的已知值。

函数

getContinuationToken(unknown)

给定迭代器生成的byPage最后.value一个 ， 返回可用于稍后从该点开始分页的继续标记。

函数详细信息

getContinuationToken(unknown)

给定迭代器生成的byPage最后.value一个 ， 返回可用于稍后从该点开始分页的继续标记。

function getContinuationToken(page: unknown): string | undefined

参数

page

unknown

从迭代器访问 value IteratorResult byPage 的对象。

返回

string | undefined

可在将来调用期间传入 byPage () 的继续标记。