@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	Exchange 要求のプロパティを計算する
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 プロキシ リソースのリソース モデル定義。 タグと場所はありません
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 Resource Manager リソースの応答で返される共通フィールド
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 と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。 サービスでサポートされている既知の値 Single 共有 の 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 FulfillmentOutOfStockError FulfillmentTransientError FulfillmentError CalculatePriceFailed の AppliedScopesSameAsExisting selfServiceRefundNotSupported の RefundLimitExceeded
ExchangeOperationResultStatus	ExchangeOperationResultStatus の値を定義します。 KnownExchangeOperationResultStatus ExchangeOperationResultStatus と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。 サービスでサポートされている既知の値 成功した の 失敗した 取り消された PendingRefunds の 保留中のpurchases の
ExchangePostResponse	事後操作の応答データを格納します。
GetAppliedReservationListResponse	getAppliedReservationList 操作の応答データを格納します。
GetCatalogNextResponse	getCatalogNext 操作の応答データを格納します。
GetCatalogResponse	getCatalog 操作の応答データが含まれています。
InstanceFlexibility	InstanceFlexibility の値を定義します。 KnownInstanceFlexibility InstanceFlexibility と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。 サービスでサポートされている既知の値 の オフ
Location	Location の値を定義します。 KnownLocation を Location と同じ意味で使用できる、この列挙型には、サービスがサポートする既知の値が含まれています。 サービスでサポートされている既知の値 westus を する eastus を する eastus2 を する northcentralus westus2 南 centralus を する westeurope northeurope eastasia 東南アジア 日本 日本 ブラジルの を する オーストラリア オーストラリア southindia ウェスティンディア centralindia カナダ中心 を する カナダ uksouth westcentralus ukwest
OperationListNextResponse	listNext 操作の応答データを格納します。
OperationListResponse	リスト操作の応答データが含まれています。
OperationStatus	OperationStatus の値を定義します。 KnownOperationStatus OperationStatus と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。 サービスでサポートされている既知の値 成功した の 失敗した 取り消された 保留中の の
PaymentStatus	PaymentStatus の値を定義します。 KnownPaymentStatus を PaymentStatus と同じ意味で使用できる、この列挙型には、サービスがサポートする既知の値が含まれています。 サービスでサポートされている既知の値 成功した の 失敗した スケジュールされた の 取り消された
ProvisioningState	ProvisioningState の値を定義します。 KnownProvisioningState ProvisioningState と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。 サービスでサポートされている既知の値 の作成 PendingResourceHold の ConfirmedResourceHold の 保留中の請求 の ConfirmedBilling の Created 成功した の 取り消された 期限切れの 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 と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。 サービスでサポートされている既知の値 なし 保留中の の 処理 アクティブな の 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 と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。 サービスでサポートされている既知の値 なし 共有 の Single 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

iteratorResult の value に byPage 反復子からアクセスするオブジェクト。

戻り値

string | undefined

今後の呼び出し中に byPage() に渡すことができる継続トークン。