@azure/arm-reservations package

類別

AzureReservationAPI

介面

AppliedReservationList	已套用保留的編頁清單
AppliedReservations	套用保留 API 的回應
AppliedReservationsProperties	申請保留地的財產回報
AppliedScopeProperties	套用範圍類型的特定屬性。 如果不適用，則不需要。 如果 AppliedScopeType 為 ManagementGroup，則需要提供 tenantId 和 managementGroupId
AvailableScopeProperties	包含範圍及其資格的可用範圍 API 回應。
AvailableScopeRequest	可用的範圍
AvailableScopeRequestProperties	可用的範圍要求屬性
AzureReservationAPIOptionalParams	用戶端的選擇性參數。
BillingInformation	計費資訊
CalculateExchangeOperationResultResponse	CalculateExchange 作業結果
CalculateExchangeOperations	介面代表 CalculateExchange 操作。
CalculateExchangePostOptionalParams	選擇性參數。
CalculateExchangeRequest	計算交換要求
CalculateExchangeRequestProperties	計算交換要求屬性
CalculateExchangeResponseProperties	CalculateExchange 回應屬性
CalculatePriceResponse	保留之計算價格的回應。
CalculatePriceResponseProperties	計算價格回應的屬性
CalculatePriceResponsePropertiesBillingCurrencyTotal	客戶將以當地貨幣收取的貨幣和金額。 不包括稅金。
CalculatePriceResponsePropertiesPricingCurrencyTotal	Microsoft用於記錄的數量。 用於計算退款限制的退款期間。 不包括稅金。
CalculateRefundOperations	介面代表計算退款操作。
CalculateRefundPostOptionalParams	選擇性參數。
CalculateRefundRequest	要求包含計算退款所需的資訊。
CalculateRefundRequestProperties	計算退款所需的屬性，包括要傳回的範圍和保留。
CalculateRefundResponse	計算退款的回應，其中包含保留的退款資訊
Catalog	資源類型的產品詳細數據。
CatalogMsrp	SKU 的定價資訊
ChangeDirectoryRequest	要求保留變更目錄的本文。
ChangeDirectoryResponse	變更目錄回應
ChangeDirectoryResult	變更保留訂單或保留的目錄結果
Commitment	對權益的承諾。
CurrentQuotaLimitBase	配額屬性。
ErrorDetails	錯誤的詳細數據。
ErrorModel	錯誤資訊
ErrorResponse	錯誤回應表示服務無法處理傳入要求。 錯誤訊息中會提供原因。
ExceptionResponse	API 錯誤。
ExchangeOperationResultResponse	Exchange 作業結果
ExchangeOperations	介面代表 Exchange 操作。
ExchangePolicyError	錯誤詳細數據
ExchangePolicyErrors	Exchange 原則錯誤
ExchangePostOptionalParams	選擇性參數。
ExchangeRequest	Exchange 要求
ExchangeRequestProperties	Exchange 要求屬性
ExchangeResponseProperties	Exchange 回應屬性
ExtendedErrorInfo	擴充錯誤資訊，包括錯誤碼和錯誤訊息
ExtendedStatusInfo	model interface ExtendedStatusInfo
GetAppliedReservationListOptionalParams	選擇性參數。
GetCatalogOptionalParams	選擇性參數。
MergeProperties	保留地合併的物業
MergeRequest	保留合併的要求
OperationDisplay	作業的相關信息
OperationListOptionalParams	選擇性參數。
OperationOperations	介面代表操作。
OperationResponse	包含作業信息的回應
OperationResultError	如果 status == failed 或 status == canceled，則為必要專案。
PageSettings	byPage 方法的選項
PagedAsyncIterableIterator	介面，可讓異步反覆運算同時完成和逐頁執行。
Patch	保留修補程式的要求
PatchProperties	保留區塊的屬性
PatchPropertiesRenewProperties	模型介面 PatchPropertiesRenewProperties
PaymentDetail	與保留訂單相關的付款相關信息。
Price	包含金額和貨幣碼的定價資訊
ProxyResource	Azure Resource Manager Proxy 資源的資源模型定義。 它不會有標記和位置
PurchaseRequest	購買保留的要求
PurchaseRequestProperties	保留購買要求的屬性
PurchaseRequestPropertiesReservedResourceProperties	每個保留資源類型特有的屬性。 如果不適用，則不需要。
QuotaCreateOrUpdateOptionalParams	選擇性參數。
QuotaGetOptionalParams	選擇性參數。
QuotaListOptionalParams	選擇性參數。
QuotaOperations	代表配額作業的介面。
QuotaProperties	資源的配額屬性。
QuotaRequestDetails	配額要求詳細數據。
QuotaRequestProperties	配額要求的詳細數據。
QuotaRequestStatusGetOptionalParams	選擇性參數。
QuotaRequestStatusListOptionalParams	選擇性參數。
QuotaRequestStatusOperations	代表 QuotaRequestStatus 作業的介面。
QuotaUpdateOptionalParams	選擇性參數。
RefundBillingInformation	計費資訊
RefundPolicyError	錯誤詳細數據
RefundPolicyResult	退款原則結果
RefundPolicyResultProperty	退款原則結果屬性
RefundRequest	要求包含傳回保留所需的資訊。
RefundRequestProperties	退款要求所需的屬性，包括計算退款的會話標識碼、範圍、要傳回的保留，以及傳回原因。
RefundResponseProperties	保留的退款屬性
RenewPropertiesResponse	保留的更新屬性。
RenewPropertiesResponseBillingCurrencyTotal	客戶的貨幣和金額將會以客戶的當地貨幣收取續約購買費用。 不包括稅金。
RenewPropertiesResponsePricingCurrencyTotal	Microsoft用於記錄的數量。 用於計算退款限制的退款期間。 不包括稅金。 這是在到期前 30 天鎖定的價格。
ReservationArchiveOptionalParams	選擇性參數。
ReservationAvailableScopesOptionalParams	選擇性參數。
ReservationGetOptionalParams	選擇性參數。
ReservationListAllOptionalParams	選擇性參數。
ReservationListOptionalParams	選擇性參數。
ReservationListRevisionsOptionalParams	選擇性參數。
ReservationMergeOptionalParams	選擇性參數。
ReservationMergeProperties	保留合併的屬性
ReservationOperations	介面代表預約營運。
ReservationOrderBillingPlanInformation	描述此保留計費方案類型的資訊。
ReservationOrderCalculateOptionalParams	選擇性參數。
ReservationOrderChangeDirectoryOptionalParams	選擇性參數。
ReservationOrderGetOptionalParams	選擇性參數。
ReservationOrderListOptionalParams	選擇性參數。
ReservationOrderOperations	介面代表 ReservationOrder 操作。
ReservationOrderProperties	保留令的性質。
ReservationOrderPurchaseOptionalParams	選擇性參數。
ReservationOrderResponse	傳回保留訂單的詳細數據。
ReservationResponse	保留的定義。
ReservationSplitOptionalParams	選擇性參數。
ReservationSplitProperties	保留分割的屬性
ReservationSummary	每個狀態保留的匯總計數摘要
ReservationSwapProperties	保留交換的屬性
ReservationToExchange	保留退款詳細數據
ReservationToPurchaseCalculateExchange	保留購買詳細數據
ReservationToPurchaseExchange	保留購買詳細數據
ReservationToReturn	要傳回的保留
ReservationToReturnForExchange	保留退款詳細數據
ReservationUnarchiveOptionalParams	選擇性參數。
ReservationUpdateOptionalParams	選擇性參數。
ReservationUtilizationAggregates	保留使用率的匯總值
ReservationsProperties	保留的屬性
ReservationsPropertiesUtilization	保留使用率
Resource	回應中針對所有 Azure Resource Manager 資源傳回的常見欄位
ResourceName	資源提供者所提供的資源名稱。 將此屬性用於 quotaRequest 參數。
RestorePollerOptions
ReturnOperations	介面代表返回操作。
ReturnPostOptionalParams	選擇性參數。
SavingsPlanPurchaseRequest	要求儲存方案購買的本文
SavingsPlanPurchaseRequestProperties	儲蓄計畫購買的財產
SavingsPlanToPurchaseCalculateExchange	節省方案購買詳細數據
SavingsPlanToPurchaseExchange	節省方案購買詳細數據
ScopeProperties	範圍及其是否有效。
ServiceError	API 錯誤詳細數據。
ServiceErrorDetail	錯誤詳細數據。
SimplePollerLike	簡單的輪詢器，可用來輪詢長時間執行的作業。
SkuCapability	SKU 的功能。
SkuName	sku 的名稱
SkuProperty	SKU 的屬性。
SkuRestriction	SKU 的限制。
SplitProperties	保留地分割的物業
SplitRequest	保留分割的要求
SubRequest	以配額要求提交的子要求。
SubscriptionScopeProperties	可用範圍 API 檢查的範圍。
SystemData	與建立和上次修改資源相關的元數據。

類型別名

AppliedScopeType	套用範圍的類型。 KnownAppliedScopeType 可以與 AppliedScopeType 交替使用，此列舉包含服務支援的已知值。 服務支援的已知值 單曲：單曲 分享：共享 管理集團：管理集團
AzureSupportedClouds	雲端設定為字串常值類型的支援值
BillingPlan	表示 ISO 8601 格式的計費方案。 僅適用於每月計費方案。 KnownBillingPlan 可以與 BillingPlan 交換使用，此列舉包含服務支援的已知值。 服務支援的已知值 P1M：P1M
CalculateExchangeOperationResultStatus	作業的狀態。 KnownCalculateExchangeOperationResultStatus 可與 CalculateExchangeOperationResultStatus 交替使用，此列舉包含服務支援的已知值。 服務支援的已知值 成功：成功 失敗：失敗 取消：取消 待定：待定
CommitmentGrain	承諾粒紋。 KnownCommitmentGrain 可與 CommitmentGrain 交替使用，此列舉包含服務支援的已知值。 服務支援的已知值 時薪：時薪
ContinuablePage	描述結果頁面的介面。
CreatedByType	建立資源的實體種類。 KnownCreatedByType 可以與 CreatedByType 交換使用，此列舉包含服務支援的已知值。 服務支援的已知值 使用者：實體是由使用者建立的。 應用程式：實體是由應用程式所建立。 ManagedIdentity：實體是由受控識別所建立。 金鑰：實體是由金鑰所建立。
ErrorResponseCode	錯誤代碼描述服務無法處理來電請求的原因 KnownErrorResponseCode 可以與 ErrorResponseCode 交替使用，此列舉包含服務支援的已知值。 服務支援的已知值 未指定：未指定 InternalServerError： InternalServerError ServerTimeout：ServerTimeout 授權失敗：授權失敗 壞請求：壞壞請求 ClientCertificateThumbprintNotSet： ClientCertificateThumbprintNotSet InvalidRequestContent： InvalidRequestContent 行動失敗：行動失敗 HttpMethodNotSupported：HttpMethodNotSupported InvalidRequestUri： InvalidRequestUri 失蹤租戶ID：失蹤租戶ID InvalidTenantId： InvalidTenantId InvalidReservationOrderId： InvalidReservationOrderId InvalidReservationId：InvalidReservationId（無效保留ID） 預約中沒有預約命令：預約中沒有預約中 預約訂單未找到：預約訂單未找到 InvalidSubscriptionId： InvalidSubscriptionId InvalidAccessToken： InvalidAccessToken InvalidLocationId： InvalidLocationId 未認證請求限速：未認證請求限速 InvalidHealthCheckType： InvalidHealthCheckType 禁止：禁止 BillingScopeIdCannotBeChanged： BillingScopeIdCannotBeChanged AppliedScopesNotAssociatedWithCommerceAccount： AppliedScopesNotAssociatedWithCommerceAccount 補丁值與現有者相同：補丁值與現有者相同 角色分配創建失敗：角色分配創建失敗 預約命令創建失敗：預約訂單創建失敗 ReservationOrderNotEnabled：ReservationOrderNotEnabled 容量更新範圍失敗：容量更新範圍失敗 無支持保留期：無支持預留期 ReservationOrderIdAlalready exists： ReservationOrderIdAlreadyExists 風險檢查失敗：風險檢查失敗 CreateQuoteFailed： CreateQuoteFailed（創建Quote失敗） 啟動引用失敗：啟動引用失敗 NonsupportedAccountId：NonsupportedAccountId PaymentInstrumentNotFound：PaymentInstrumentNotFound MissingAppliedScopesForSingle：MissingAppliedScopesForSingle（失蹤AppliedScopesForSingle） 無效預約重新評分：無有效預約重新評分 重新收費只允許給EA：重新收費只允許給EA OperationCannotBeperformedInCurrentState： OperationCannotBeperformedInCurrentState InvalidSingleAppliedScopesCount： InvalidSingleAppliedScopesCount InvalidFulfillmentRequestParameters： InvalidFulfillmentRequestParameters（無效FulfillmentRequestParameters） 不支持國家：不支持國家 無效退款數量：無效退款數量 購買錯誤：購買錯誤 BillingCustomerInputError：BillingCustomerInputError（帳單客戶輸入錯誤） BillingPaymentInstrumentSoftError：BillingPaymentInstrumentSoftError（帳單支付工具SoftError） BillingPaymentInstrumentHardError：BillingPaymentInstrumentHardError（帳單支付工具HardError） 帳單暫態錯誤：帳單暫態錯誤 帳單錯誤：帳單錯誤 FulfillmentConfigurationError：FulfillmentConfigurationError（履行配置錯誤） FulfillmentoutOfStock錯誤：FulfillmentOutOfStock錯誤 FulfillmentTransientError：FulfillmentTransientError（履行TransientError） FulfillmentError：FulfillmentError（履行錯誤） 計算價格失敗：計算價格失敗 AppliedScopesSameAsExisting： AppliedScopesSameAsExisting（應用範圍）SameAsExisting（應用範圍）SameAsexist 自助退款不支援：自助退款不支援 退款上限超過：退款額度超過範圍
ExchangeOperationResultStatus	作業的狀態。 KnownExchangeOperationResultStatus 可以與 ExchangeOperationResultStatus 交換使用，此列舉包含服務支援的已知值。 服務支援的已知值 成功：成功 失敗：失敗 取消：取消 待處理退款：待處理退款 待購買：待購買
InstanceFlexibility	開啟此選項會將保留折扣套用至相同 VM 大小群組中的其他 VM。 只指定 VirtualMachines 保留的資源類型。 KnownInstanceFlexibility 可以與 InstanceFlexibility 交替使用，此列舉包含服務支援的已知值。 服務支援的已知值 開：開 關掉：關掉
OperationStatus	個別作業的狀態。 KnownOperationStatus 可以與 OperationStatus 交替使用，此列舉包含服務支援的已知值。 服務支援的已知值 成功：成功 失敗：失敗 取消：取消 待定：待定
PaymentStatus	描述付款是否已完成、失敗、取消或排程未來。 KnownPaymentStatus 可以與 PaymentStatus 交替使用，此列舉包含服務支援的已知值。 服務支援的已知值 成功：成功 失敗：失敗 排定：排定 取消：取消
ProvisioningState	代表保留的目前狀態。 KnownProvisioningState 可以與 ProvisioningState 交替使用，此列舉包含服務支援的已知值。 服務支援的已知值 創造：創造 待定資源暫停：待定資源暫停 確認資源暫停：確認資源暫停 待定帳單：待定帳單 確認帳單：確認帳單 創造：創造 成功：成功 取消：取消 過期：過期 帳單失敗：帳單失敗 失敗：失敗 分裂：分裂 合併：合併
QuotaRequestState	配額要求狀態。 KnownQuotaRequestState 可以與 QuotaRequestState 交換使用，此列舉包含服務支援的已知值。 服務支援的已知值 接受：接受 無效：無效 成功：成功 失敗：失敗 進行中：進行中
ReservationBillingPlan	代表計費方案。 KnownReservationBillingPlan 可以與 ReservationBillingPlan 交換使用，此列舉包含服務支援的已知值。 服務支援的已知值 前期：前期 每月：每月
ReservationStatusCode	預約類型狀態代碼
ReservationTerm	代表保留期限。 KnownReservationTerm 可以與 ReservationTerm 交換使用，此列舉包含服務支援的已知值。 服務支援的已知值 P1Y：P1Y P3Y：P3Y P5Y：P5Y
ReservedResourceType	正在保留的資源類型。 除了以下類型外，我們還添加了以下內容：OpenAIPTU、MDC、Sentinel。 KnownReservedResourceType 可以與 ReservedResourceType 交換使用，此列舉包含服務支援的已知值。 服務支援的已知值 虛擬機：虛擬機 SqlDatabases：SqlDatabases SuseLinux：SuseLinux 宇宙數據庫：宇宙開發者 RedHat：RedHat SqlDataWarehouse：SqlDataWarehouse VMwareCloudSimple： VMwareCloudSimple RedHatOSA 紅帽奧薩 Databricks：Databricks AppService：AppService ManagedDisk：ManagedDisk 方塊方塊：方塊方塊 RedisCache：RedisCache AzureDataExplorer： AzureDataExplorer MySql：MySQL MariaDb：MariaDb PostgreSql：PostgreSql 專屬宿主：專屬宿主 薩普哈娜：薩普哈娜 SqlAzureHybridBenefit： SqlAzureHybridBenefit AVS：AVS DataFactory：DataFactory NetAppStorage：NetAppStorage AzureFiles： AzureFiles SqlEdge：SqlEdge 虛擬機器軟體：虛擬機器軟體
ResourceType	資源類型。 KnownResourceType 可以與 ResourceType 交換使用，此列舉包含服務支援的已知值。 服務支援的已知值 標準：標準 奉獻：奉獻 低優先權：低優先權 分享：分享 serviceSpecific：serviceSpecific（服務特定）
SavingsPlanTerm	代表 ISO 8601 格式的節省計劃字詞。 KnownSavingsPlanTerm 可以與 SavingsPlanTerm 交替使用，此列舉包含服務支援的已知值。 服務支援的已知值 P1Y：P1Y P3Y：P3Y

列舉

AzureClouds	描述 Azure 雲端環境的列舉。
KnownAppliedScopeType	套用範圍的類型。
KnownBillingPlan	表示 ISO 8601 格式的計費方案。 僅適用於每月計費方案。
KnownCalculateExchangeOperationResultStatus	作業的狀態。
KnownCommitmentGrain	承諾粒紋。
KnownCreatedByType	建立資源的實體種類。
KnownErrorResponseCode	描述服務無法處理傳入要求原因的錯誤碼
KnownExchangeOperationResultStatus	作業的狀態。
KnownInstanceFlexibility	開啟此選項會將保留折扣套用至相同 VM 大小群組中的其他 VM。 只指定 VirtualMachines 保留的資源類型。
KnownOperationStatus	個別作業的狀態。
KnownPaymentStatus	描述付款是否已完成、失敗、取消或排程未來。
KnownProvisioningState	代表保留的目前狀態。
KnownQuotaRequestState	配額要求狀態。
KnownReservationBillingPlan	代表計費方案。
KnownReservationStatusCode	ReservationStatusCode 服務的已知值。
KnownReservationTerm	代表保留期限。
KnownReservedResourceType	正在保留的資源類型。 除了以下類型外，我們還添加了以下內容：OpenAIPTU、MDC、Sentinel。
KnownResourceType	資源類型。
KnownSavingsPlanTerm	代表 ISO 8601 格式的節省計劃字詞。

函式

isRestError(unknown)	RestError 的 Typeguard
restorePoller<TResponse, TResult>(AzureReservationAPI, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)	從另一個輪詢程式的串行化狀態建立輪詢器。 當您想要在不同的主機上建立輪詢器，或在原始輪詢器不在範圍內之後建構投票器時，這非常有用。

變數

RestError

失敗管線要求的自定義錯誤類型。

函式詳細資料

isRestError(unknown)

RestError 的 Typeguard

function isRestError(e: unknown): e

參數

e

unknown

catch 子句攔截到的東西。

傳回

e

restorePoller<TResponse, TResult>(AzureReservationAPI, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

從另一個輪詢程式的串行化狀態建立輪詢器。 當您想要在不同的主機上建立輪詢器，或在原始輪詢器不在範圍內之後建構投票器時，這非常有用。

function restorePoller<TResponse, TResult>(client: AzureReservationAPI, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

參數

client

AzureReservationAPI

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

options

RestorePollerOptions<TResult, PathUncheckedResponse>

傳回

PollerLike<OperationState<TResult>, TResult>

變數詳細資料

RestError

失敗管線要求的自定義錯誤類型。

RestError: RestErrorConstructor

類型

RestErrorConstructor