@azure/arm-reservations package
الفصول
| AzureReservationAPI |
الواجهات
| AppliedReservationList |
قائمة مرقمة الصفحات بالحجوزات المطبقة |
| AppliedReservations |
الاستجابة لواجهة برمجة تطبيقات الحجوزات المطبقة |
| AppliedReservationsProperties |
العقارات التي تم إرجاعها للحجوزات المطبقة |
| AppliedScopeProperties |
خصائص خاصة بنوع النطاق المطبق. غير مطلوب إن لم يكن قابلا للتطبيق. مطلوب وتحتاج إلى توفير tenantId و managementGroupId إذا كان AppliedScopeType هو ManagementGroup |
| AvailableScopeProperties |
استجابة واجهة برمجة تطبيقات النطاق المتاحة التي تحتوي على النطاقات والأهلية الخاصة بها. |
| AvailableScopeRequest |
النطاق المتاح |
| AvailableScopeRequestProperties |
خصائص طلب النطاق المتوفرة |
| AzureReservationAPIOptionalParams |
معلمات اختيارية للعميل. |
| BillingInformation |
معلومات الفوترة |
| CalculateExchangeOperationResultResponse |
نتيجة عملية CalculateExchange |
| CalculateExchangeOperations |
واجهة تمثل عمليات CalculateExchange. |
| CalculateExchangePostOptionalParams |
المعلمات الاختيارية. |
| CalculateExchangeRequest |
حساب طلب التبادل |
| CalculateExchangeRequestProperties |
حساب خصائص طلب التبادل |
| CalculateExchangeResponseProperties |
خصائص استجابة CalculateExchange |
| CalculatePriceResponse |
استجابة حساب سعر الحجز. |
| CalculatePriceResponseProperties |
خصائص حساب استجابة السعر |
| CalculatePriceResponsePropertiesBillingCurrencyTotal |
العملة والمبلغ الذي سيتم تحصيله من هذا العميل بالعملة المحلية للعميل. الضريبة غير مضمنة. |
| CalculatePriceResponsePropertiesPricingCurrencyTotal |
المبلغ الذي تستخدمه Microsoft للسجل. يستخدم أثناء استرداد المبلغ لحساب حد الاسترداد. الضريبة غير مضمنة. |
| CalculateRefundOperations |
واجهة تمثل عمليات CalculateRefund. |
| CalculateRefundPostOptionalParams |
المعلمات الاختيارية. |
| CalculateRefundRequest |
طلب يحتوي على معلومات مطلوبة لحساب المبلغ المسترد. |
| CalculateRefundRequestProperties |
الخصائص اللازمة لحساب المبلغ المسترد بما في ذلك النطاق والحجز الذي سيتم إرجاعه. |
| CalculateRefundResponse |
استجابة حساب المبلغ المسترد الذي يحتوي على معلومات استرداد الحجز |
| Catalog |
تفاصيل المنتج لنوع من الموارد. |
| CatalogMsrp |
معلومات التسعير حول وحدة sku |
| ChangeDirectoryRequest |
طلب نص لتغيير دليل الحجز. |
| ChangeDirectoryResponse |
تغيير استجابة الدليل |
| ChangeDirectoryResult |
تغيير نتيجة الدليل لأمر الحجز أو الحجز |
| Commitment |
الالتزام بالمنفعة. |
| CurrentQuotaLimitBase |
خصائص الحصة النسبية. |
| ErrorDetails |
تفاصيل الخطأ. |
| ErrorModel |
معلومات الخطأ |
| ErrorResponse |
تشير استجابة الخطأ إلى أن الخدمة غير قادرة على معالجة الطلب الوارد. يتم توفير السبب في رسالة الخطأ. |
| ExceptionResponse |
خطأ واجهة برمجة التطبيقات. |
| ExchangeOperationResultResponse |
نتيجة عملية Exchange |
| ExchangeOperations |
واجهة تمثل عمليات Exchange. |
| ExchangePolicyError |
تفاصيل الخطأ |
| ExchangePolicyErrors |
أخطاء نهج Exchange |
| ExchangePostOptionalParams |
المعلمات الاختيارية. |
| ExchangeRequest |
طلب Exchange |
| ExchangeRequestProperties |
خصائص طلب Exchange |
| ExchangeResponseProperties |
خصائص استجابة Exchange |
| ExtendedErrorInfo |
معلومات الخطأ الموسعة بما في ذلك رمز الخطأ ورسالة الخطأ |
| ExtendedStatusInfo |
واجهة النموذج ExtendedStatusInfo |
| GetAppliedReservationListOptionalParams |
المعلمات الاختيارية. |
| GetCatalogOptionalParams |
المعلمات الاختيارية. |
| MergeProperties |
العقارات التي تم دمج المحميات |
| MergeRequest |
طلب دمج الحجز |
| OperationDisplay |
معلومات حول عملية |
| OperationListOptionalParams |
المعلمات الاختيارية. |
| OperationOperations |
واجهة تمثل عمليات العملية. |
| OperationResponse |
الاستجابة التي تحتوي على معلومات العملية |
| OperationResultError |
مطلوب إذا كانت الحالة == فاشلة أو الحالة == ملغاة. |
| PageSettings |
خيارات لأسلوب byPage |
| PagedAsyncIterableIterator |
واجهة تسمح بالتكرار غير المتزامن حتى الاكتمال والصفحة. |
| Patch |
طلب تصحيح الحجز |
| PatchProperties |
عقارات لحجز رقعة |
| PatchPropertiesRenewProperties |
واجهة النموذج: PatchPropertiesRenewProperties |
| PaymentDetail |
معلومات حول الدفع المتعلق بأمر حجز. |
| Price |
معلومات التسعير التي تحتوي على المبلغ ورمز العملة |
| ProxyResource |
تعريف نموذج المورد لمورد وكيل Azure Resource Manager. لن تحتوي على علامات وموقع |
| PurchaseRequest |
طلب شراء الحجز |
| PurchaseRequestProperties |
خصائص طلب شراء الحجز |
| PurchaseRequestPropertiesReservedResourceProperties |
خصائص خاصة بكل نوع مورد محجوز. غير مطلوب إن لم يكن قابلا للتطبيق. |
| QuotaCreateOrUpdateOptionalParams |
المعلمات الاختيارية. |
| QuotaGetOptionalParams |
المعلمات الاختيارية. |
| QuotaListOptionalParams |
المعلمات الاختيارية. |
| QuotaOperations |
واجهة تمثل عمليات الحصة النسبية. |
| QuotaProperties |
خصائص الحصة النسبية للمورد. |
| QuotaRequestDetails |
تفاصيل طلب الحصة النسبية. |
| QuotaRequestProperties |
تفاصيل طلب الحصة النسبية. |
| QuotaRequestStatusGetOptionalParams |
المعلمات الاختيارية. |
| QuotaRequestStatusListOptionalParams |
المعلمات الاختيارية. |
| QuotaRequestStatusOperations |
واجهة تمثل عمليات QuotaRequestStatus. |
| QuotaUpdateOptionalParams |
المعلمات الاختيارية. |
| RefundBillingInformation |
معلومات الفوترة |
| RefundPolicyError |
تفاصيل الخطأ |
| RefundPolicyResult |
نتيجة نهج استرداد المبلغ |
| RefundPolicyResultProperty |
خاصية نتيجة نهج الاسترداد |
| RefundRequest |
طلب يحتوي على معلومات مطلوبة لإعادة الحجز. |
| RefundRequestProperties |
الخصائص المطلوبة لطلب استرداد المبلغ بما في ذلك معرف الجلسة من حساب المبلغ المسترد والنطاق والحجز الذي سيتم إرجاعه وسبب الإرجاع. |
| RefundResponseProperties |
خصائص استرداد المبلغ المدفوع للحجز |
| RenewPropertiesResponse |
خصائص التجديد للحجز. |
| RenewPropertiesResponseBillingCurrencyTotal |
العملة والمبلغ الذي سيتم تحصيله من العميل بالعملة المحلية للعميل مقابل شراء التجديد. الضريبة غير مضمنة. |
| RenewPropertiesResponsePricingCurrencyTotal |
المبلغ الذي تستخدمه Microsoft للسجل. يستخدم أثناء استرداد المبلغ لحساب حد الاسترداد. الضريبة غير مضمنة. هذا هو السعر المؤمن قبل 30 يوما من انتهاء الصلاحية. |
| ReservationArchiveOptionalParams |
المعلمات الاختيارية. |
| ReservationAvailableScopesOptionalParams |
المعلمات الاختيارية. |
| ReservationGetOptionalParams |
المعلمات الاختيارية. |
| ReservationListAllOptionalParams |
المعلمات الاختيارية. |
| ReservationListOptionalParams |
المعلمات الاختيارية. |
| ReservationListRevisionsOptionalParams |
المعلمات الاختيارية. |
| ReservationMergeOptionalParams |
المعلمات الاختيارية. |
| ReservationMergeProperties |
خصائص دمج الحجز |
| ReservationOperations |
واجهة تمثل عمليات المحمية. |
| ReservationOrderBillingPlanInformation |
معلومات تصف نوع خطة الفوترة لهذا الحجز. |
| ReservationOrderCalculateOptionalParams |
المعلمات الاختيارية. |
| ReservationOrderChangeDirectoryOptionalParams |
المعلمات الاختيارية. |
| ReservationOrderGetOptionalParams |
المعلمات الاختيارية. |
| ReservationOrderListOptionalParams |
المعلمات الاختيارية. |
| ReservationOrderOperations |
واجهة تمثل عمليات أمر الحجز. |
| ReservationOrderProperties |
ممتلكات أمر حجز. |
| ReservationOrderPurchaseOptionalParams |
المعلمات الاختيارية. |
| ReservationOrderResponse |
تفاصيل أمر الحجز الذي يتم إرجاعه. |
| ReservationResponse |
تعريف الحجز. |
| ReservationSplitOptionalParams |
المعلمات الاختيارية. |
| ReservationSplitProperties |
خصائص تقسيم الحجز |
| ReservationSummary |
ملخص عدد الحجوزات في كل حالة |
| ReservationSwapProperties |
خصائص تبديل الحجز |
| ReservationToExchange |
تفاصيل استرداد الحجز |
| ReservationToPurchaseCalculateExchange |
تفاصيل شراء الحجز |
| ReservationToPurchaseExchange |
تفاصيل شراء الحجز |
| ReservationToReturn |
حجز للعودة |
| ReservationToReturnForExchange |
تفاصيل استرداد الحجز |
| ReservationUnarchiveOptionalParams |
المعلمات الاختيارية. |
| ReservationUpdateOptionalParams |
المعلمات الاختيارية. |
| ReservationUtilizationAggregates |
القيم الإجمالية لاستخدام الحجز |
| ReservationsProperties |
خصائص الحجوزات |
| ReservationsPropertiesUtilization |
استخدام الحجز |
| Resource |
الحقول الشائعة التي يتم إرجاعها في الاستجابة لكافة موارد Azure Resource Manager |
| ResourceName |
اسم المورد الذي يوفره موفر المورد. استخدم هذه الخاصية لمعلمة quotaRequest. |
| RestorePollerOptions | |
| ReturnOperations |
واجهة تمثل عمليات الإرجاع. |
| ReturnPostOptionalParams |
المعلمات الاختيارية. |
| SavingsPlanPurchaseRequest |
نص الطلب لشراء خطة التوفير |
| SavingsPlanPurchaseRequestProperties |
عقارات شراء خطة التوفير |
| SavingsPlanToPurchaseCalculateExchange |
تفاصيل شراء خطة التوفير |
| SavingsPlanToPurchaseExchange |
تفاصيل شراء خطة التوفير |
| ScopeProperties |
النطاق وما إذا كان صالحا. |
| ServiceError |
تفاصيل خطأ واجهة برمجة التطبيقات. |
| ServiceErrorDetail |
تفاصيل الخطأ. |
| SimplePollerLike |
استقصاء بسيط يمكن استخدامه لاستقصاء عملية طويلة الأمد. |
| SkuCapability |
قدرة وحدة sku. |
| SkuName |
اسم sku |
| SkuProperty |
خاصية sku. |
| SkuRestriction |
تقييد وحدة sku. |
| SplitProperties |
العقارات المخصصة لتقسيم الحجز |
| SplitRequest |
طلب تقسيم الحجز |
| SubRequest |
الطلب الفرعي المقدم مع طلب الحصة النسبية. |
| SubscriptionScopeProperties |
النطاقات التي تم التحقق منها بواسطة واجهة برمجة تطبيقات النطاق المتوفرة. |
| SystemData |
بيانات التعريف المتعلقة بإنشاء المورد والتعديل الأخير له. |
النوع أسماء مستعارة
| AppliedScopeType |
نوع النطاق المطبق. القيم المعروفة التي تدعمها الخدمة
أغنية منفردة: أغنية منفردة |
| AzureSupportedClouds |
القيم المدعومة لإعداد السحابة كنوع حرفي للسلسلة |
| BillingPlan |
يمثل خطة الفوترة بتنسيق ISO 8601. مطلوب فقط لخطط الفوترة الشهرية. القيم المعروفة التي تدعمها الخدمةP1M: P1M |
| CalculateExchangeOperationResultStatus |
حالة العملية. القيم المعروفة التي تدعمها الخدمة
نجحت: نجحت |
| CommitmentGrain |
الالتزام بالحبر. القيم المعروفة التي تدعمها الخدمةكل ساعة: كل ساعة |
| ContinuablePage |
واجهة تصف صفحة من النتائج. |
| CreatedByType |
نوع الكيان الذي أنشأ المورد. القيم المعروفة التي تدعمها الخدمة
user: تم إنشاء الكيان بواسطة مستخدم. |
| ErrorResponseCode |
رمز خطأ يصف سبب عدم قدرة الخدمة على معالجة الطلب الوارد القيم المعروفة التي تدعمها الخدمة
غير محدد: غير محدد |
| ExchangeOperationResultStatus |
حالة العملية. القيم المعروفة التي تدعمها الخدمة
نجحت: نجحت |
| InstanceFlexibility |
سيؤدي تشغيل هذا إلى تطبيق خصم الحجز على الأجهزة الظاهرية الأخرى في نفس مجموعة حجم الجهاز الظاهري. حدد فقط لنوع المورد المحجوز VirtualMachines. القيم المعروفة التي تدعمها الخدمة
على: على |
| OperationStatus |
حالة العملية الفردية. القيم المعروفة التي تدعمها الخدمة
نجحت: نجحت |
| PaymentStatus |
يصف ما إذا كانت الدفعة قد اكتملت، أو فشلت، أو ألغيت، أو مجدولة في المستقبل. القيم المعروفة التي تدعمها الخدمة
نجحت: نجحت |
| ProvisioningState |
تمثل الحالة الحالية للمحمية. القيم المعروفة التي تدعمها الخدمة
الإنشاء: الإنشاء |
| QuotaRequestState |
حالة طلب الحصة النسبية. القيم المعروفة التي تدعمها الخدمة
مقبول: مقبول |
| ReservationBillingPlan |
تمثيل خطط الفوترة. القيم المعروفة التي تدعمها الخدمة
الأمام المباشر: الأمام |
| ReservationStatusCode |
نوع الحجز: رمز الحالة |
| ReservationTerm |
تمثيل مدة الحجز. القيم المعروفة التي تدعمها الخدمة
P1Y: P1Y |
| ReservedResourceType |
نوع المورد الذي يتم حجزه. بالإضافة إلى الأنواع أدناه ، أضفنا أيضا ما يلي: OpenAIPTU و MDC و Sentinel. القيم المعروفة التي تدعمها الخدمة
فيرتشوال ماشينز: فيرتشوالماشينز |
| ResourceType |
أنواع الموارد. القيم المعروفة التي تدعمها الخدمة
المعيار: المعيار |
| SavingsPlanTerm |
تمثيل مدة خطة الادخار بصيغة ISO 8601. القيم المعروفة التي تدعمها الخدمة
P1Y: P1Y |
التعدادات
| AzureClouds |
تعداد لوصف بيئات Azure Cloud. |
| KnownAppliedScopeType |
نوع النطاق المطبق. |
| KnownBillingPlan |
يمثل خطة الفوترة بتنسيق ISO 8601. مطلوب فقط لخطط الفوترة الشهرية. |
| KnownCalculateExchangeOperationResultStatus |
حالة العملية. |
| KnownCommitmentGrain |
الالتزام بالحبر. |
| KnownCreatedByType |
نوع الكيان الذي أنشأ المورد. |
| KnownErrorResponseCode |
رمز خطأ يصف سبب عدم قدرة الخدمة على معالجة الطلب الوارد |
| KnownExchangeOperationResultStatus |
حالة العملية. |
| KnownInstanceFlexibility |
سيؤدي تشغيل هذا إلى تطبيق خصم الحجز على الأجهزة الظاهرية الأخرى في نفس مجموعة حجم الجهاز الظاهري. حدد فقط لنوع المورد المحجوز VirtualMachines. |
| KnownOperationStatus |
حالة العملية الفردية. |
| KnownPaymentStatus |
يصف ما إذا كانت الدفعة قد اكتملت، أو فشلت، أو ألغيت، أو مجدولة في المستقبل. |
| KnownProvisioningState |
تمثل الحالة الحالية للمحمية. |
| KnownQuotaRequestState |
حالة طلب الحصة النسبية. |
| KnownReservationBillingPlan |
تمثيل خطط الفوترة. |
| KnownReservationStatusCode |
القيم المعروفة ReservationStatusCode التي تقبلها الخدمة. |
| KnownReservationTerm |
تمثيل مدة الحجز. |
| KnownReservedResourceType |
نوع المورد الذي يتم حجزه. بالإضافة إلى الأنواع أدناه ، أضفنا أيضا ما يلي: OpenAIPTU و MDC و Sentinel. |
| KnownResourceType |
أنواع الموارد. |
| KnownSavingsPlanTerm |
تمثيل مدة خطة الادخار بصيغة ISO 8601. |
الوظائف
| is |
Typeguard ل RestError |
| restore |
إنشاء استقصاء من الحالة المتسلسلة لأداة استقصاء أخرى. يمكن أن يكون هذا مفيدا عندما تريد إنشاء استقصاءات على مضيف مختلف أو يحتاج إلى إنشاء أداة استقصاء بعد أن لا تكون الأصلية في النطاق. |
المتغيرات
| Rest |
نوع خطأ مخصص لطلبات البنية الأساسية لبرنامج ربط العمليات التجارية الفاشلة. |
تفاصيل الوظيفة
isRestError(unknown)
Typeguard ل RestError
function isRestError(e: unknown): e
المعلمات
- e
-
unknown
شيء ما تم التقاطه بواسطة عبارة catch.
المرتجعات
e
restorePoller<TResponse, TResult>(AzureReservationAPI, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)
إنشاء استقصاء من الحالة المتسلسلة لأداة استقصاء أخرى. يمكن أن يكون هذا مفيدا عندما تريد إنشاء استقصاءات على مضيف مختلف أو يحتاج إلى إنشاء أداة استقصاء بعد أن لا تكون الأصلية في النطاق.
function restorePoller<TResponse, TResult>(client: AzureReservationAPI, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>
المعلمات
- client
- AzureReservationAPI
- serializedState
-
string
- sourceOperation
-
(args: any[]) => PollerLike<OperationState<TResult>, TResult>
- options
-
RestorePollerOptions<TResult, PathUncheckedResponse>
المرتجعات
PollerLike<OperationState<TResult>, TResult>
تفاصيل المُتغيّر
RestError
نوع خطأ مخصص لطلبات البنية الأساسية لبرنامج ربط العمليات التجارية الفاشلة.
RestError: RestErrorConstructor