@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	如果 status == failed 或 status == canceled，則為必要專案。
Patch	保留修補程式的要求
PatchPropertiesRenewProperties
PaymentDetail	與保留訂單相關的付款相關信息。
Price	包含金額和貨幣碼的定價資訊
ProxyResource	Azure Resource Manager Proxy 資源的資源模型定義。 它不會有標記和位置
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	要求標識碼為已接受配額要求的回應。
QuotaUpdateOptionalParams	選擇性參數。
RefundBillingInformation	計費資訊
RefundPolicyError	錯誤詳細數據
RefundPolicyResult	退款原則結果
RefundPolicyResultProperty	退款原則結果屬性
RefundRequest	要求包含傳回保留所需的資訊。
RefundRequestProperties	退款要求所需的屬性，包括計算退款的會話標識碼、範圍、要傳回的保留，以及傳回原因。
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 Resource Manager 資源傳回的常見欄位
ResourceName	資源提供者所提供的資源名稱。 將此屬性用於 quotaRequest 參數。
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	包含後續作業的回應數據。
CalculateRefundPostResponse	包含後續作業的回應數據。
CommitmentGrain	定義 CommitmentGrain 的值。 KnownCommitmentGrain 可與 CommitmentGrain 交替使用，此列舉包含服務支援的已知值。 服務支援的已知值 每小時
CreatedByType	定義 CreatedByType 的值。 KnownCreatedByType 可以與 CreatedByType 交換使用，此列舉包含服務支援的已知值。 服務支援的已知值 使用者 應用程式 ManagedIdentity 金鑰
DisplayProvisioningState	定義 DisplayProvisioningState 的值。 KnownDisplayProvisioningState 可以與 DisplayProvisioningState 交替使用，此列舉包含服務支援的已知值。 服務支援的已知值 成功 到期 過期 暫止 處理 已取消 失敗 警告 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 履行OutOfStockError 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 中南部 centralus westeurope northeurope 東亞 東南 日本東部 日本西部 巴西 澳大利亞東部 澳大利亞 南丁迪亞 威斯汀迪亞 centralindia 加拿大中部 加拿大 uksouth westcentralus ukwest
OperationListNextResponse	包含 listNext 作業的響應數據。
OperationListResponse	包含清單作業的回應數據。
OperationStatus	定義 OperationStatus 的值。 KnownOperationStatus 可以與 OperationStatus 交替使用，此列舉包含服務支援的已知值。 服務支援的已知值 成功 失敗 已取消 暫止
PaymentStatus	定義 PaymentStatus 的值。 KnownPaymentStatus 可以與 PaymentStatus 交替使用，此列舉包含服務支援的已知值。 服務支援的已知值 成功 失敗 排程 已取消
ProvisioningState	定義 ProvisioningState 的值。 KnownProvisioningState 可以與 ProvisioningState 交替使用，此列舉包含服務支援的已知值。 服務支援的已知值 建立 PendingResourceHold ConfirmedResourceHold PendingBilling ConfirmedBilling 建立 成功 已取消 過期 BillingFailed 失敗 分割 合併
QuotaCreateOrUpdateResponse	包含 createOrUpdate 作業的響應數據。
QuotaGetResponse	包含取得作業的回應數據。
QuotaListNextResponse	包含 listNext 作業的響應數據。
QuotaListResponse	包含清單作業的回應數據。
QuotaRequestState	定義QuotaRequestState的值。 KnownQuotaRequestState 可以與 QuotaRequestState 交換使用，此列舉包含服務支援的已知值。 服務支援的已知值 已接受 無效的 成功 失敗 InProgress
QuotaRequestStatusGetResponse	包含取得作業的回應數據。
QuotaRequestStatusListNextResponse	包含 listNext 作業的響應數據。
QuotaRequestStatusListResponse	包含清單作業的回應數據。
QuotaUpdateResponse	包含更新作業的回應數據。
ReservationAvailableScopesResponse	包含可用Scopes 作業的響應數據。
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 交換使用，此列舉包含服務支援的已知值。 服務支援的已知值 無 暫止 處理 Active 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 交換使用，此列舉包含服務支援的已知值。 服務支援的已知值 標準 專用 lowPriority 共用 serviceSpecific
ReturnPostResponse	包含後續作業的回應數據。
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	服務接受 位置 的已知值。
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)

假設 .value 反覆運算器所產生的最後一個 byPage，傳回接續令牌，可用來從該點稍後開始分頁。

函式詳細資料

getContinuationToken(unknown)

假設 .value 反覆運算器所產生的最後一個 byPage，傳回接續令牌，可用來從該點稍後開始分頁。

function getContinuationToken(page: unknown): string | undefined

參數

page

unknown

從 value 反覆運算器存取 IteratorResult 上 byPage 的物件。

傳回

string | undefined

未來呼叫期間可傳遞至 byPage（） 的接續令牌。