BatchJobOutput interface

الحزمة:

@azure-rest/batch

وظيفة Azure Batch.

الخصائص

allowTaskPreemption	ما إذا كان يمكن استباق المهام في هذه الوظيفة بواسطة وظائف أخرى ذات أولوية عالية. (هذه الخاصية غير متوفرة افتراضيا. يرجى الاتصال بالدعم للحصول على مزيد من المعلومات) إذا تم تعيين القيمة إلى True، فستكون الأولوية للمهام الأخرى ذات الأولوية العالية المرسلة إلى النظام وستكون قادرة على إعادة قائمة الانتظار للمهام من هذه الوظيفة. يمكنك تحديث allowTaskPreemption للوظيفة بعد إنشائها باستخدام واجهة برمجة تطبيقات مهمة التحديث.
commonEnvironmentSettings	قائمة إعدادات متغير البيئة الشائعة. يتم تعيين متغيرات البيئة هذه لكافة المهام في الوظيفة (بما في ذلك مدير الوظيفة وإعداد الوظيفة ومهام إصدار الوظيفة). يمكن للمهام الفردية تجاوز إعداد بيئة محدد هنا عن طريق تحديد نفس اسم الإعداد بقيمة مختلفة.
constraints	قيود التنفيذ للوظيفة.
creationTime	وقت إنشاء الوظيفة.
displayName	اسم العرض للوظيفة.
eTag	ETag للوظيفة. هذه سلسلة مبهمة. يمكنك استخدامه للكشف عما إذا كانت الوظيفة قد تغيرت بين الطلبات. على وجه الخصوص، يمكنك تمرير ETag عند تحديث وظيفة لتحديد أن التغييرات الخاصة بك يجب أن تصبح سارية المفعول فقط إذا لم يقم أي شخص آخر بتعديل الوظيفة في هذه الأثناء.
executionInfo	معلومات التنفيذ للمهمة.
id	سلسلة تعرف المهمة بشكل فريد داخل الحساب. المعرف هو الحفاظ على حالة الأحرف وغير حساس لحالة الأحرف (أي، قد لا يكون لديك معرفان داخل حساب يختلفان فقط حسب الحالة).
jobManagerTask	تفاصيل مهمة مدير الوظيفة التي سيتم تشغيلها عند بدء المهمة.
jobPreparationTask	مهمة إعداد الوظيفة. مهمة إعداد الوظيفة هي مهمة خاصة يتم تشغيلها على كل عقدة حساب قبل أي مهمة أخرى من المهمة.
jobReleaseTask	مهمة إصدار الوظيفة. مهمة إصدار الوظيفة هي مهمة خاصة يتم تشغيلها في نهاية المهمة على كل عقدة حساب قامت بتشغيل أي مهمة أخرى من المهمة.
lastModified	آخر وقت تم تعديله للوظيفة. هذه هي المرة الأخيرة التي تتغير فيها بيانات مستوى الوظيفة، مثل حالة الوظيفة أو الأولوية. لا يتم احتساب التغييرات على مستوى المهام مثل إضافة مهام جديدة أو تغيير حالة المهام.
maxParallelTasks	الحد الأقصى لعدد المهام التي يمكن تنفيذها بالتوازي مع المهمة. (هذه الخاصية غير متوفرة افتراضيا. يرجى الاتصال بالدعم للحصول على مزيد من المعلومات) يجب أن تكون قيمة maxParallelTasks -1 أو أكبر من 0 إذا تم تحديدها. إذا لم يتم تحديدها، فإن القيمة الافتراضية هي -1، ما يعني أنه لا يوجد حد لعدد المهام التي يمكن تشغيلها في وقت واحد. يمكنك تحديث maxParallelTasks لمهمة بعد إنشائها باستخدام واجهة برمجة تطبيقات مهمة التحديث.
metadata	قائمة أزواج الاسم والقيمة المقترنة بالوظيفة كبيانات تعريف. لا تعين خدمة Batch أي معنى لبيانات التعريف؛ هو فقط لاستخدام التعليمات البرمجية للمستخدم.
networkConfiguration	(هذه الخاصية غير متوفرة افتراضيا. يرجى الاتصال بالدعم للحصول على مزيد من المعلومات) تكوين الشبكة للوظيفة.
onAllTasksComplete	الإجراء الذي يجب أن تتخذه خدمة Batch عندما تكون كافة المهام في الوظيفة في حالة مكتملة. الإعداد الافتراضي هو noaction. القيم المحتملة: "noaction"، "terminatejob"
onTaskFailure	الإجراء الذي يجب أن تتخذه خدمة Batch عند فشل أي مهمة في المهمة. تعتبر المهمة قد فشلت إذا كانت تحتوي على failureInfo. يتم تعيين failureInfo إذا اكتملت المهمة برمز خروج غير صفري بعد استنفاد عدد مرات إعادة المحاولة، أو إذا كان هناك خطأ في بدء المهمة، على سبيل المثال بسبب خطأ في تنزيل ملف مورد. الإعداد الافتراضي هو noaction. القيم المحتملة: "noaction"، "performexitoptionsjobaction"
poolInfo	إعدادات التجمع المقترنة بالوظيفة.
previousState	الحالة السابقة للوظيفة. لم يتم تعيين هذه الخاصية إذا كانت الوظيفة في حالتها النشطة الأولية. القيم المحتملة: "نشط" و"تعطيل" و"معطل" و"تمكين" و"إنهاء" و"مكتمل" و"حذف"
previousStateTransitionTime	الوقت الذي دخلت فيه الوظيفة في حالتها السابقة. لم يتم تعيين هذه الخاصية إذا كانت الوظيفة في حالتها النشطة الأولية.
priority	أولوية الوظيفة. يمكن أن تتراوح قيم الأولوية من -1000 إلى 1000، مع -1000 أقل أولوية و1000 أولوية قصوى. القيمة الافتراضية هي 0.
state	الحالة الحالية للوظيفة. القيم المحتملة: "نشط" و"تعطيل" و"معطل" و"تمكين" و"إنهاء" و"مكتمل" و"حذف"
stateTransitionTime	الوقت الذي دخلت فيه الوظيفة حالتها الحالية.
stats	إحصائيات استخدام الموارد طوال مدة بقاء المهمة. يتم ملء هذه الخاصية فقط إذا تم استرداد BatchJob مع عبارة توسيع بما في ذلك سمة "الإحصائيات"؛ وإلا فهي فارغة. وقد لا تكون الإحصاءات متاحة على الفور. تقوم خدمة Batch بإجراء مجموعة دورية من الإحصائيات. التأخير النموذجي حوالي 30 دقيقة.
url	عنوان URL للوظيفة.
usesTaskDependencies	ما إذا كان يمكن للمهام في الوظيفة تحديد التبعيات على بعضها البعض. الإعداد الافتراضي خطأ.

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

allowTaskPreemption

ما إذا كان يمكن استباق المهام في هذه الوظيفة بواسطة وظائف أخرى ذات أولوية عالية. (هذه الخاصية غير متوفرة افتراضيا. يرجى الاتصال بالدعم للحصول على مزيد من المعلومات) إذا تم تعيين القيمة إلى True، فستكون الأولوية للمهام الأخرى ذات الأولوية العالية المرسلة إلى النظام وستكون قادرة على إعادة قائمة الانتظار للمهام من هذه الوظيفة. يمكنك تحديث allowTaskPreemption للوظيفة بعد إنشائها باستخدام واجهة برمجة تطبيقات مهمة التحديث.

allowTaskPreemption?: boolean

قيمة الخاصية

boolean

commonEnvironmentSettings

قائمة إعدادات متغير البيئة الشائعة. يتم تعيين متغيرات البيئة هذه لكافة المهام في الوظيفة (بما في ذلك مدير الوظيفة وإعداد الوظيفة ومهام إصدار الوظيفة). يمكن للمهام الفردية تجاوز إعداد بيئة محدد هنا عن طريق تحديد نفس اسم الإعداد بقيمة مختلفة.

commonEnvironmentSettings?: EnvironmentSettingOutput[]

قيمة الخاصية

EnvironmentSettingOutput[]

constraints

قيود التنفيذ للوظيفة.

constraints?: BatchJobConstraintsOutput

قيمة الخاصية

BatchJobConstraintsOutput

creationTime

وقت إنشاء الوظيفة.

creationTime: string

قيمة الخاصية

string

displayName

اسم العرض للوظيفة.

displayName?: string

قيمة الخاصية

string

eTag

ETag للوظيفة. هذه سلسلة مبهمة. يمكنك استخدامه للكشف عما إذا كانت الوظيفة قد تغيرت بين الطلبات. على وجه الخصوص، يمكنك تمرير ETag عند تحديث وظيفة لتحديد أن التغييرات الخاصة بك يجب أن تصبح سارية المفعول فقط إذا لم يقم أي شخص آخر بتعديل الوظيفة في هذه الأثناء.

eTag: string

قيمة الخاصية

string

executionInfo

معلومات التنفيذ للمهمة.

executionInfo?: BatchJobExecutionInfoOutput

قيمة الخاصية

BatchJobExecutionInfoOutput

id

سلسلة تعرف المهمة بشكل فريد داخل الحساب. المعرف هو الحفاظ على حالة الأحرف وغير حساس لحالة الأحرف (أي، قد لا يكون لديك معرفان داخل حساب يختلفان فقط حسب الحالة).

id: string

قيمة الخاصية

string

jobManagerTask

تفاصيل مهمة مدير الوظيفة التي سيتم تشغيلها عند بدء المهمة.

jobManagerTask?: BatchJobManagerTaskOutput

قيمة الخاصية

BatchJobManagerTaskOutput

jobPreparationTask

مهمة إعداد الوظيفة. مهمة إعداد الوظيفة هي مهمة خاصة يتم تشغيلها على كل عقدة حساب قبل أي مهمة أخرى من المهمة.

jobPreparationTask?: BatchJobPreparationTaskOutput

قيمة الخاصية

BatchJobPreparationTaskOutput

jobReleaseTask

مهمة إصدار الوظيفة. مهمة إصدار الوظيفة هي مهمة خاصة يتم تشغيلها في نهاية المهمة على كل عقدة حساب قامت بتشغيل أي مهمة أخرى من المهمة.

jobReleaseTask?: BatchJobReleaseTaskOutput

قيمة الخاصية

BatchJobReleaseTaskOutput

lastModified

آخر وقت تم تعديله للوظيفة. هذه هي المرة الأخيرة التي تتغير فيها بيانات مستوى الوظيفة، مثل حالة الوظيفة أو الأولوية. لا يتم احتساب التغييرات على مستوى المهام مثل إضافة مهام جديدة أو تغيير حالة المهام.

lastModified: string

قيمة الخاصية

string

maxParallelTasks

الحد الأقصى لعدد المهام التي يمكن تنفيذها بالتوازي مع المهمة. (هذه الخاصية غير متوفرة افتراضيا. يرجى الاتصال بالدعم للحصول على مزيد من المعلومات) يجب أن تكون قيمة maxParallelTasks -1 أو أكبر من 0 إذا تم تحديدها. إذا لم يتم تحديدها، فإن القيمة الافتراضية هي -1، ما يعني أنه لا يوجد حد لعدد المهام التي يمكن تشغيلها في وقت واحد. يمكنك تحديث maxParallelTasks لمهمة بعد إنشائها باستخدام واجهة برمجة تطبيقات مهمة التحديث.

maxParallelTasks?: number

قيمة الخاصية

number

metadata

قائمة أزواج الاسم والقيمة المقترنة بالوظيفة كبيانات تعريف. لا تعين خدمة Batch أي معنى لبيانات التعريف؛ هو فقط لاستخدام التعليمات البرمجية للمستخدم.

metadata?: BatchMetadataItemOutput[]

قيمة الخاصية

BatchMetadataItemOutput[]

networkConfiguration

(هذه الخاصية غير متوفرة افتراضيا. يرجى الاتصال بالدعم للحصول على مزيد من المعلومات) تكوين الشبكة للوظيفة.

networkConfiguration?: BatchJobNetworkConfigurationOutput

قيمة الخاصية

BatchJobNetworkConfigurationOutput

onAllTasksComplete

الإجراء الذي يجب أن تتخذه خدمة Batch عندما تكون كافة المهام في الوظيفة في حالة مكتملة. الإعداد الافتراضي هو noaction.

القيم المحتملة: "noaction"، "terminatejob"

onAllTasksComplete?: string

قيمة الخاصية

string

onTaskFailure

الإجراء الذي يجب أن تتخذه خدمة Batch عند فشل أي مهمة في المهمة. تعتبر المهمة قد فشلت إذا كانت تحتوي على failureInfo. يتم تعيين failureInfo إذا اكتملت المهمة برمز خروج غير صفري بعد استنفاد عدد مرات إعادة المحاولة، أو إذا كان هناك خطأ في بدء المهمة، على سبيل المثال بسبب خطأ في تنزيل ملف مورد. الإعداد الافتراضي هو noaction.

القيم المحتملة: "noaction"، "performexitoptionsjobaction"

onTaskFailure?: string

قيمة الخاصية

string

poolInfo

إعدادات التجمع المقترنة بالوظيفة.

poolInfo: BatchPoolInfoOutput

قيمة الخاصية

BatchPoolInfoOutput

previousState

الحالة السابقة للوظيفة. لم يتم تعيين هذه الخاصية إذا كانت الوظيفة في حالتها النشطة الأولية.

القيم المحتملة: "نشط" و"تعطيل" و"معطل" و"تمكين" و"إنهاء" و"مكتمل" و"حذف"

previousState?: string

قيمة الخاصية

string

previousStateTransitionTime

الوقت الذي دخلت فيه الوظيفة في حالتها السابقة. لم يتم تعيين هذه الخاصية إذا كانت الوظيفة في حالتها النشطة الأولية.

previousStateTransitionTime?: string

قيمة الخاصية

string

priority

أولوية الوظيفة. يمكن أن تتراوح قيم الأولوية من -1000 إلى 1000، مع -1000 أقل أولوية و1000 أولوية قصوى. القيمة الافتراضية هي 0.

priority?: number

قيمة الخاصية

number

state

الحالة الحالية للوظيفة.

القيم المحتملة: "نشط" و"تعطيل" و"معطل" و"تمكين" و"إنهاء" و"مكتمل" و"حذف"

state: string

قيمة الخاصية

string

stateTransitionTime

الوقت الذي دخلت فيه الوظيفة حالتها الحالية.

stateTransitionTime: string

قيمة الخاصية

string

stats

إحصائيات استخدام الموارد طوال مدة بقاء المهمة. يتم ملء هذه الخاصية فقط إذا تم استرداد BatchJob مع عبارة توسيع بما في ذلك سمة "الإحصائيات"؛ وإلا فهي فارغة. وقد لا تكون الإحصاءات متاحة على الفور. تقوم خدمة Batch بإجراء مجموعة دورية من الإحصائيات. التأخير النموذجي حوالي 30 دقيقة.

stats?: BatchJobStatisticsOutput

قيمة الخاصية

BatchJobStatisticsOutput

url

عنوان URL للوظيفة.

url: string

قيمة الخاصية

string

usesTaskDependencies

ما إذا كان يمكن للمهام في الوظيفة تحديد التبعيات على بعضها البعض. الإعداد الافتراضي خطأ.

usesTaskDependencies?: boolean

قيمة الخاصية

boolean