@azure/arm-reservations package
Klasser
AzureReservationAPI |
Gränssnitt
AppliedReservationList |
Sidnumrerad lista över tillämpade reservationer |
AppliedReservations |
Svaret för tillämpat reservations-API |
AppliedScopeProperties |
Egenskaper som är specifika för tillämpad omfångstyp. Krävs inte om det inte är tillämpligt. Krävs och måste ange tenantId och managementGroupId om AppliedScopeType är ManagementGroup |
AvailableScopeProperties |
Svaret för tillgängligt omfångs-API som innehåller omfång och deras behörigheter. |
AvailableScopeRequest |
Tillgängligt omfång |
AvailableScopeRequestProperties |
Tillgängliga egenskaper för omfångsbegäran |
AzureReservationAPIOptionalParams |
Valfria parametrar. |
BillingInformation |
faktureringsinformation |
CalculateExchange |
Gränssnitt som representerar en CalculateExchange. |
CalculateExchangeOperationResultResponse |
Resultat av CalculateExchange-åtgärden |
CalculateExchangePostHeaders |
Definierar rubriker för CalculateExchange_post åtgärd. |
CalculateExchangePostOptionalParams |
Valfria parametrar. |
CalculateExchangeRequest |
Beräkna exchange-begäran |
CalculateExchangeRequestProperties |
Beräkna egenskaper för exchange-begäran |
CalculateExchangeResponseProperties |
CalculateExchange-svarsegenskaper |
CalculatePriceResponse |
Svaret för att beräkna priset för reservationen. |
CalculatePriceResponseProperties |
Egenskaper för att beräkna prissvar |
CalculatePriceResponsePropertiesBillingCurrencyTotal |
Valuta och belopp som kunden debiteras i kundens lokala valuta. Skatt ingår inte. |
CalculatePriceResponsePropertiesPricingCurrencyTotal |
Belopp som Microsoft använder för posten. Används under återbetalning för att beräkna återbetalningsgränsen. Skatt ingår inte. |
CalculateRefund |
Gränssnitt som representerar en CalculateRefund. |
CalculateRefundPostOptionalParams |
Valfria parametrar. |
CalculateRefundRequest |
Begäran som innehåller information som behövs för att beräkna återbetalningen. |
CalculateRefundRequestProperties |
Egenskaper som krävs för att beräkna återbetalning, inklusive omfånget och reservationen som ska returneras. |
CalculateRefundResponse |
Svaret för att beräkna återbetalning som innehåller återbetalningsinformation för reservationen |
Catalog |
Produktinformation för en typ av resurs. |
CatalogMsrp |
Prisinformation om SKU:n |
CatalogsResult |
Listan över kataloger och sidnumreringsinformation. |
ChangeDirectoryRequest |
Begärandetext för ändringskatalog för en reservation. |
ChangeDirectoryResponse |
Ändra katalogsvar |
ChangeDirectoryResult |
Ändra katalogresultat för reservationsbeställning eller reservation |
Commitment |
Engagemang för förmånen. |
CreateGenericQuotaRequestParameters |
Information om begäranden om kvotändring. |
CurrentQuotaLimit |
Aktuella kvotgränser. |
CurrentQuotaLimitBase |
Kvotegenskaper. |
ErrorDetails |
Information om felet. |
ErrorModel |
Felinformation |
ErrorResponse |
Felsvaret anger att tjänsten inte kan bearbeta den inkommande begäran. Orsaken anges i felmeddelandet. |
ExceptionResponse |
API-felet. |
Exchange |
Gränssnitt som representerar ett Exchange. |
ExchangeOperationResultResponse |
Resultat av Exchange-åtgärd |
ExchangePolicyError |
felinformation |
ExchangePolicyErrors |
Exchange-principfel |
ExchangePostHeaders |
Definierar rubriker för Exchange_post åtgärd. |
ExchangePostOptionalParams |
Valfria parametrar. |
ExchangeRequest |
Exchange-begäran |
ExchangeRequestProperties |
Egenskaper för Exchange-begäran |
ExchangeResponseProperties |
Exchange-svarsegenskaper |
ExtendedErrorInfo |
Utökad felinformation inklusive felkod och felmeddelande |
ExtendedStatusInfo | |
GetAppliedReservationListOptionalParams |
Valfria parametrar. |
GetCatalogNextOptionalParams |
Valfria parametrar. |
GetCatalogOptionalParams |
Valfria parametrar. |
MergeRequest |
Begäran om reservationssammanslagning |
Operation |
Gränssnitt som representerar en åtgärd. |
OperationDisplay |
Information om en åtgärd |
OperationList |
Sidnumrerad lista över åtgärder |
OperationListNextOptionalParams |
Valfria parametrar. |
OperationListOptionalParams |
Valfria parametrar. |
OperationResponse |
Svaret som innehåller åtgärdsinformation |
OperationResultError |
Krävs om status == misslyckades eller status == avbröts. |
Patch |
Begäran om reservationskorrigering |
PatchPropertiesRenewProperties | |
PaymentDetail |
Information om betalning relaterad till en reservationsbeställning. |
Price |
Prisinformation som innehåller beloppet och valutakoden |
ProxyResource |
Resursmodelldefinitionen för en Azure-Resource Manager proxyresurs. Det kommer inte att ha taggar och en plats |
PurchaseRequest |
Begäran om reservationsköp |
PurchaseRequestPropertiesReservedResourceProperties |
Egenskaper som är specifika för varje reserverad resurstyp. Krävs inte om det inte är tillämpligt. |
Quota |
Gränssnitt som representerar en kvot. |
QuotaCreateOrUpdateOptionalParams |
Valfria parametrar. |
QuotaGetHeaders |
Definierar rubriker för Quota_get åtgärd. |
QuotaGetOptionalParams |
Valfria parametrar. |
QuotaLimits |
Kvotgränser. |
QuotaLimitsResponse |
Kvoter (tjänstgränser) i begärandesvaret. |
QuotaListHeaders |
Definierar rubriker för Quota_list åtgärd. |
QuotaListNextHeaders |
Definierar rubriker för Quota_listNext åtgärd. |
QuotaListNextOptionalParams |
Valfria parametrar. |
QuotaListOptionalParams |
Valfria parametrar. |
QuotaProperties |
Kvotegenskaper för resursen. |
QuotaRequestDetails |
Information om kvotbegäran. |
QuotaRequestDetailsList |
Information om kvotbegäran. |
QuotaRequestOneResourceSubmitResponse |
Svar för begäran om kvotöverföring. |
QuotaRequestProperties |
Information om kvotbegäran. |
QuotaRequestStatus |
Gränssnitt som representerar en QuotaRequestStatus. |
QuotaRequestStatusGetOptionalParams |
Valfria parametrar. |
QuotaRequestStatusListNextOptionalParams |
Valfria parametrar. |
QuotaRequestStatusListOptionalParams |
Valfria parametrar. |
QuotaRequestSubmitResponse |
Svar för begäran om kvotöverföring. |
QuotaRequestSubmitResponse201 |
Svar med begärande-ID som kvotbegäran accepterades. |
QuotaUpdateOptionalParams |
Valfria parametrar. |
RefundBillingInformation |
faktureringsinformation |
RefundPolicyError |
felinformation |
RefundPolicyResult |
Resultat av återbetalningsprincip |
RefundPolicyResultProperty |
Resultategenskap för återbetalningsprincip |
RefundRequest |
Begäran som innehåller information som behövs för att returnera reservationen. |
RefundRequestProperties |
Egenskaper som behövs för begäran om återbetalning, inklusive sessions-ID från beräkna återbetalning, omfånget, reservationen som ska returneras och returorsaken. |
RefundResponse |
Svaret på begäran om återbetalning som innehåller återbetalningsinformation för reservationen |
RefundResponseProperties |
Återbetalningsegenskaperna för reservationen |
RenewPropertiesResponse |
Förnyelseegenskaperna för en reservation. |
RenewPropertiesResponseBillingCurrencyTotal |
Valuta och belopp som kunden debiteras i kundens lokala valuta för förnyelseköp. Skatt ingår inte. |
RenewPropertiesResponsePricingCurrencyTotal |
Belopp som Microsoft använder för posten. Används under återbetalning för att beräkna återbetalningsgränsen. Skatt ingår inte. Det här är låst pris 30 dagar innan det upphör att gälla. |
Reservation |
Gränssnitt som representerar en reservation. |
ReservationArchiveOptionalParams |
Valfria parametrar. |
ReservationAvailableScopesOptionalParams |
Valfria parametrar. |
ReservationGetOptionalParams |
Valfria parametrar. |
ReservationList |
|
ReservationListAllNextOptionalParams |
Valfria parametrar. |
ReservationListAllOptionalParams |
Valfria parametrar. |
ReservationListNextOptionalParams |
Valfria parametrar. |
ReservationListOptionalParams |
Valfria parametrar. |
ReservationListRevisionsNextOptionalParams |
Valfria parametrar. |
ReservationListRevisionsOptionalParams |
Valfria parametrar. |
ReservationMergeHeaders |
Definierar rubriker för Reservation_merge åtgärd. |
ReservationMergeOptionalParams |
Valfria parametrar. |
ReservationMergeProperties |
Egenskaper för reservationssammanslagning |
ReservationOrder |
Gränssnitt som representerar en ReservationOrder. |
ReservationOrderBillingPlanInformation |
Information som beskriver typen av faktureringsplan för den här reservationen. |
ReservationOrderCalculateOptionalParams |
Valfria parametrar. |
ReservationOrderChangeDirectoryOptionalParams |
Valfria parametrar. |
ReservationOrderGetOptionalParams |
Valfria parametrar. |
ReservationOrderList |
|
ReservationOrderListNextOptionalParams |
Valfria parametrar. |
ReservationOrderListOptionalParams |
Valfria parametrar. |
ReservationOrderPurchaseHeaders |
Definierar rubriker för ReservationOrder_purchase åtgärd. |
ReservationOrderPurchaseOptionalParams |
Valfria parametrar. |
ReservationOrderResponse |
Information om en reservationsbeställning som returneras. |
ReservationResponse |
Definitionen av reservationen. |
ReservationSplitHeaders |
Definierar rubriker för Reservation_split åtgärd. |
ReservationSplitOptionalParams |
Valfria parametrar. |
ReservationSplitProperties |
Egenskaper för reservationsdelning |
ReservationSummary |
Sammanfattning av antalet reservationer i varje delstat |
ReservationSwapProperties |
Egenskaper för reservationsväxling |
ReservationToExchange |
Information om reservationsåterbetalning |
ReservationToPurchaseCalculateExchange |
Information om reservationsköp |
ReservationToPurchaseExchange |
Information om reservationsköp |
ReservationToReturn |
Reservation att returnera |
ReservationToReturnForExchange |
Information om reservationsåterbetalning |
ReservationUnarchiveOptionalParams |
Valfria parametrar. |
ReservationUpdateHeaders |
Definierar rubriker för Reservation_update åtgärd. |
ReservationUpdateOptionalParams |
Valfria parametrar. |
ReservationUtilizationAggregates |
Aggregerade värden för reservationsanvändning |
ReservationsListResult |
Listan över reservationer och sammanfattning av antalet reservationer i varje tillstånd. |
ReservationsProperties |
Egenskaperna för reservationerna |
ReservationsPropertiesUtilization |
Reservationsanvändning |
Resource |
Vanliga fält som returneras i svaret för alla Azure-Resource Manager resurser |
ResourceName |
Resursnamn som tillhandahålls av resursprovidern. Använd den här egenskapen för parametern quotaRequest. |
Return |
Gränssnitt som representerar en retur. |
ReturnPostHeaders |
Definierar rubriker för Return_post åtgärd. |
ReturnPostOptionalParams |
Valfria parametrar. |
SavingsPlanPurchaseRequest |
Begärandetext för köp av sparplan |
SavingsPlanToPurchaseCalculateExchange |
Inköpsinformation för sparplan |
SavingsPlanToPurchaseExchange |
Inköpsinformation för sparplan |
ScopeProperties |
Omfånget och om det är giltigt. |
ServiceError |
API-felinformationen. |
ServiceErrorDetail |
Felinformationen. |
SkuCapability |
Kapacitet för en sku. |
SkuName |
Namnet på sku |
SkuProperty |
Egenskapen för en sku. |
SkuRestriction |
Begränsning av en sku. |
SplitRequest |
Begäran om reservationsdelning |
SubRequest |
Den underbegäran som skickats med kvotbegäran. |
SubscriptionScopeProperties |
De omfång som kontrolleras av det tillgängliga omfångs-API:et. |
SystemData |
Metadata som rör skapande och senaste ändring av resursen. |
Typalias
AppliedScopeType |
Definierar värden för AppliedScopeType. Kända värden som stöds av tjänstenEnkel |
BillingPlan |
Definierar värden för BillingPlan. Kända värden som stöds av tjänstenP1M |
CalculateExchangeOperationResultStatus |
Definierar värden för CalculateExchangeOperationResultStatus. Kända värden som stöds av tjänstenLyckades |
CalculateExchangePostResponse |
Innehåller svarsdata för poståtgärden. |
CalculateRefundPostResponse |
Innehåller svarsdata för poståtgärden. |
CommitmentGrain |
Definierar värden för CommitmentGrain. Kända värden som stöds av tjänstenVarje timma |
CreatedByType |
Definierar värden för CreatedByType. Kända värden som stöds av tjänstenAnvändare |
DisplayProvisioningState |
Definierar värden för DisplayProvisioningState. Kända värden som stöds av tjänstenLyckades |
ErrorResponseCode |
Definierar värden för ErrorResponseCode. Kända värden som stöds av tjänstenNotSpecified |
ExchangeOperationResultStatus |
Definierar värden för ExchangeOperationResultStatus. Kända värden som stöds av tjänstenLyckades |
ExchangePostResponse |
Innehåller svarsdata för poståtgärden. |
GetAppliedReservationListResponse |
Innehåller svarsdata för åtgärden getAppliedReservationList. |
GetCatalogNextResponse |
Innehåller svarsdata för åtgärden getCatalogNext. |
GetCatalogResponse |
Innehåller svarsdata för getCatalog-åtgärden. |
InstanceFlexibility |
Definierar värden för InstanceFlexibility. Kända värden som stöds av tjänstenPå |
Location |
Definierar värden för Plats. Kända värden som stöds av tjänstenwestus |
OperationListNextResponse |
Innehåller svarsdata för åtgärden listNext. |
OperationListResponse |
Innehåller svarsdata för liståtgärden. |
OperationStatus |
Definierar värden för OperationStatus. Kända värden som stöds av tjänstenLyckades |
PaymentStatus |
Definierar värden för PaymentStatus. Kända värden som stöds av tjänstenLyckades |
ProvisioningState |
Definierar värden för ProvisioningState. Kända värden som stöds av tjänstenSkapar |
QuotaCreateOrUpdateResponse |
Innehåller svarsdata för åtgärden createOrUpdate. |
QuotaGetResponse |
Innehåller svarsdata för get-åtgärden. |
QuotaListNextResponse |
Innehåller svarsdata för åtgärden listNext. |
QuotaListResponse |
Innehåller svarsdata för liståtgärden. |
QuotaRequestState |
Definierar värden för QuotaRequestState. Kända värden som stöds av tjänstenAccepterade |
QuotaRequestStatusGetResponse |
Innehåller svarsdata för get-åtgärden. |
QuotaRequestStatusListNextResponse |
Innehåller svarsdata för åtgärden listNext. |
QuotaRequestStatusListResponse |
Innehåller svarsdata för liståtgärden. |
QuotaUpdateResponse |
Innehåller svarsdata för uppdateringsåtgärden. |
ReservationAvailableScopesResponse |
Innehåller svarsdata för åtgärden availableScopes. |
ReservationBillingPlan |
Definierar värden för ReservationBillingPlan. Kända värden som stöds av tjänstenFörskott |
ReservationGetResponse |
Innehåller svarsdata för get-åtgärden. |
ReservationListAllNextResponse |
Innehåller svarsdata för åtgärden listAllNext. |
ReservationListAllResponse |
Innehåller svarsdata för åtgärden listAll. |
ReservationListNextResponse |
Innehåller svarsdata för åtgärden listNext. |
ReservationListResponse |
Innehåller svarsdata för liståtgärden. |
ReservationListRevisionsNextResponse |
Innehåller svarsdata för åtgärden listRevisionsNext. |
ReservationListRevisionsResponse |
Innehåller svarsdata för åtgärden listRevisions. |
ReservationMergeResponse |
Innehåller svarsdata för sammanslagningsåtgärden. |
ReservationOrderCalculateResponse |
Innehåller svarsdata för beräkningsåtgärden. |
ReservationOrderChangeDirectoryResponse |
Innehåller svarsdata för åtgärden changeDirectory. |
ReservationOrderGetResponse |
Innehåller svarsdata för get-åtgärden. |
ReservationOrderListNextResponse |
Innehåller svarsdata för åtgärden listNext. |
ReservationOrderListResponse |
Innehåller svarsdata för liståtgärden. |
ReservationOrderPurchaseResponse |
Innehåller svarsdata för köpåtgärden. |
ReservationSplitResponse |
Innehåller svarsdata för delningsåtgärden. |
ReservationStatusCode |
Definierar värden för ReservationStatusCode. Kända värden som stöds av tjänstenIngen |
ReservationTerm |
Definierar värden för ReservationTerm. Kända värden som stöds av tjänstenP1Y |
ReservationUpdateResponse |
Innehåller svarsdata för uppdateringsåtgärden. |
ReservedResourceType |
Definierar värden för ReservedResourceType. Kända värden som stöds av tjänstenVirtualMachines |
ResourceType |
Definierar värden för ResourceType. Kända värden som stöds av tjänstenstandard |
ReturnPostResponse |
Innehåller svarsdata för poståtgärden. |
SavingsPlanTerm |
Definierar värden för SavingsPlanTerm. Kända värden som stöds av tjänstenP1Y |
UserFriendlyAppliedScopeType |
Definierar värden för UserFriendlyAppliedScopeType. Kända värden som stöds av tjänstenIngen |
UserFriendlyRenewState |
Definierar värden för UserFriendlyRenewState. Kända värden som stöds av tjänstenPå |
Uppräkningar
KnownAppliedScopeType |
Kända värden för AppliedScopeType som tjänsten accepterar. |
KnownBillingPlan |
Kända värden för BillingPlan som tjänsten accepterar. |
KnownCalculateExchangeOperationResultStatus |
Kända värden för CalculateExchangeOperationResultStatus som tjänsten accepterar. |
KnownCommitmentGrain |
Kända värden för CommitmentGrain som tjänsten accepterar. |
KnownCreatedByType |
Kända värden för CreatedByType som tjänsten accepterar. |
KnownDisplayProvisioningState |
Kända värden för DisplayProvisioningState som tjänsten accepterar. |
KnownErrorResponseCode |
Kända värden för ErrorResponseCode som tjänsten accepterar. |
KnownExchangeOperationResultStatus |
Kända värden för ExchangeOperationResultStatus som tjänsten accepterar. |
KnownInstanceFlexibility |
Kända värden för InstanceFlexibility som tjänsten accepterar. |
KnownLocation |
Kända värden för Plats som tjänsten accepterar. |
KnownOperationStatus |
Kända värden för OperationStatus som tjänsten accepterar. |
KnownPaymentStatus |
Kända värden för PaymentStatus som tjänsten accepterar. |
KnownProvisioningState |
Kända värden för ProvisioningState som tjänsten accepterar. |
KnownQuotaRequestState |
Kända värden för QuotaRequestState som tjänsten accepterar. |
KnownReservationBillingPlan |
Kända värden för ReservationBillingPlan som tjänsten accepterar. |
KnownReservationStatusCode |
Kända värden för ReservationStatusCode som tjänsten accepterar. |
KnownReservationTerm |
Kända värden för ReservationTerm som tjänsten accepterar. |
KnownReservedResourceType |
Kända värden för ReservedResourceType som tjänsten accepterar. |
KnownResourceType |
Kända värden för ResourceType som tjänsten accepterar. |
KnownSavingsPlanTerm |
Kända värden för SavingsPlanTerm som tjänsten accepterar. |
KnownUserFriendlyAppliedScopeType |
Kända värden för UserFriendlyAppliedScopeType som tjänsten accepterar. |
KnownUserFriendlyRenewState |
Kända värden för UserFriendlyRenewState som tjänsten accepterar. |
Funktioner
get |
Givet den senaste |
Funktionsinformation
getContinuationToken(unknown)
Givet den senaste .value
som skapades av iteratorn returnerar en fortsättningstoken som kan användas för att börja växling från den byPage
punkten senare.
function getContinuationToken(page: unknown): string | undefined
Parametrar
- page
-
unknown
Ett objekt från att komma value
åt iteratorResult från en byPage
iterator.
Returer
string | undefined
Fortsättningstoken som kan skickas till byPage() under framtida anrop.