@azure/arm-reservations package
Klassen
| AzureReservationAPI |
Schnittstellen
| AppliedReservationList |
Paginierte Liste der angewendeten Reservierungen |
| AppliedReservations |
Die Antwort für die angewendete Reservierungs-API |
| AppliedReservationsProperties |
Immobilien für beantragte Reservierungen zurückgegeben |
| AppliedScopeProperties |
Eigenschaften, die für den angewendeten Bereichstyp spezifisch sind. Nicht erforderlich, falls nicht zutreffend. Erforderlich und muss tenantId und managementGroupId bereitstellen, wenn AppliedScopeType managementGroup ist |
| AvailableScopeProperties |
Die Antwort der verfügbaren Bereichs-API, die Bereiche und deren Berechtigungen enthält. |
| AvailableScopeRequest |
Verfügbarer Bereich |
| AvailableScopeRequestProperties |
Verfügbare Bereichsanforderungseigenschaften |
| AzureReservationAPIOptionalParams |
Optionale Parameter für den Client. |
| BillingInformation |
Abrechnungsinformationen |
| CalculateExchangeOperationResultResponse |
CalculateExchange-Vorgangsergebnis |
| CalculateExchangeOperations |
Schnittstelle, die eine CalculateExchange-Operationen darstellt. |
| CalculateExchangePostOptionalParams |
Optionale Parameter. |
| CalculateExchangeRequest |
Berechnen der Exchange-Anforderung |
| CalculateExchangeRequestProperties |
Berechnen von Exchange-Anforderungseigenschaften |
| CalculateExchangeResponseProperties |
CalculateExchange-Antworteigenschaften |
| CalculatePriceResponse |
Die Antwort des berechneten Preises für die Reservierung. |
| CalculatePriceResponseProperties |
Eigenschaften für die Berechnung der Preisantwort |
| CalculatePriceResponsePropertiesBillingCurrencyTotal |
Währung und Betrag, den der Kunde in der lokalen Währung des Kunden in Rechnung gestellt wird. Steuer ist nicht inbegriffen. |
| CalculatePriceResponsePropertiesPricingCurrencyTotal |
Betrag, den Microsoft für Datensatz verwendet. Wird während der Rückerstattung für die Berechnung des Erstattungslimits verwendet. Steuer ist nicht inbegriffen. |
| CalculateRefundOperations |
Schnittstelle, die eine CalculateRefund-Operation darstellt. |
| CalculateRefundPostOptionalParams |
Optionale Parameter. |
| CalculateRefundRequest |
Anforderung mit Informationen, die für die Berechnung der Rückerstattung erforderlich sind. |
| CalculateRefundRequestProperties |
Eigenschaften, die für die Berechnung der Rückerstattung erforderlich sind, einschließlich des Umfangs und der Reservierung, die zurückgegeben werden soll. |
| CalculateRefundResponse |
Die Antwort der Berechnung der Rückerstattung, die Erstattungsinformationen der Reservierung enthält |
| Catalog |
Produktdetails eines Ressourcentyps. |
| CatalogMsrp |
Preisinformationen zur Sku |
| ChangeDirectoryRequest |
Anforderungstext für das Änderungsverzeichnis einer Reservierung. |
| ChangeDirectoryResponse |
Ändern der Verzeichnisantwort |
| ChangeDirectoryResult |
Ändern des Verzeichnisergebnisses für Reservierungsauftrag oder Reservierung |
| Commitment |
Verpflichtung zum Nutzen. |
| CurrentQuotaLimitBase |
Kontingenteigenschaften. |
| ErrorDetails |
Die Details des Fehlers. |
| ErrorModel |
Fehlerinformationen |
| ErrorResponse |
Fehlerantwort gibt an, dass der Dienst die eingehende Anforderung nicht verarbeiten kann. Der Grund wird in der Fehlermeldung angegeben. |
| ExceptionResponse |
Der API-Fehler. |
| ExchangeOperationResultResponse |
Exchange-Vorgangsergebnis |
| ExchangeOperations |
Schnittstelle stellt eine Exchange-Operation dar. |
| ExchangePolicyError |
Fehlerdetails |
| ExchangePolicyErrors |
Exchange-Richtlinienfehler |
| ExchangePostOptionalParams |
Optionale Parameter. |
| ExchangeRequest |
Exchange-Anforderung |
| ExchangeRequestProperties |
Exchange-Anforderungseigenschaften |
| ExchangeResponseProperties |
Exchange-Antworteigenschaften |
| ExtendedErrorInfo |
Erweiterte Fehlerinformationen einschließlich Fehlercode und Fehlermeldung |
| ExtendedStatusInfo |
Modellschnittstelle: ExtendedStatusInfo |
| GetAppliedReservationListOptionalParams |
Optionale Parameter. |
| GetCatalogOptionalParams |
Optionale Parameter. |
| MergeProperties |
Immobilien für Reservierungszusammenlegung |
| MergeRequest |
Die Anfrage zur Reservierungszusammenführung |
| OperationDisplay |
Informationen zu einem Vorgang |
| OperationListOptionalParams |
Optionale Parameter. |
| OperationOperations |
Schnittstelle, die eine Operation darstellt. |
| OperationResponse |
Die Antwort, die Vorgangsinformationen enthält |
| OperationResultError |
Erforderlich, wenn der Status == fehlgeschlagen oder status == abgebrochen. |
| PageSettings |
Optionen für die byPage-Methode |
| PagedAsyncIterableIterator |
Eine Schnittstelle, die eine asynchrone iterierbare Iteration sowohl zum Abschluss als auch nach Seite ermöglicht. |
| Patch |
Die Anforderung des Reservierungspatches |
| PatchProperties |
Eigenschaften für den Reservation Patch |
| PatchPropertiesRenewProperties |
Modellschnittstellen PatchPropertiesRenewProperties |
| PaymentDetail |
Informationen zur Zahlung im Zusammenhang mit einer Reservierungsbestellung. |
| Price |
Preisinformationen, die den Betrag und den Währungscode enthalten |
| ProxyResource |
Die Ressourcenmodelldefinition für eine Azure Resource Manager-Proxyressource. Es enthält keine Tags und einen Speicherort. |
| PurchaseRequest |
Die Anfrage zum Reservierungskauf |
| PurchaseRequestProperties |
Eigenschaften des Reservierungskaufs |
| PurchaseRequestPropertiesReservedResourceProperties |
Eigenschaften, die für jeden reservierten Ressourcentyp spezifisch sind. Nicht erforderlich, falls nicht zutreffend. |
| QuotaCreateOrUpdateOptionalParams |
Optionale Parameter. |
| QuotaGetOptionalParams |
Optionale Parameter. |
| QuotaListOptionalParams |
Optionale Parameter. |
| QuotaOperations |
Schnittstelle, die eine Quota-Operation darstellt. |
| QuotaProperties |
Kontingenteigenschaften für die Ressource. |
| QuotaRequestDetails |
Details der Kontingentanforderung. |
| QuotaRequestProperties |
Die Details der Kontingentanforderung. |
| QuotaRequestStatusGetOptionalParams |
Optionale Parameter. |
| QuotaRequestStatusListOptionalParams |
Optionale Parameter. |
| QuotaRequestStatusOperations |
Schnittstelle, die einen QuotaRequestStatus-Vorgang darstellt. |
| QuotaUpdateOptionalParams |
Optionale Parameter. |
| RefundBillingInformation |
Abrechnungsinformationen |
| RefundPolicyError |
Fehlerdetails |
| RefundPolicyResult |
Ergebnis der Rückerstattungsrichtlinie |
| RefundPolicyResultProperty |
Ergebniseigenschaft der Rückerstattungsrichtlinie |
| RefundRequest |
Anfrage mit Informationen, die für die Rückgabe der Reservierung erforderlich sind. |
| RefundRequestProperties |
Eigenschaften, die für erstattungsanforderung erforderlich sind, einschließlich der Sitzungs-ID aus der Berechnung der Rückerstattung, des Umfangs, der zurückzugebenden Reservierung und des Rückgabegrundes. |
| RefundResponseProperties |
Die Erstattungseigenschaften der Reservierung |
| RenewPropertiesResponse |
Die Verlängerungseigenschaften für eine Reservierung. |
| RenewPropertiesResponseBillingCurrencyTotal |
Währung und Betrag, den der Kunde in der lokalen Währung des Kunden für den Verlängerungskauf in Rechnung gestellt wird. Steuer ist nicht inbegriffen. |
| RenewPropertiesResponsePricingCurrencyTotal |
Betrag, den Microsoft für Datensatz verwendet. Wird während der Rückerstattung für die Berechnung des Erstattungslimits verwendet. Steuer ist nicht inbegriffen. Dieser Preis ist 30 Tage vor Ablauf gesperrt. |
| ReservationArchiveOptionalParams |
Optionale Parameter. |
| ReservationAvailableScopesOptionalParams |
Optionale Parameter. |
| ReservationGetOptionalParams |
Optionale Parameter. |
| ReservationListAllOptionalParams |
Optionale Parameter. |
| ReservationListOptionalParams |
Optionale Parameter. |
| ReservationListRevisionsOptionalParams |
Optionale Parameter. |
| ReservationMergeOptionalParams |
Optionale Parameter. |
| ReservationMergeProperties |
Eigenschaften der Reservierungszusammenführung |
| ReservationOperations |
Schnittstelle stellt die Reservierungsoperationen dar. |
| ReservationOrderBillingPlanInformation |
Informationen zur Beschreibung der Art des Abrechnungsplans für diese Reservierung. |
| ReservationOrderCalculateOptionalParams |
Optionale Parameter. |
| ReservationOrderChangeDirectoryOptionalParams |
Optionale Parameter. |
| ReservationOrderGetOptionalParams |
Optionale Parameter. |
| ReservationOrderListOptionalParams |
Optionale Parameter. |
| ReservationOrderOperations |
Schnittstelle stellt eine ReservationOrder-Operation dar. |
| ReservationOrderProperties |
Eigenschaften einer Reservierungsanordnung. |
| ReservationOrderPurchaseOptionalParams |
Optionale Parameter. |
| ReservationOrderResponse |
Details einer Reservierungsbestellung, die zurückgegeben wird. |
| ReservationResponse |
Die Definition der Reservierung. |
| ReservationSplitOptionalParams |
Optionale Parameter. |
| ReservationSplitProperties |
Eigenschaften der Reservierung geteilt |
| ReservationSummary |
Die Zusammenfassung der Rollup-Anzahl der Reservierungen in jedem Bundesland |
| ReservationSwapProperties |
Eigenschaften des Reservierungstauschs |
| ReservationToExchange |
Reservierungsrückerstattungsdetails |
| ReservationToPurchaseCalculateExchange |
Reservierungskaufdetails |
| ReservationToPurchaseExchange |
Reservierungskaufdetails |
| ReservationToReturn |
Reservierung zurück |
| ReservationToReturnForExchange |
Reservierungsrückerstattungsdetails |
| ReservationUnarchiveOptionalParams |
Optionale Parameter. |
| ReservationUpdateOptionalParams |
Optionale Parameter. |
| ReservationUtilizationAggregates |
Die Aggregatwerte der Reservierungsnutzung |
| ReservationsProperties |
Die Eigenschaften der Reservierungen |
| ReservationsPropertiesUtilization |
Reservierungsnutzung |
| Resource |
Allgemeine Felder, die in der Antwort für alle Azure Resource Manager-Ressourcen zurückgegeben werden |
| ResourceName |
Vom Ressourcenanbieter bereitgestellter Ressourcenname. Verwenden Sie diese Eigenschaft für den parameter "quotaRequest". |
| RestorePollerOptions | |
| ReturnOperations |
Schnittstelle repräsentiert Rückgabeoperationen. |
| ReturnPostOptionalParams |
Optionale Parameter. |
| SavingsPlanPurchaseRequest |
Anforderungstext für den Kauf eines Sparplans |
| SavingsPlanPurchaseRequestProperties |
Immobilien eines Sparplans |
| SavingsPlanToPurchaseCalculateExchange |
Details zum Kauf eines Sparplans |
| SavingsPlanToPurchaseExchange |
Details zum Kauf eines Sparplans |
| ScopeProperties |
Der Bereich und ob er gültig ist. |
| ServiceError |
Die API-Fehlerdetails. |
| ServiceErrorDetail |
Die Fehlerdetails. |
| SimplePollerLike |
Ein einfacher Poller, der zum Abrufen eines vorgangs mit langer Ausführung verwendet werden kann. |
| SkuCapability |
Funktion einer Sku. |
| SkuName |
Der Name der Sku |
| SkuProperty |
Eigenschaft einer Sku. |
| SkuRestriction |
Einschränkung einer Sku. |
| SplitProperties |
Immobilien für Reservierungsaufteilung |
| SplitRequest |
Die Reservierungsanfrage geteilt |
| SubRequest |
Die mit der Kontingentanforderung übermittelte Unteranforderung. |
| SubscriptionScopeProperties |
Die Bereiche, die von der verfügbaren Bereichs-API überprüft werden. |
| SystemData |
Metadaten zur Erstellung und letzten Änderung der Ressource. |
Typaliase
| AppliedScopeType |
Typ des angewendeten Bereichs. Bekannte Werte, die vom Dienst unterstützt werden
Single: Single |
| AzureSupportedClouds |
Die unterstützten Werte für die Cloud-Einstellung als Zeichenfolgenliteraltyp |
| BillingPlan |
Stellt den Abrechnungsplan im ISO 8601-Format dar. Nur für monatliche Abrechnungspläne erforderlich. Bekannte Werte, die vom Dienst unterstützt werdenP1M: P1M |
| CalculateExchangeOperationResultStatus |
Der Status des Vorgangs. Bekannte Werte, die vom Dienst unterstützt werden
Erfolgreich: Erfolgreich |
| CommitmentGrain |
Bekenntniskorn. Bekannte Werte, die vom Dienst unterstützt werdenStundenzahl: Stundenweise |
| ContinuablePage |
Eine Schnittstelle, die eine Seite mit Ergebnissen beschreibt. |
| CreatedByType |
Die Art der Entität, die die Ressource erstellt hat. Bekannte Werte, die vom Dienst unterstützt werden
Benutzer-: Die Entität wurde von einem Benutzer erstellt. |
| ErrorResponseCode |
Fehlercode, der den Grund beschreibt, warum der Dienst die eingehende Anfrage nicht verarbeiten kann Bekannte Werte, die vom Dienst unterstützt werden
Nicht Spezifiziert: Nicht Spezifiziert |
| ExchangeOperationResultStatus |
Der Status des Vorgangs. Bekannte Werte, die vom Dienst unterstützt werden
Erfolgreich: Erfolgreich |
| InstanceFlexibility |
Wenn Sie dies aktivieren, wird der Reservierungsrabatt auf andere virtuelle Computer in derselben VM-Größengruppe angewendet. Geben Sie nur für den reservierten Ressourcentyp "VirtualMachines" an. Bekannte Werte, die vom Dienst unterstützt werden
On: On |
| OperationStatus |
Status des einzelnen Vorgangs. Bekannte Werte, die vom Dienst unterstützt werden
Erfolgreich: Erfolgreich |
| PaymentStatus |
Beschreibt, ob die Zahlung in Zukunft abgeschlossen, fehlgeschlagen, storniert oder geplant ist. Bekannte Werte, die vom Dienst unterstützt werden
Erfolgreich: Erfolgreich |
| ProvisioningState |
Stellt den aktuellen Status der Reservierung dar. Bekannte Werte, die vom Dienst unterstützt werden
Erstellen: Kreieren |
| QuotaRequestState |
Der Status der Kontingentanforderung. Bekannte Werte, die vom Dienst unterstützt werden
Akzeptiert: Akzeptiert |
| ReservationBillingPlan |
Stellen Sie die Abrechnungspläne dar. Bekannte Werte, die vom Dienst unterstützt werden
Vorne vorne: Vorne |
| ReservationStatusCode |
Art von ReservationStatusCode |
| ReservationTerm |
Stellt den Reservierungstermin dar. Bekannte Werte, die vom Dienst unterstützt werden
P1Y: P1Y |
| ReservedResourceType |
Der Typ der Ressource, die reserviert wird. Zusätzlich zu den folgenden Typen haben wir auch die folgenden hinzugefügt: OpenAIPTU, MDC, Sentinel. Bekannte Werte, die vom Dienst unterstützt werden
VirtualMachines: VirtualMachines |
| ResourceType |
Die Ressourcentypen. Bekannte Werte, die vom Dienst unterstützt werden
Standard: Standard |
| SavingsPlanTerm |
Stellen Sie den Sparplantermin im ISO 8601-Format dar. Bekannte Werte, die vom Dienst unterstützt werden
P1Y: P1Y |
Enumerationen
| AzureClouds |
Eine Enumeration zur Beschreibung von Azure Cloud-Umgebungen. |
| KnownAppliedScopeType |
Typ des angewendeten Bereichs. |
| KnownBillingPlan |
Stellt den Abrechnungsplan im ISO 8601-Format dar. Nur für monatliche Abrechnungspläne erforderlich. |
| KnownCalculateExchangeOperationResultStatus |
Der Status des Vorgangs. |
| KnownCommitmentGrain |
Bekenntniskorn. |
| KnownCreatedByType |
Die Art der Entität, die die Ressource erstellt hat. |
| KnownErrorResponseCode |
Fehlercode, der den Grund beschreibt, warum der Dienst die eingehende Anforderung nicht verarbeiten kann |
| KnownExchangeOperationResultStatus |
Der Status des Vorgangs. |
| KnownInstanceFlexibility |
Wenn Sie dies aktivieren, wird der Reservierungsrabatt auf andere virtuelle Computer in derselben VM-Größengruppe angewendet. Geben Sie nur für den reservierten Ressourcentyp "VirtualMachines" an. |
| KnownOperationStatus |
Status des einzelnen Vorgangs. |
| KnownPaymentStatus |
Beschreibt, ob die Zahlung in Zukunft abgeschlossen, fehlgeschlagen, storniert oder geplant ist. |
| KnownProvisioningState |
Stellt den aktuellen Status der Reservierung dar. |
| KnownQuotaRequestState |
Der Status der Kontingentanforderung. |
| KnownReservationBillingPlan |
Stellen Sie die Abrechnungspläne dar. |
| KnownReservationStatusCode |
Bekannte Werte von ReservationStatusCode, die der Dienst akzeptiert. |
| KnownReservationTerm |
Stellt den Reservierungstermin dar. |
| KnownReservedResourceType |
Der Typ der Ressource, die reserviert wird. Zusätzlich zu den folgenden Typen haben wir auch die folgenden hinzugefügt: OpenAIPTU, MDC, Sentinel. |
| KnownResourceType |
Die Ressourcentypen. |
| KnownSavingsPlanTerm |
Stellen Sie den Sparplantermin im ISO 8601-Format dar. |
Functions
| is |
Typeguard für RestError |
| restore |
Erstellt einen Poller aus dem serialisierten Zustand eines anderen Pollers. Dies kann nützlich sein, wenn Sie Umfragen auf einem anderen Host erstellen möchten oder ein Poller erstellt werden muss, nachdem das ursprüngliche Abfragefeld nicht im Gültigkeitsbereich liegt. |
Variablen
| Rest |
Ein benutzerdefinierter Fehlertyp für fehlgeschlagene Pipelineanforderungen. |
Details zur Funktion
isRestError(unknown)
Typeguard für RestError
function isRestError(e: unknown): e
Parameter
- e
-
unknown
Etwas, das von einer Catch-Klausel abgefangen wird.
Gibt zurück
e
restorePoller<TResponse, TResult>(AzureReservationAPI, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)
Erstellt einen Poller aus dem serialisierten Zustand eines anderen Pollers. Dies kann nützlich sein, wenn Sie Umfragen auf einem anderen Host erstellen möchten oder ein Poller erstellt werden muss, nachdem das ursprüngliche Abfragefeld nicht im Gültigkeitsbereich liegt.
function restorePoller<TResponse, TResult>(client: AzureReservationAPI, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>
Parameter
- client
- AzureReservationAPI
- serializedState
-
string
- sourceOperation
-
(args: any[]) => PollerLike<OperationState<TResult>, TResult>
- options
-
RestorePollerOptions<TResult, PathUncheckedResponse>
Gibt zurück
PollerLike<OperationState<TResult>, TResult>
Details zu Variablen
RestError
Ein benutzerdefinierter Fehlertyp für fehlgeschlagene Pipelineanforderungen.
RestError: RestErrorConstructor