@azure/arm-reservations package
Klasser
| AzureReservationAPI |
Gränssnitt
| AppliedReservationList |
Sidnumrerad lista över tillämpade reservationer |
| AppliedReservations |
Svaret för api för tillämpade reservationer |
| AppliedReservationsProperties |
Fastigheter för ansökta reservationer som returnerats |
| 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 för klienten. |
| BillingInformation |
faktureringsinformation |
| CalculateExchangeOperationResultResponse |
CalculateExchange-åtgärdsresultat |
| CalculateExchangeOperations |
Gränssnitt som representerar en CalculateExchange-operation. |
| 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 post. Används under återbetalningen för att beräkna återbetalningsgränsen. Skatt ingår inte. |
| CalculateRefundOperations |
Gränssnitt som representerar en CalculateRefund-operation. |
| CalculateRefundPostOptionalParams |
Valfria parametrar. |
| CalculateRefundRequest |
Begäran som innehåller information som behövs för att beräkna återbetalningen. |
| CalculateRefundRequestProperties |
Egenskaper som behö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 reservation |
| Catalog |
Produktinformation för en typ av resurs. |
| CatalogMsrp |
Prisinformation om sku:n |
| ChangeDirectoryRequest |
Begär brödtext för ändringskatalogen för en reservation. |
| ChangeDirectoryResponse |
Ändra katalogsvar |
| ChangeDirectoryResult |
Ändra katalogresultat för reservationsbeställning eller reservation |
| Commitment |
Engagemang för förmånen. |
| 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. |
| ExchangeOperationResultResponse |
Resultat av Exchange-åtgärden |
| ExchangeOperations |
Gränssnitt som representerar en Exchange-operation. |
| ExchangePolicyError |
felinformation |
| ExchangePolicyErrors |
Exchange-principfel |
| 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 |
modellgränssnitt ExtendedStatusInfo |
| GetAppliedReservationListOptionalParams |
Valfria parametrar. |
| GetCatalogOptionalParams |
Valfria parametrar. |
| MergeProperties |
Fastigheter för sammanslagning av reservationer |
| MergeRequest |
Begäran om reservationssammanslagning |
| OperationDisplay |
Information om en åtgärd |
| OperationListOptionalParams |
Valfria parametrar. |
| OperationOperations |
Gränssnitt som representerar en operation. |
| OperationResponse |
Svaret som innehåller åtgärdsinformation |
| OperationResultError |
Krävs om status == misslyckades eller status == avbröts. |
| PageSettings |
Alternativ för byPage-metoden |
| PagedAsyncIterableIterator |
Ett gränssnitt som tillåter asynkron iteration både för slutförande och efter sida. |
| Patch |
Begäran om reservationskorrigering |
| PatchProperties |
Egenskaper för reservatpatchen |
| PatchPropertiesRenewProperties |
modellgränssnitt 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 |
| PurchaseRequestProperties |
Egenskaper för reservationsköpsbegäran |
| PurchaseRequestPropertiesReservedResourceProperties |
Egenskaper som är specifika för varje reserverad resurstyp. Krävs inte om det inte är tillämpligt. |
| QuotaCreateOrUpdateOptionalParams |
Valfria parametrar. |
| QuotaGetOptionalParams |
Valfria parametrar. |
| QuotaListOptionalParams |
Valfria parametrar. |
| QuotaOperations |
Gränssnitt som representerar en kvotåtgärd. |
| QuotaProperties |
Kvotegenskaper för resursen. |
| QuotaRequestDetails |
Information om kvotbegäran. |
| QuotaRequestProperties |
Information om kvotbegäran. |
| QuotaRequestStatusGetOptionalParams |
Valfria parametrar. |
| QuotaRequestStatusListOptionalParams |
Valfria parametrar. |
| QuotaRequestStatusOperations |
Gränssnitt som representerar en QuotaRequestStatus-åtgärd. |
| 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. |
| 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 post. Används under återbetalningen för att beräkna återbetalningsgränsen. Skatt ingår inte. Detta är låst pris 30 dagar före förfallodatum. |
| ReservationArchiveOptionalParams |
Valfria parametrar. |
| ReservationAvailableScopesOptionalParams |
Valfria parametrar. |
| ReservationGetOptionalParams |
Valfria parametrar. |
| ReservationListAllOptionalParams |
Valfria parametrar. |
| ReservationListOptionalParams |
Valfria parametrar. |
| ReservationListRevisionsOptionalParams |
Valfria parametrar. |
| ReservationMergeOptionalParams |
Valfria parametrar. |
| ReservationMergeProperties |
Egenskaper för reservationssammanslagning |
| ReservationOperations |
Gränssnitt som representerar en reservationsoperation. |
| ReservationOrderBillingPlanInformation |
Information som beskriver typen av faktureringsplan för den här reservationen. |
| ReservationOrderCalculateOptionalParams |
Valfria parametrar. |
| ReservationOrderChangeDirectoryOptionalParams |
Valfria parametrar. |
| ReservationOrderGetOptionalParams |
Valfria parametrar. |
| ReservationOrderListOptionalParams |
Valfria parametrar. |
| ReservationOrderOperations |
Gränssnitt som representerar en ReservationOrder-operation. |
| ReservationOrderProperties |
Egenskaper för en reservationsorder. |
| ReservationOrderPurchaseOptionalParams |
Valfria parametrar. |
| ReservationOrderResponse |
Information om en reservationsbeställning som returneras. |
| ReservationResponse |
Definitionen av reservationen. |
| ReservationSplitOptionalParams |
Valfria parametrar. |
| ReservationSplitProperties |
Egenskaper för reservationsdelning |
| ReservationSummary |
Sammanfattningen av antalet reservationer i varje tillstånd |
| ReservationSwapProperties |
Egenskaper för reservationsbyte |
| 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. |
| ReservationUpdateOptionalParams |
Valfria parametrar. |
| ReservationUtilizationAggregates |
Aggregerade värden för reservationsanvändning |
| 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. |
| RestorePollerOptions | |
| ReturnOperations |
Gränssnitt som representerar en Return-operation. |
| ReturnPostOptionalParams |
Valfria parametrar. |
| SavingsPlanPurchaseRequest |
Begärandetext för köp av sparplan |
| SavingsPlanPurchaseRequestProperties |
Egenskaper vid köp av en sparplan |
| SavingsPlanToPurchaseCalculateExchange |
Information om köp av sparplan |
| SavingsPlanToPurchaseExchange |
Information om köp av sparplan |
| ScopeProperties |
Omfånget och om det är giltigt. |
| ServiceError |
API-felinformationen. |
| ServiceErrorDetail |
Felinformationen. |
| SimplePollerLike |
En enkel pollerare som kan användas för att avsöka en tidskrävande åtgärd. |
| SkuCapability |
Kapacitet för en sku. |
| SkuName |
Namnet på sku |
| SkuProperty |
Egenskapen för en sku. |
| SkuRestriction |
Begränsning av en sku. |
| SplitProperties |
Fastigheter för reservdelning |
| SplitRequest |
Begäran om reservationsdelning |
| SubRequest |
Den underbegäran som skickats med kvotbegäran. |
| SubscriptionScopeProperties |
Omfången som kontrolleras av det tillgängliga omfångs-API:et. |
| SystemData |
Metadata som rör skapande och senaste ändring av resursen. |
Typalias
| AppliedScopeType |
Typ av tillämpat omfång. Kända värden som stöds av tjänsten
Singel: Singel |
| AzureSupportedClouds |
De värden som stöds för molninställningen som en strängliteraltyp |
| BillingPlan |
Representerar faktureringsplanen i ISO 8601-format. Krävs endast för månatliga faktureringsplaner. Kända värden som stöds av tjänstenP1M: P1M |
| CalculateExchangeOperationResultStatus |
Status för åtgärden. Kända värden som stöds av tjänsten
Lyckades: Lyckades |
| CommitmentGrain |
Åtagandeintervall. Kända värden som stöds av tjänstenTim: Timvis |
| ContinuablePage |
Ett gränssnitt som beskriver en resultatsida. |
| CreatedByType |
Den typ av entitet som skapade resursen. Kända värden som stöds av tjänsten
Användare: Entiteten skapades av en användare. |
| ErrorResponseCode |
Felkod som beskriver anledningen till att tjänsten inte kan behandla den inkommande förfrågan Kända värden som stöds av tjänsten
InteSpecificerat: InteSpecificerat |
| ExchangeOperationResultStatus |
Status för åtgärden. Kända värden som stöds av tjänsten
Lyckades: Lyckades |
| InstanceFlexibility |
Om du aktiverar detta tillämpas reservationsrabatten på andra virtuella datorer i samma vm-storleksgrupp. Ange endast reserverad resurstyp för VirtualMachines. Kända värden som stöds av tjänsten
På: På |
| OperationStatus |
Status för den enskilda åtgärden. Kända värden som stöds av tjänsten
Lyckades: Lyckades |
| PaymentStatus |
Beskriver om betalningen har slutförts, misslyckats, avbrutits eller schemalagts i framtiden. Kända värden som stöds av tjänsten
Lyckades: Lyckades |
| ProvisioningState |
Representerar det aktuella tillståndet för reservationen. Kända värden som stöds av tjänsten
Skapa: Skapa |
| QuotaRequestState |
Status för kvotbegäran. Kända värden som stöds av tjänsten
Accepterad: Accepterad |
| ReservationBillingPlan |
Representera faktureringsplanerna. Kända värden som stöds av tjänsten
Direkt: Direkt |
| ReservationStatusCode |
Typ av reservationStatusCode |
| ReservationTerm |
Representera reservationsperioden. Kända värden som stöds av tjänsten
P1Y: P1Y |
| ReservedResourceType |
Typen av resurs som reserveras. Förutom nedanstående typer har vi även lagt till följande: OpenAIPTU, MDC, Sentinel. Kända värden som stöds av tjänsten
VirtualMachines: VirtualMachines |
| ResourceType |
Resurstyperna. Kända värden som stöds av tjänsten
Standard: Standard |
| SavingsPlanTerm |
Representera sparplansperioden i ISO 8601-format. Kända värden som stöds av tjänsten
P1Y: P1Y |
Uppräkningar
| AzureClouds |
En uppräkning för att beskriva Azure Cloud-miljöer. |
| KnownAppliedScopeType |
Typ av tillämpat omfång. |
| KnownBillingPlan |
Representerar faktureringsplanen i ISO 8601-format. Krävs endast för månatliga faktureringsplaner. |
| KnownCalculateExchangeOperationResultStatus |
Status för åtgärden. |
| KnownCommitmentGrain |
Åtagandeintervall. |
| KnownCreatedByType |
Den typ av entitet som skapade resursen. |
| KnownErrorResponseCode |
Felkod som beskriver orsaken till att tjänsten inte kan bearbeta den inkommande begäran |
| KnownExchangeOperationResultStatus |
Status för åtgärden. |
| KnownInstanceFlexibility |
Om du aktiverar detta tillämpas reservationsrabatten på andra virtuella datorer i samma vm-storleksgrupp. Ange endast reserverad resurstyp för VirtualMachines. |
| KnownOperationStatus |
Status för den enskilda åtgärden. |
| KnownPaymentStatus |
Beskriver om betalningen har slutförts, misslyckats, avbrutits eller schemalagts i framtiden. |
| KnownProvisioningState |
Representerar det aktuella tillståndet för reservationen. |
| KnownQuotaRequestState |
Status för kvotbegäran. |
| KnownReservationBillingPlan |
Representera faktureringsplanerna. |
| KnownReservationStatusCode |
Kända värden för ReservationStatusCode som tjänsten accepterar. |
| KnownReservationTerm |
Representera reservationsperioden. |
| KnownReservedResourceType |
Typen av resurs som reserveras. Förutom nedanstående typer har vi även lagt till följande: OpenAIPTU, MDC, Sentinel. |
| KnownResourceType |
Resurstyperna. |
| KnownSavingsPlanTerm |
Representera sparplansperioden i ISO 8601-format. |
Funktioner
| is |
Typeguard för RestError |
| restore |
Skapar en poller från det serialiserade tillståndet för en annan poller. Detta kan vara användbart när du vill skapa pollers på en annan värd eller om en poller måste konstrueras när den ursprungliga inte finns i omfånget. |
Variabler
| Rest |
En anpassad feltyp för misslyckade pipelinebegäranden. |
Funktionsinformation
isRestError(unknown)
Typeguard för RestError
function isRestError(e: unknown): e
Parametrar
- e
-
unknown
Något som fångas av en fångstklausul.
Returer
e
restorePoller<TResponse, TResult>(AzureReservationAPI, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)
Skapar en poller från det serialiserade tillståndet för en annan poller. Detta kan vara användbart när du vill skapa pollers på en annan värd eller om en poller måste konstrueras när den ursprungliga inte finns i omfånget.
function restorePoller<TResponse, TResult>(client: AzureReservationAPI, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>
Parametrar
- client
- AzureReservationAPI
- serializedState
-
string
- sourceOperation
-
(args: any[]) => PollerLike<OperationState<TResult>, TResult>
- options
-
RestorePollerOptions<TResult, PathUncheckedResponse>
Returer
PollerLike<OperationState<TResult>, TResult>
Variabelinformation
RestError
En anpassad feltyp för misslyckade pipelinebegäranden.
RestError: RestErrorConstructor