@azure/arm-reservations package
Třídy
| AzureReservationAPI |
Rozhraní
| AppliedReservationList |
Stránkovaný seznam použitých rezervací |
| AppliedReservations |
Odpověď pro použité rozhraní API rezervací |
| AppliedReservationsProperties |
Vlastnosti pro aplikované rezervace vrácené |
| AppliedScopeProperties |
Vlastnosti specifické pro použitý typ oboru Není vyžadováno, pokud není k dispozici. Vyžaduje se a je potřeba zadat id tenanta a managementGroupId, pokud je AppliedScopeType managementGroup. |
| AvailableScopeProperties |
Odpověď dostupného rozhraní API oboru obsahující obory a jejich eligibility. |
| AvailableScopeRequest |
Dostupný obor |
| AvailableScopeRequestProperties |
Dostupné vlastnosti žádosti o obor |
| AzureReservationAPIOptionalParams |
Volitelné parametry pro klienta. |
| BillingInformation |
fakturační údaje |
| CalculateExchangeOperationResultResponse |
Výsledek operace CalculateExchange |
| CalculateExchangeOperations |
Rozhraní reprezentující operace CalculateExchange. |
| CalculateExchangePostOptionalParams |
Volitelné parametry. |
| CalculateExchangeRequest |
Výpočet žádosti o výměnu |
| CalculateExchangeRequestProperties |
Výpočet vlastností žádosti o výměnu |
| CalculateExchangeResponseProperties |
Vlastnosti odpovědi CalculateExchange |
| CalculatePriceResponse |
Odpověď na výpočet ceny rezervace. |
| CalculatePriceResponseProperties |
Vlastnosti pro výpočet odpovědi na cenu |
| CalculatePriceResponsePropertiesBillingCurrencyTotal |
Měna a částka, které se zákazníkovi budou účtovat v místní měně zákazníka. Daň není zahrnuta. |
| CalculatePriceResponsePropertiesPricingCurrencyTotal |
Částka, kterou Microsoft používá pro záznam. Používá se během refundace pro výpočet limitu refundace. Daň není zahrnuta. |
| CalculateRefundOperations |
Rozhraní reprezentující operaci CalculateRefund. |
| CalculateRefundPostOptionalParams |
Volitelné parametry. |
| CalculateRefundRequest |
Žádost obsahující informace potřebné k výpočtu refundace |
| CalculateRefundRequestProperties |
Vlastnosti potřebné pro výpočet refundace, včetně rozsahu a rezervace, která se má vrátit. |
| CalculateRefundResponse |
Odpověď na výpočet refundace obsahující informace o refundaci rezervace |
| Catalog |
Podrobnosti o produktu typu prostředku |
| CatalogMsrp |
Informace o cenách skladové položky |
| ChangeDirectoryRequest |
Text žádosti o změnu adresáře rezervace |
| ChangeDirectoryResponse |
Změna odpovědi adresáře |
| ChangeDirectoryResult |
Změna výsledku adresáře pro objednávku rezervace nebo rezervaci |
| Commitment |
Závazek k výhodě. |
| CurrentQuotaLimitBase |
Vlastnosti kvóty. |
| ErrorDetails |
Podrobnosti o chybě. |
| ErrorModel |
Informace o chybě |
| ErrorResponse |
Chybová odpověď značí, že služba nemůže zpracovat příchozí požadavek. Důvod je uvedený v chybové zprávě. |
| ExceptionResponse |
Chyba rozhraní API. |
| ExchangeOperationResultResponse |
Výsledek operace výměny |
| ExchangeOperations |
Rozhraní reprezentující operace Exchange. |
| ExchangePolicyError |
podrobnosti o chybě |
| ExchangePolicyErrors |
Chyby zásad Exchange |
| ExchangePostOptionalParams |
Volitelné parametry. |
| ExchangeRequest |
Žádost exchange |
| ExchangeRequestProperties |
Vlastnosti požadavku Exchange |
| ExchangeResponseProperties |
Vlastnosti odpovědi exchange |
| ExtendedErrorInfo |
Rozšířené informace o chybách, včetně kódu chyby a chybové zprávy |
| ExtendedStatusInfo |
modelové rozhraní ExtendedStatusInfo |
| GetAppliedReservationListOptionalParams |
Volitelné parametry. |
| GetCatalogOptionalParams |
Volitelné parametry. |
| MergeProperties |
Nemovitosti pro sloučení rezervací |
| MergeRequest |
Žádost o sloučení rezervací |
| OperationDisplay |
Informace o operaci |
| OperationListOptionalParams |
Volitelné parametry. |
| OperationOperations |
Rozhraní reprezentující operaci Operace. |
| OperationResponse |
Odpověď obsahující informace o operaci |
| OperationResultError |
Vyžaduje se, pokud stav == selhal nebo stav == zrušen. |
| PageSettings |
Možnosti pro metodu byPage |
| PagedAsyncIterableIterator |
Rozhraní, které umožňuje asynchronní iteraci k dokončení i po stránce. |
| Patch |
Žádost o opravu rezervace |
| PatchProperties |
Vlastnosti rezervačního patche |
| PatchPropertiesRenewProperties |
modelové rozhraní PatchPropertiesRenewProperties |
| PaymentDetail |
Informace o platbě související s objednávkou rezervace |
| Price |
Informace o cenách obsahující částku a kód měny |
| ProxyResource |
Definice modelu prostředků pro prostředek proxy serveru Azure Resource Manageru. Nebude obsahovat značky a umístění. |
| PurchaseRequest |
Žádost o nákup rezervace |
| PurchaseRequestProperties |
Vlastnosti žádosti o nákup rezervace |
| PurchaseRequestPropertiesReservedResourceProperties |
Vlastnosti specifické pro každý rezervovaný typ prostředku. Není vyžadováno, pokud není k dispozici. |
| QuotaCreateOrUpdateOptionalParams |
Volitelné parametry. |
| QuotaGetOptionalParams |
Volitelné parametry. |
| QuotaListOptionalParams |
Volitelné parametry. |
| QuotaOperations |
Rozhraní reprezentující Quota operace. |
| QuotaProperties |
Vlastnosti kvóty pro prostředek. |
| QuotaRequestDetails |
Podrobnosti žádosti o kvótu |
| QuotaRequestProperties |
Podrobnosti žádosti o kvótu |
| QuotaRequestStatusGetOptionalParams |
Volitelné parametry. |
| QuotaRequestStatusListOptionalParams |
Volitelné parametry. |
| QuotaRequestStatusOperations |
Rozhraní představující operace QuotaRequestStatus. |
| QuotaUpdateOptionalParams |
Volitelné parametry. |
| RefundBillingInformation |
fakturační údaje |
| RefundPolicyError |
podrobnosti o chybě |
| RefundPolicyResult |
Výsledek zásad refundace |
| RefundPolicyResultProperty |
Vlastnost výsledku zásady refundace |
| RefundRequest |
Žádost obsahující informace potřebné k vrácení rezervace. |
| RefundRequestProperties |
Vlastnosti potřebné pro žádost o refundaci, včetně ID relace z výpočtu refundace, rozsahu, rezervace, která se má vrátit, a důvodu vrácení. |
| RefundResponseProperties |
Vlastnosti refundace rezervace |
| RenewPropertiesResponse |
Obnovte vlastnosti rezervace. |
| RenewPropertiesResponseBillingCurrencyTotal |
Měna a částka, které se zákazníkovi budou účtovat v místní měně zákazníka za nákup prodlužování platnosti. Daň není zahrnuta. |
| RenewPropertiesResponsePricingCurrencyTotal |
Částka, kterou Microsoft používá pro záznam. Používá se během refundace pro výpočet limitu refundace. Daň není zahrnuta. Tato cena je uzamčena 30 dní před vypršením platnosti. |
| ReservationArchiveOptionalParams |
Volitelné parametry. |
| ReservationAvailableScopesOptionalParams |
Volitelné parametry. |
| ReservationGetOptionalParams |
Volitelné parametry. |
| ReservationListAllOptionalParams |
Volitelné parametry. |
| ReservationListOptionalParams |
Volitelné parametry. |
| ReservationListRevisionsOptionalParams |
Volitelné parametry. |
| ReservationMergeOptionalParams |
Volitelné parametry. |
| ReservationMergeProperties |
Vlastnosti sloučení rezervací |
| ReservationOperations |
Rozhraní reprezentující operace rezervace. |
| ReservationOrderBillingPlanInformation |
Informace popisující typ fakturačního plánu pro tuto rezervaci |
| ReservationOrderCalculateOptionalParams |
Volitelné parametry. |
| ReservationOrderChangeDirectoryOptionalParams |
Volitelné parametry. |
| ReservationOrderGetOptionalParams |
Volitelné parametry. |
| ReservationOrderListOptionalParams |
Volitelné parametry. |
| ReservationOrderOperations |
Rozhraní reprezentující operace ReservationOrder. |
| ReservationOrderProperties |
Vlastnosti rezervačního příkazu. |
| ReservationOrderPurchaseOptionalParams |
Volitelné parametry. |
| ReservationOrderResponse |
Podrobnosti o vrácené objednávce rezervace |
| ReservationResponse |
Definice rezervace. |
| ReservationSplitOptionalParams |
Volitelné parametry. |
| ReservationSplitProperties |
Vlastnosti rozdělení rezervace |
| ReservationSummary |
Souhrn souhrnného počtu rezervací v jednotlivých stavech |
| ReservationSwapProperties |
Vlastnosti prohození rezervací |
| ReservationToExchange |
Podrobnosti o refundaci rezervací |
| ReservationToPurchaseCalculateExchange |
Podrobnosti o nákupu rezervace |
| ReservationToPurchaseExchange |
Podrobnosti o nákupu rezervace |
| ReservationToReturn |
Rezervace k vrácení |
| ReservationToReturnForExchange |
Podrobnosti o refundaci rezervací |
| ReservationUnarchiveOptionalParams |
Volitelné parametry. |
| ReservationUpdateOptionalParams |
Volitelné parametry. |
| ReservationUtilizationAggregates |
Agregované hodnoty využití rezervací |
| ReservationsProperties |
Vlastnosti rezervací |
| ReservationsPropertiesUtilization |
Využití rezervací |
| Resource |
Běžná pole vrácená v odpovědi pro všechny prostředky Azure Resource Manageru |
| ResourceName |
Název prostředku poskytnutý poskytovatelem prostředků Tuto vlastnost použijte pro parametr quotaRequest. |
| RestorePollerOptions | |
| ReturnOperations |
Rozhraní reprezentující operace Return. |
| ReturnPostOptionalParams |
Volitelné parametry. |
| SavingsPlanPurchaseRequest |
Text žádosti o nákup plánu úspor |
| SavingsPlanPurchaseRequestProperties |
Nemovitosti při nákupu spořicího plánu |
| SavingsPlanToPurchaseCalculateExchange |
Podrobnosti o nákupu plánu Úspory |
| SavingsPlanToPurchaseExchange |
Podrobnosti o nákupu plánu Úspory |
| ScopeProperties |
Obor a zda je platný. |
| ServiceError |
Podrobnosti o chybě rozhraní API |
| ServiceErrorDetail |
Podrobnosti o chybě. |
| SimplePollerLike |
Jednoduchý poller, který lze použít k dotazování dlouhotrvající operace. |
| SkuCapability |
Schopnost skladové položky. |
| SkuName |
Název skladové položky |
| SkuProperty |
Vlastnost skladové položky. |
| SkuRestriction |
Omezení skladové položky. |
| SplitProperties |
Nemovitosti pro rozdělení rezervací |
| SplitRequest |
Žádost o rozdělení rezervace |
| SubRequest |
Podžádka odeslaná s žádostí o kvótu. |
| SubscriptionScopeProperties |
Obory, které kontroluje dostupné rozhraní API oboru. |
| SystemData |
Metadata týkající se vytvoření a poslední změny prostředku. |
Aliasy typu
| AppliedScopeType |
Typ použitého oboru. Známé hodnoty podporované službou
Singl: Singl |
| AzureSupportedClouds |
Podporované hodnoty pro nastavení cloudu jako typ řetězcového literálu |
| BillingPlan |
Představuje fakturační plán ve formátu ISO 8601. Vyžaduje se jenom pro měsíční fakturační plány. Známé hodnoty podporované službouP1M: P1M |
| CalculateExchangeOperationResultStatus |
Stav operace. Známé hodnoty podporované službou
Uspěl: Uspěl |
| CommitmentGrain |
Agregační interval závazku. Známé hodnoty podporované službouHodinová: Hodinová |
| ContinuablePage |
Rozhraní, které popisuje stránku výsledků. |
| CreatedByType |
Druh entity, která prostředek vytvořila. Známé hodnoty podporované službou
user: Entita byla vytvořena uživatelem. |
| ErrorResponseCode |
Chybový kód popisující důvod, proč služba není schopna zpracovat příchozí požadavek Známé hodnoty podporované službou
Nespecifikováno: Nespecifikováno |
| ExchangeOperationResultStatus |
Stav operace. Známé hodnoty podporované službou
Uspěl: Uspěl |
| InstanceFlexibility |
Zapnutím tohoto nastavení se sleva za rezervaci uplatní na jiné virtuální počítače ve stejné skupině velikostí virtuálních počítačů. Zadejte pouze pro typ rezervovaného prostředku VirtualMachines. Známé hodnoty podporované službou
Zapnuto: Zapnuto |
| OperationStatus |
Stav jednotlivé operace. Známé hodnoty podporované službou
Uspěl: Uspěl |
| PaymentStatus |
Popisuje, jestli je platba dokončená, neúspěšná, zrušená nebo naplánovaná v budoucnu. Známé hodnoty podporované službou
Uspěl: Uspěl |
| ProvisioningState |
Představuje aktuální stav rezervace. Známé hodnoty podporované službou
Vytváření: Vytváření |
| QuotaRequestState |
Stav žádosti o kvótu. Známé hodnoty podporované službou
Přijato: Přijato |
| ReservationBillingPlan |
Představuje fakturační plány. Známé hodnoty podporované službou
Upfront: Upfront |
| ReservationStatusCode |
Typ ReservationStatusCode |
| ReservationTerm |
Představuje období rezervace. Známé hodnoty podporované službou
P1Y: P1Y |
| ReservedResourceType |
Typ rezervovaného prostředku. Kromě níže uvedených typů jsme přidali také následující: OpenAIPTU, MDC, Sentinel. Známé hodnoty podporované službou
VirtualMachines: VirtualMachines |
| ResourceType |
Typy zdrojů. Známé hodnoty podporované službou
Standard: Standard |
| SavingsPlanTerm |
Představuje termín plánu úspor ve formátu ISO 8601. Známé hodnoty podporované službou
P1Y: P1Y |
Výčty
| AzureClouds |
Výčet popisující cloudová prostředí Azure. |
| KnownAppliedScopeType |
Typ použitého oboru. |
| KnownBillingPlan |
Představuje fakturační plán ve formátu ISO 8601. Vyžaduje se jenom pro měsíční fakturační plány. |
| KnownCalculateExchangeOperationResultStatus |
Stav operace. |
| KnownCommitmentGrain |
Agregační interval závazku. |
| KnownCreatedByType |
Druh entity, která prostředek vytvořila. |
| KnownErrorResponseCode |
Kód chyby popisující důvod, proč služba nemůže zpracovat příchozí požadavek |
| KnownExchangeOperationResultStatus |
Stav operace. |
| KnownInstanceFlexibility |
Zapnutím tohoto nastavení se sleva za rezervaci uplatní na jiné virtuální počítače ve stejné skupině velikostí virtuálních počítačů. Zadejte pouze pro typ rezervovaného prostředku VirtualMachines. |
| KnownOperationStatus |
Stav jednotlivé operace. |
| KnownPaymentStatus |
Popisuje, jestli je platba dokončená, neúspěšná, zrušená nebo naplánovaná v budoucnu. |
| KnownProvisioningState |
Představuje aktuální stav rezervace. |
| KnownQuotaRequestState |
Stav žádosti o kvótu. |
| KnownReservationBillingPlan |
Představuje fakturační plány. |
| KnownReservationStatusCode |
Známé hodnoty ReservationStatusCode, které služba přijímá. |
| KnownReservationTerm |
Představuje období rezervace. |
| KnownReservedResourceType |
Typ rezervovaného prostředku. Kromě níže uvedených typů jsme přidali také následující: OpenAIPTU, MDC, Sentinel. |
| KnownResourceType |
Typy zdrojů. |
| KnownSavingsPlanTerm |
Představuje termín plánu úspor ve formátu ISO 8601. |
Funkce
| is |
Typeguard pro RestError |
| restore |
Vytvoří poller ze serializovaného stavu jiného polleru. To může být užitečné v případě, že chcete vytvořit pollery na jiném hostiteli nebo je třeba vytvořit poller po původním dotazu, který není v rozsahu. |
Proměnné
| Rest |
Vlastní typ chyby pro neúspěšné požadavky kanálu. |
Podrobnosti funkce
isRestError(unknown)
Typeguard pro RestError
function isRestError(e: unknown): e
Parametry
- e
-
unknown
Něco zachyceného klauzulí catch.
Návraty
e
restorePoller<TResponse, TResult>(AzureReservationAPI, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)
Vytvoří poller ze serializovaného stavu jiného polleru. To může být užitečné v případě, že chcete vytvořit pollery na jiném hostiteli nebo je třeba vytvořit poller po původním dotazu, který není v rozsahu.
function restorePoller<TResponse, TResult>(client: AzureReservationAPI, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>
Parametry
- client
- AzureReservationAPI
- serializedState
-
string
- sourceOperation
-
(args: any[]) => PollerLike<OperationState<TResult>, TResult>
- options
-
RestorePollerOptions<TResult, PathUncheckedResponse>
Návraty
PollerLike<OperationState<TResult>, TResult>
Podrobnosti proměnné
RestError
Vlastní typ chyby pro neúspěšné požadavky kanálu.
RestError: RestErrorConstructor