ServiceFabricClientGetApplicationBackupListOptionalParams interface

الحزمة:

@azure/servicefabric

معلمات اختيارية.

يمتد

RequestOptionsBase

الخصائص

continuationToken	يتم استخدام معلمة الرمز المميز للمتابعة للحصول على المجموعة التالية من النتائج. يتم تضمين رمز متابعة بقيمة غير فارغة في استجابة واجهة برمجة التطبيقات عندما لا تتلاءم النتائج من النظام مع استجابة واحدة. عند تمرير هذه القيمة إلى استدعاء API التالي، ترجع واجهة برمجة التطبيقات المجموعة التالية من النتائج. إذا لم تكن هناك نتائج أخرى، فلن يحتوي رمز المتابعة المميز على قيمة. يجب ألا تكون قيمة هذه المعلمة مرمزة بعنوان URL.
endDateTimeFilter	حدد وقت تاريخ الانتهاء الذي تريد تعداد النسخ الاحتياطية إليه، بتنسيق التاريخ والوقت. يجب تحديد وقت التاريخ بتنسيق ISO8601. هذه معلمة اختيارية. إذا لم يتم تحديده، يتم التعداد حتى أحدث نسخة احتياطية.
latest	تحديد ما إذا كان يجب الحصول على أحدث نسخة احتياطية متاحة فقط لقسم للنطاق الزمني المحدد. القيمة الافتراضية: خطأ.
maxResults	الحد الأقصى لعدد النتائج التي سيتم إرجاعها كجزء من الاستعلامات المقسمة إلى صفحات. تحدد هذه المعلمة الحد الأعلى لعدد النتائج التي تم إرجاعها. يمكن أن تكون النتائج التي تم إرجاعها أقل من الحد الأقصى المحدد للنتائج إذا لم يتم احتواؤها في الرسالة وفقا للقيود القصوى لحجم الرسالة المحددة في التكوين. إذا كانت هذه المعلمة صفرا أو غير محددة، يتضمن الاستعلام المصفح أكبر عدد ممكن من النتائج التي تتناسب مع رسالة الإرجاع. القيمة الافتراضية: 0.
startDateTimeFilter	حدد وقت تاريخ البدء الذي يتم تعداد النسخ الاحتياطية منه، بتنسيق التاريخ والوقت. يجب تحديد وقت التاريخ بتنسيق ISO8601. هذه معلمة اختيارية. إذا لم يتم تحديدها، يتم تعداد جميع النسخ الاحتياطية من البداية.
timeoutParameter	مهلة الخادم لتنفيذ العملية بالثوان. تحدد هذه المهلة المدة الزمنية التي يرغب العميل في انتظار اكتمال العملية المطلوبة. القيمة الافتراضية لهذه المعلمة هي 60 ثانية. القيمة الافتراضية: 60.

الخصائص الموروثة

abortSignal	الإشارة التي يمكن استخدامها لإجهاض الطلبات.
customHeaders	عناوين الطلبات المخصصة المعرفة من قبل المستخدم والتي سيتم تطبيقها قبل إرسال الطلب.
onDownloadProgress	رد الاتصال الذي يتم إطلاقه عند تقدم التنزيل.
onUploadProgress	رد الاتصال الذي يتم إطلاقه عند تقدم التحميل.
timeout	عدد المللي ثانية التي يمكن أن يستغرقها الطلب قبل إنهائه تلقائيا.

تفاصيل الخاصية

continuationToken

يتم استخدام معلمة الرمز المميز للمتابعة للحصول على المجموعة التالية من النتائج. يتم تضمين رمز متابعة بقيمة غير فارغة في استجابة واجهة برمجة التطبيقات عندما لا تتلاءم النتائج من النظام مع استجابة واحدة. عند تمرير هذه القيمة إلى استدعاء API التالي، ترجع واجهة برمجة التطبيقات المجموعة التالية من النتائج. إذا لم تكن هناك نتائج أخرى، فلن يحتوي رمز المتابعة المميز على قيمة. يجب ألا تكون قيمة هذه المعلمة مرمزة بعنوان URL.

continuationToken?: string

قيمة الخاصية

string

endDateTimeFilter

حدد وقت تاريخ الانتهاء الذي تريد تعداد النسخ الاحتياطية إليه، بتنسيق التاريخ والوقت. يجب تحديد وقت التاريخ بتنسيق ISO8601. هذه معلمة اختيارية. إذا لم يتم تحديده، يتم التعداد حتى أحدث نسخة احتياطية.

endDateTimeFilter?: Date

قيمة الخاصية

Date

latest

تحديد ما إذا كان يجب الحصول على أحدث نسخة احتياطية متاحة فقط لقسم للنطاق الزمني المحدد. القيمة الافتراضية: خطأ.

latest?: boolean

قيمة الخاصية

boolean

maxResults

الحد الأقصى لعدد النتائج التي سيتم إرجاعها كجزء من الاستعلامات المقسمة إلى صفحات. تحدد هذه المعلمة الحد الأعلى لعدد النتائج التي تم إرجاعها. يمكن أن تكون النتائج التي تم إرجاعها أقل من الحد الأقصى المحدد للنتائج إذا لم يتم احتواؤها في الرسالة وفقا للقيود القصوى لحجم الرسالة المحددة في التكوين. إذا كانت هذه المعلمة صفرا أو غير محددة، يتضمن الاستعلام المصفح أكبر عدد ممكن من النتائج التي تتناسب مع رسالة الإرجاع. القيمة الافتراضية: 0.

maxResults?: number

قيمة الخاصية

number

startDateTimeFilter

حدد وقت تاريخ البدء الذي يتم تعداد النسخ الاحتياطية منه، بتنسيق التاريخ والوقت. يجب تحديد وقت التاريخ بتنسيق ISO8601. هذه معلمة اختيارية. إذا لم يتم تحديدها، يتم تعداد جميع النسخ الاحتياطية من البداية.

startDateTimeFilter?: Date

قيمة الخاصية

Date

timeoutParameter

مهلة الخادم لتنفيذ العملية بالثوان. تحدد هذه المهلة المدة الزمنية التي يرغب العميل في انتظار اكتمال العملية المطلوبة. القيمة الافتراضية لهذه المعلمة هي 60 ثانية. القيمة الافتراضية: 60.

timeoutParameter?: number

قيمة الخاصية

number

تفاصيل الخاصية الموروثة

abortSignal

الإشارة التي يمكن استخدامها لإجهاض الطلبات.

abortSignal?: AbortSignalLike

قيمة الخاصية

AbortSignalLike

موروث من msRest.RequestOptionsBase.abortSignal

customHeaders

عناوين الطلبات المخصصة المعرفة من قبل المستخدم والتي سيتم تطبيقها قبل إرسال الطلب.

customHeaders?: {[key: string]: string}

قيمة الخاصية

{[key: string]: string}

موروث من msRest.RequestOptionsBase.customHeaders

onDownloadProgress

رد الاتصال الذي يتم إطلاقه عند تقدم التنزيل.

onDownloadProgress?: (progress: TransferProgressEvent) => void

قيمة الخاصية

(progress: TransferProgressEvent) => void

موروث من msRest.RequestOptionsBase.onDownloadProgress

onUploadProgress

رد الاتصال الذي يتم إطلاقه عند تقدم التحميل.

onUploadProgress?: (progress: TransferProgressEvent) => void

قيمة الخاصية

(progress: TransferProgressEvent) => void

موروث من msRest.RequestOptionsBase.onUploadProgress

timeout

عدد المللي ثانية التي يمكن أن يستغرقها الطلب قبل إنهائه تلقائيا.

timeout?: number

قيمة الخاصية

number

موروث من msRest.RequestOptionsBase.timeout